ScriptDelegate Class Reference

#include <scriptdelegate.h>

Public Member Functions
	ScriptDelegate (const char *name, const char *description)
const ScriptDelegate *	GetNext () const
void	Register (const ScriptThreadLabel &label)
void	Unregister (const ScriptThreadLabel &label)
void	Register (ScriptRegisteredDelegate_Code::DelegateResponse response)
void	Unregister (ScriptRegisteredDelegate_Code::DelegateResponse response)
void	Register (Class *object, ScriptRegisteredDelegate_CodeMember::DelegateClassResponse response)
void	Unregister (Class *object, ScriptRegisteredDelegate_CodeMember::DelegateClassResponse response)
void	Trigger (const Event &ev=Event()) const
void	Trigger (Listener *object, const Event &ev=Event()) const
void	Reset ()
	ScriptDelegate (ScriptDelegate &&other)=delete
ScriptDelegate &	operator= (ScriptDelegate &&other)=delete
	ScriptDelegate (const ScriptDelegate &other)=delete
ScriptDelegate &	operator= (const ScriptDelegate &other)=delete

Static Public Member Functions
static const ScriptDelegate *	GetRoot ()
static ScriptDelegate *	GetScriptDelegate (const char *name)
static void	ResetAllDelegates ()

Detailed Description

A script delegate provides a way for code to subscribe for events. Scripts and code can register for a delegate and have their function executed when the delegate gets triggered.

Member Function Documentation

GetScriptDelegate()

ScriptDelegate * ScriptDelegate::GetScriptDelegate ( const char * name )

static

Search and return the specified script delegate by name.

Parameters

name	The name to search for

Register() [1/3]

void ScriptDelegate::Register	(	Class *	object,
		ScriptRegisteredDelegate_CodeMember::DelegateClassResponse	response )

Register with an object and a member function.

Parameters

object	The object to notify
response	The member function of the object to be executed

Register() [2/3]

void ScriptDelegate::Register

(

const ScriptThreadLabel &

label

)

Register a script label.

Parameters

label

The label to be executed

Register() [3/3]

void ScriptDelegate::Register

(

ScriptRegisteredDelegate_Code::DelegateResponse

response

)

Register a function.

Parameters

response

The function to be executed

Reset()

void ScriptDelegate::Reset

(

)

Reset the delegate, unregister callbacks.

Trigger() [1/2]

void ScriptDelegate::Trigger

(

const Event &

ev = Event()

)

const

Executes all registered delegates with the specified event.

Parameters

ev	Parameter list

Trigger() [2/2]

void ScriptDelegate::Trigger	(	Listener *	object,
		const Event &	ev = Event() ) const

Executes all registered delegates with the specified event.

Parameters

ev	Parameter list

Unregister() [1/3]

void ScriptDelegate::Unregister	(	Class *	object,
		ScriptRegisteredDelegate_CodeMember::DelegateClassResponse	response )

Unregistered the member function.

Parameters

object	The object where the member function is
response	The member function to unregister

Unregister() [2/3]

void ScriptDelegate::Unregister

(

const ScriptThreadLabel &

label

)

Unregistered the label.

Parameters

label

The label to unregister

Unregister() [3/3]

void ScriptDelegate::Unregister

(

ScriptRegisteredDelegate_Code::DelegateResponse

response

)

Unregistered the function.

Parameters

response

the function to unregister

---

The documentation for this class was generated from the following files:

• code/fgame/scriptdelegate.h
• code/fgame/scriptdelegate.cpp