|
Torque2D Reference
|
|
Torque2D Reference
|
Base class for messages. More...
#include <message.h>
Inheritance diagram for Message:Public Member Functions | |
| Message () | |
| DECLARE_CONOBJECT (Message) | |
| const char * | getType () |
| Get the type of the message. More... | |
| void | addReference () |
| Add a reference to the reference count of this message. More... | |
| void | freeReference () |
| Free a reference to this message. More... | |
| Public Member Functions inherited from SimObject | |
| StringTableEntry | getClassNamespace () const |
| StringTableEntry | getSuperClassNamespace () const |
| void | setClassNamespace (const char *classNamespace) |
| void | setSuperClassNamespace (const char *superClassNamespace) |
| void | pushScriptCallbackGuard (void) |
| void | popScriptCallbackGuard (void) |
| S32 | getScriptCallbackGuard (void) |
| virtual SimObject * | findObject (const char *name) |
| Namespace * | getNamespace () |
| Return the object's namespace. More... | |
| const char * | tabComplete (const char *prevText, S32 baseLen, bool) |
| virtual void | dump () |
| virtual void | dumpClassHierarchy () |
| SimObject * | clone (const bool copyDynamicFields) |
| virtual void | copyTo (SimObject *object) |
| template<typename T > | |
| bool | isType (void) |
| virtual bool | handlesConsoleMethod (const char *fname, S32 *routingId) |
| DECLARE_CONOBJECT (SimObject) | |
| Notify * | removeNotify (void *ptr, Notify::Type) |
| Remove a notification from the list. More... | |
| void | deleteNotify (SimObject *obj) |
| Notify an object when we are deleted. More... | |
| void | clearNotify (SimObject *obj) |
| Notify an object when we are cleared. More... | |
| void | clearAllNotifications () |
| Remove all notifications for this object. More... | |
| void | processDeleteNotifies () |
| Send out deletion notifications. More... | |
| void | registerReference (SimObject **obj) |
| void | unregisterReference (SimObject **obj) |
| const char * | getDataField (StringTableEntry slotName, const char *array) |
| void | setDataField (StringTableEntry slotName, const char *array, const char *value) |
| const char * | getPrefixedDataField (StringTableEntry fieldName, const char *array) |
| void | setPrefixedDataField (StringTableEntry fieldName, const char *array, const char *value) |
| const char * | getPrefixedDynamicDataField (StringTableEntry fieldName, const char *array, const S32 fieldType=-1) |
| void | setPrefixedDynamicDataField (StringTableEntry fieldName, const char *array, const char *value, const S32 fieldType=-1) |
| StringTableEntry | getDataFieldPrefix (StringTableEntry fieldName) |
| U32 | getDataFieldType (StringTableEntry slotName, const char *array) |
| SimFieldDictionary * | getFieldDictionary () |
| void | clearDynamicFields (void) |
| Clear all dynamic fields. More... | |
| void | setCanSaveDynamicFields (bool bCanSave) |
| Set whether fields created at runtime should be saved. Default is true. More... | |
| bool | getCanSaveDynamicFields (void) const |
| Get whether fields created at runtime should be saved. Default is true. More... | |
| void | setInternalName (const char *newname) |
| StringTableEntry | getInternalName () |
| Get the internal of of this control. More... | |
| virtual bool | save (const char *pcFilePath, bool bOnlySelected=false) |
| Save object as a TorqueScript File. More... | |
| virtual bool | isMethod (const char *methodName) |
| Check if a method exists in the objects current namespace. More... | |
| SimObjectId | getId (void) const |
| StringTableEntry | getIdString (void) const |
| U32 | getType () const |
| const StringTableEntry | getName (void) const |
| void | setId (SimObjectId id) |
| void | assignName (const char *name) |
| SimGroup * | getGroup () const |
| bool | isChildOfGroup (SimGroup *pGroup) |
| bool | isProperlyAdded () const |
| bool | isDeleted () const |
| bool | isRemoved () const |
| bool | isLocked () |
| void | setLocked (bool b) |
| bool | isHidden () |
| void | setHidden (bool b) |
| void | setProgenitorFile (const char *pFile) |
| StringTableEntry | getProgenitorFile (void) const |
| void | setPeriodicTimerID (const S32 timerID) |
| S32 | getPeriodicTimerID (void) const |
| bool | isPeriodicTimerActive (void) const |
| bool | isSelected () const |
| bool | isExpanded () const |
| void | setSelected (bool sel) |
| void | setExpanded (bool exp) |
| void | setModDynamicFields (bool dyn) |
| void | setModStaticFields (bool sta) |
| SimObject (const U8 namespaceLinkMask=LinkSuperClassName|LinkClassName) | |
| virtual | ~SimObject () |
| virtual bool | processArguments (S32 argc, const char **argv) |
| Process constructor options. (ie, new SimObject(1,2,3)) More... | |
| virtual bool | onAdd () |
| Called when the object is added to the sim. More... | |
| virtual void | onRemove () |
| Called when the object is removed from the sim. More... | |
| virtual void | onGroupAdd () |
| Called when the object is added to a SimGroup. More... | |
| virtual void | onGroupRemove () |
| Called when the object is removed from a SimGroup. More... | |
| virtual void | onNameChange (const char *name) |
| Called when the object's name is changed. More... | |
| virtual void | onStaticModified (const char *slotName, const char *newValue=NULL) |
| virtual void | inspectPreApply () |
| virtual void | inspectPostApply () |
| virtual void | onDeleteNotify (SimObject *object) |
| virtual void | onEditorEnable () |
| Called when the editor is activated. More... | |
| virtual void | onEditorDisable () |
| Called when the editor is deactivated. More... | |
| bool | registerObject () |
| bool | registerObject (U32 id) |
| bool | registerObject (const char *name) |
| bool | registerObject (const char *name, U32 id) |
| void | unregisterObject () |
| void | deleteObject () |
| bool | addToSet (SimObjectId) |
| bool | addToSet (const char *) |
| bool | removeFromSet (SimObjectId) |
| bool | removeFromSet (const char *) |
| virtual bool | writeField (StringTableEntry fieldname, const char *value) |
| virtual void | write (Stream &stream, U32 tabStop, U32 flags=0) |
| virtual void | writeFields (Stream &stream, U32 tabStop) |
| virtual bool | writeObject (Stream *stream) |
| virtual bool | readObject (Stream *stream) |
| virtual void | buildFilterList () |
| void | addFieldFilter (const char *fieldName) |
| void | removeFieldFilter (const char *fieldName) |
| void | clearFieldFilters () |
| bool | isFiltered (const char *fieldName) |
| void | assignFieldsFrom (SimObject *obj) |
| void | assignDynamicFieldsFrom (SimObject *obj) |
| Public Member Functions inherited from ConsoleObject | |
| const AbstractClassRep::Field * | findField (StringTableEntry fieldName) const |
| Get a reference to a field by name. More... | |
| virtual AbstractClassRep * | getClassRep () const |
| Gets the ClassRep. More... | |
| bool | setField (const char *fieldName, const char *value) |
| Set the value of a field. More... | |
| virtual | ~ConsoleObject () |
| const AbstractClassRep::FieldList & | getFieldList () const |
| Get a list of all the fields. This information cannot be modified. More... | |
| AbstractClassRep::FieldList & | getModifiableFieldList () |
| bool & | getDynamicGroupExpand () |
| S32 | getClassId (U32 netClassGroup) const |
| const char * | getClassName () const |
Static Public Member Functions | |
| static SimObjectId | getNextMessageID () |
| Obtain next available #SimObjectId for messages. More... | |
| Static Public Member Functions inherited from SimObject | |
| static void | initPersistFields () |
| Static Public Member Functions inherited from ConsoleObject | |
| static const char * | lookupClassName (const U32 in_classTag) |
| Get the classname from a class tag. More... | |
| static void | initPersistFields () |
| static void | consoleInit () |
| static ConsoleObject * | create (const char *in_pClassName) |
| static ConsoleObject * | create (const U32 groupId, const U32 typeId, const U32 in_classId) |
| static AbstractClassRep * | getStaticClassRep () |
| Get the abstract class information for this class. More... | |
| static AbstractClassRep * | getParentStaticClassRep () |
| Get the abstract class information for this class's superclass. More... | |
Additional Inherited Members | |
| Public Types inherited from SimObject | |
| enum | WriteFlags { SelectedOnly = BIT(0) } |
| Protected Types inherited from SimObject | |
| enum | SimObjectNSLinkType { LinkClassName = BIT(0), LinkSuperClassName = BIT(1) } |
| Protected Member Functions inherited from SimObject | |
| virtual void | onTamlPreWrite (void) |
| Taml callbacks. More... | |
| virtual void | onTamlPostWrite (void) |
| Called after Taml has finished writing the object. More... | |
| virtual void | onTamlPreRead (void) |
| Called prior to Taml reading the object. More... | |
| virtual void | onTamlPostRead (const TamlCustomNodes &customNodes) |
| virtual void | onTamlAddParent (SimObject *pParentObject) |
| Called after Taml has finished reading the object and has added the object to any parent. More... | |
| virtual void | onTamlCustomWrite (TamlCustomNodes &customNodes) |
| Called during the writing of the object to allow custom properties to be written. More... | |
| virtual void | onTamlCustomRead (const TamlCustomNodes &customNodes) |
| Called during the reading of the object to allow custom properties to be read. More... | |
| void | linkNamespaces () |
| void | unlinkNamespaces () |
| Static Protected Member Functions inherited from SimObject | |
| static bool | setClass (void *obj, const char *data) |
| static bool | setSuperClass (void *obj, const char *data) |
| static bool | writeCanSaveDynamicFields (void *obj, StringTableEntry pFieldName) |
| static bool | writeInternalName (void *obj, StringTableEntry pFieldName) |
| static bool | setParentGroup (void *obj, const char *data) |
| static bool | writeParentGroup (void *obj, StringTableEntry pFieldName) |
| static bool | writeSuperclass (void *obj, StringTableEntry pFieldName) |
| static bool | writeClass (void *obj, StringTableEntry pFieldName) |
| static SimObject::Notify * | allocNotify () |
| Get a free Notify structure. More... | |
| static void | freeNotify (SimObject::Notify *) |
| Mark a Notify structure as free. More... | |
| Protected Attributes inherited from SimObject | |
| SimObjectId | mId |
| Id number for this object. More... | |
| StringTableEntry | mIdString |
| Namespace * | mNameSpace |
| U32 | mTypeMask |
| S32 | mScriptCallbackGuard |
| Whether the object is executing a script callback. More... | |
| bool | mCanSaveFieldDictionary |
| true if dynamic fields (added at runtime) should be saved, defaults to true More... | |
| StringTableEntry | mInternalName |
| Stores object Internal Name. More... | |
| StringTableEntry | mClassName |
| Stores the class name to link script class namespaces. More... | |
| StringTableEntry | mSuperClassName |
| Stores super class name to link script class namespaces. More... | |
| U8 | mNSLinkMask |
| Static Protected Attributes inherited from SimObject | |
| static SimObject::Notify * | mNotifyFreeList = NULL |
Base class for messages.
Message is the base class for C++ defined messages, and may also be used in script for script defined messages if no C++ subclass is appropriate.
Messages are reference counted and will be automatically deleted when their reference count reaches zero. When you dispatch a message, a reference will be added before the dispatch and freed after the dispatch. This allows for temporary messages with no additional code. If you want to keep the message around, for example to dispatch it to multiple queues, call addReference() before dispatching it and freeReference() when you are done with it. Never delete a Message object directly unless addReference() has not been called or the message has not been dispatched.
Message IDs are pooled similarly to datablocks, with the exception that IDs are reused. If you keep a message for longer than a single dispatch, then you should ensure that you clear any script variables that refer to it after the last freeReference(). If you don't, then it is probable that the object ID will become valid again in the future and could cause hard to track down bugs.
Messages have a unique type to simplify message handling code. For object messages, the type is defined as either the script defined class name or the C++ class name if no script class was defined. The message type may be obtained through the getType() method.
By convention, any data for the message is held in script accessible fields. Messages that need to be handled in C++ as well as script provide the relevant data through persistent fields in a subclass of Message to provide best performance on the C++ side. Script defined messages usually their through dynamic fields, and may be accessed in C++ using the SimObject::getDataField() method.
| Message | ( | ) |
| void addReference | ( | ) |
Add a reference to the reference count of this message.
Use freeReference() to free the reference when you are done with it.
| DECLARE_CONOBJECT | ( | Message | ) |
| void freeReference | ( | ) |
Free a reference to this message.
|
static |
Obtain next available #SimObjectId for messages.
This is used in combination with the newmsg script operator to provide ID pooling for messages and works similarly to datablock IDs.
By default, the 64 IDs following the datablock IDs are used for messages. As message objects generally have a short life time this prevents them from eating object IDs as if they haven't eaten for a year.
Note that unlike SimObjects and datablocks, Messages IDs are re-used. If you store a message object in script and do not clear the variable containing the object ID after freeing the message, it is probable that the object ID will become valid again.
| const char * getType | ( | ) |
Get the type of the message.
The message type is either the script class name or the C++ class name if it has not been overridden in script. This allows easy identification of message types with minimum effort.
1.8.3.1
