Main   GitHub

Methods | Fields | List of all members
EventManager Class Reference

Inherits SimObject, and SimObject.

Methods

void dumpEvents ()
 
void dumpEvents ()
 
void dumpSubscribers (String event)
 
void dumpSubscribers (String event)
 
bool isRegisteredEvent (String event)
 
bool isRegisteredEvent (String event)
 
bool postEvent (String event, String data)
 
bool postEvent (String event, String data)
 
bool registerEvent (String event)
 
bool registerEvent (String event)
 
void remove (SimObject listener, String event)
 
void remove (SimObject listener, String event)
 
bool subscribe (SimObject listener, String event, String callback)
 
bool subscribe (SimObject listener, String event, String callback)
 
void unregisterEvent (String event)
 
void unregisterEvent (String event)
 
- Methods inherited from SimObject
void addFieldFilter (fieldName)
 
void addFieldFilter (fieldName)
 
string call (%args)
 
string call (%args)
 
int clone ([bool copyDynamicFields?=false])
 
int clone ([bool copyDynamicFields?=false])
 
void delete ()
 
void delete ()
 
void dump ()
 
void dump ()
 
void dumpClassHierarchy ()
 
void dumpClassHierarchy ()
 
string getClassName ()
 
string getClassName ()
 
string getClassNamespace ()
 
string getClassNamespace ()
 
string getDynamicField (index)
 
string getDynamicField (index)
 
int getDynamicFieldCount ()
 
int getDynamicFieldCount ()
 
string getField (int index)
 
string getField (int index)
 
int getFieldCount ()
 
int getFieldCount ()
 
string getFieldType (fieldName)
 
string getFieldType (fieldName)
 
string getFieldValue (fieldName)
 
string getFieldValue (fieldName)
 
int getGroup ()
 
int getGroup ()
 
int getId ()
 
int getId ()
 
string getInternalName ()
 
string getInternalName ()
 
string getName ()
 
string getName ()
 
string getProgenitorFile ()
 
string getProgenitorFile ()
 
string getSuperClassNamespace ()
 
string getSuperClassNamespace ()
 
int getType ()
 
int getType ()
 
bool isChildOfGroup ()
 
bool isChildOfGroup ()
 
bool isMemberOfClass (string classname)
 
bool isMemberOfClass (string classname)
 
bool isMethod (string method name)
 
bool isMethod (string method name)
 
bool isTimerActive ()
 
bool isTimerActive ()
 
void removeFieldFilter (fieldName)
 
void removeFieldFilter (fieldName)
 
bool save (fileName,[selectedOnly])
 
bool save (fileName,[selectedOnly])
 
int schedule (time, command,< arg1...argN >)
 
int schedule (time, command,< arg1...argN >)
 
void setClassNamespace ()
 
void setClassNamespace ()
 
bool setFieldValue (fieldName, value)
 
bool setFieldValue (fieldName, value)
 
void setInternalName ()
 
void setInternalName ()
 
void setName (newName)
 
void setName (newName)
 
void setProgenitorFile (file)
 
void setProgenitorFile (file)
 
void setSuperClassNamespace ()
 
void setSuperClassNamespace ()
 
bool startTimer (callbackFunction, float timePeriod,[repeat])
 
bool startTimer (callbackFunction, float timePeriod,[repeat])
 
void stopTimer ()
 
void stopTimer ()
 

Fields

string queue
 
- Fields inherited from SimObject
bool canSaveDynamicFields
 
string internalName
 
SimObjectPtr parentGroup
 
string superclass
 
string class
 

Methods

void EventManager::dumpEvents ( )

Print all registered events to the console.

void EventManager::dumpEvents ( )

Print all registered events to the console.

void EventManager::dumpSubscribers ( String  event)

Print all subscribers to an event to the console.

Parameters
eventThe event whose subscribers are to be printed. If this parameter isn't specified, all events will be dumped.
void EventManager::dumpSubscribers ( String  event)

Print all subscribers to an event to the console.

Parameters
eventThe event whose subscribers are to be printed. If this parameter isn't specified, all events will be dumped.
bool EventManager::isRegisteredEvent ( String  event)

Check if an event is registered or not.

Parameters
eventThe event to check.
Returns
Whether or not the event exists.
bool EventManager::isRegisteredEvent ( String  event)

Check if an event is registered or not.

Parameters
eventThe event to check.
Returns
Whether or not the event exists.
bool EventManager::postEvent ( String  event,
String  data 
)

Trigger an event.

Parameters
eventThe event to trigger.
dataThe data associated with the event.
Returns
Whether or not the event was dispatched successfully.
bool EventManager::postEvent ( String  event,
String  data 
)

Trigger an event.

Parameters
eventThe event to trigger.
dataThe data associated with the event.
Returns
Whether or not the event was dispatched successfully.
bool EventManager::registerEvent ( String  event)

Register an event with the event manager.

Parameters
eventThe event to register.
Returns
Whether or not the event was registered successfully.
bool EventManager::registerEvent ( String  event)

Register an event with the event manager.

Parameters
eventThe event to register.
Returns
Whether or not the event was registered successfully.
void EventManager::remove ( SimObject  listener,
String  event 
)

Remove a listener from an event.

Parameters
listenerThe listener to remove.
eventThe event to be removed from.
void EventManager::remove ( SimObject  listener,
String  event 
)

Remove a listener from an event.

Parameters
listenerThe listener to remove.
eventThe event to be removed from.
bool EventManager::subscribe ( SimObject  listener,
String  event,
String  callback 
)

Subscribe a listener to an event.

Parameters
listenerThe listener to subscribe.
eventThe event to subscribe to.
callbackOptional method name to receive the event notification. If this is not specified, "on[event]" will be used.
Returns
Whether or not the subscription was successful.
bool EventManager::subscribe ( SimObject  listener,
String  event,
String  callback 
)

Subscribe a listener to an event.

Parameters
listenerThe listener to subscribe.
eventThe event to subscribe to.
callbackOptional method name to receive the event notification. If this is not specified, "on[event]" will be used.
Returns
Whether or not the subscription was successful.
void EventManager::unregisterEvent ( String  event)

Remove an event from the EventManager.

Parameters
eventThe event to remove.
void EventManager::unregisterEvent ( String  event)

Remove an event from the EventManager.

Parameters
eventThe event to remove.

Member Data Documentation

string EventManager::queue


Copyright © 2013 GarageGames, LLC. All Rights Reserved.