|
|
@@ -38,40 +38,56 @@
|
|
|
#ifndef _CONSOLE_H_
|
|
|
#include "console/console.h"
|
|
|
#endif
|
|
|
+#ifndef TINYXML_INCLUDED
|
|
|
+#include "persistence/tinyXML/tinyxml.h"
|
|
|
+#endif
|
|
|
+
|
|
|
+//-----------------------------------------------------------------------------
|
|
|
|
|
|
class Namespace;
|
|
|
class ConsoleObject;
|
|
|
|
|
|
+//-----------------------------------------------------------------------------
|
|
|
+
|
|
|
enum NetClassTypes {
|
|
|
- NetClassTypeObject = 0,
|
|
|
- NetClassTypeDataBlock,
|
|
|
- NetClassTypeEvent,
|
|
|
- NetClassTypesCount,
|
|
|
+ NetClassTypeObject = 0,
|
|
|
+ NetClassTypeDataBlock,
|
|
|
+ NetClassTypeEvent,
|
|
|
+ NetClassTypesCount,
|
|
|
};
|
|
|
|
|
|
+//-----------------------------------------------------------------------------
|
|
|
+
|
|
|
enum NetClassGroups {
|
|
|
- NetClassGroupGame = 0,
|
|
|
- NetClassGroupCommunity,
|
|
|
- NetClassGroup3,
|
|
|
- NetClassGroup4,
|
|
|
- NetClassGroupsCount,
|
|
|
+ NetClassGroupGame = 0,
|
|
|
+ NetClassGroupCommunity,
|
|
|
+ NetClassGroup3,
|
|
|
+ NetClassGroup4,
|
|
|
+ NetClassGroupsCount,
|
|
|
};
|
|
|
|
|
|
+//-----------------------------------------------------------------------------
|
|
|
+
|
|
|
enum NetClassMasks {
|
|
|
- NetClassGroupGameMask = BIT(NetClassGroupGame),
|
|
|
- NetClassGroupCommunityMask = BIT(NetClassGroupCommunity),
|
|
|
+ NetClassGroupGameMask = BIT(NetClassGroupGame),
|
|
|
+ NetClassGroupCommunityMask = BIT(NetClassGroupCommunity),
|
|
|
};
|
|
|
|
|
|
+//-----------------------------------------------------------------------------
|
|
|
+
|
|
|
enum NetDirection
|
|
|
{
|
|
|
- NetEventDirAny,
|
|
|
- NetEventDirServerToClient,
|
|
|
- NetEventDirClientToServer,
|
|
|
+ NetEventDirAny,
|
|
|
+ NetEventDirServerToClient,
|
|
|
+ NetEventDirClientToServer,
|
|
|
};
|
|
|
|
|
|
+//-----------------------------------------------------------------------------
|
|
|
+
|
|
|
class SimObject;
|
|
|
class ConsoleTypeValidator;
|
|
|
|
|
|
+//-----------------------------------------------------------------------------
|
|
|
/// Core functionality for class manipulation.
|
|
|
///
|
|
|
/// @section AbstractClassRep_intro Introduction (or, Why AbstractClassRep?)
|
|
|
@@ -164,212 +180,200 @@ class ConsoleTypeValidator;
|
|
|
/// bit allocations for network ID fields.
|
|
|
///
|
|
|
/// @nosubgrouping
|
|
|
+//-----------------------------------------------------------------------------
|
|
|
+
|
|
|
class AbstractClassRep
|
|
|
{
|
|
|
- friend class ConsoleObject;
|
|
|
+ friend class ConsoleObject;
|
|
|
|
|
|
public:
|
|
|
+ /// This is a function pointer typedef to support get/set callbacks for fields
|
|
|
+ typedef bool (*SetDataNotify)( void *obj, const char *data );
|
|
|
+ typedef const char *(*GetDataNotify)( void *obj, const char *data );
|
|
|
|
|
|
- /// @name 'Tructors
|
|
|
- /// @{
|
|
|
-
|
|
|
- AbstractClassRep()
|
|
|
- {
|
|
|
- VECTOR_SET_ASSOCIATION(mFieldList);
|
|
|
- parentClass = NULL;
|
|
|
- }
|
|
|
- virtual ~AbstractClassRep() { }
|
|
|
-
|
|
|
- /// @}
|
|
|
-
|
|
|
- /// @name Representation Interface
|
|
|
- /// @{
|
|
|
-
|
|
|
- S32 mClassGroupMask; ///< Mask indicating in which NetGroups this object belongs.
|
|
|
- S32 mClassType; ///< Stores the NetClass of this class.
|
|
|
- S32 mNetEventDir; ///< Stores the NetDirection of this class.
|
|
|
- S32 mClassId[NetClassGroupsCount]; ///< Stores the IDs assigned to this class for each group.
|
|
|
-
|
|
|
- S32 getClassId (U32 netClassGroup) const;
|
|
|
- static U32 getClassCRC (U32 netClassGroup);
|
|
|
- const char* getClassName() const;
|
|
|
- static AbstractClassRep* getClassList();
|
|
|
- Namespace* getNameSpace();
|
|
|
- AbstractClassRep* getNextClass();
|
|
|
- AbstractClassRep* getParentClass();
|
|
|
- virtual AbstractClassRep* getContainerChildClass( const bool recurse ) = 0;
|
|
|
-
|
|
|
- /// Helper class to see if we are a given class, or a subclass thereof.
|
|
|
- bool isClass(AbstractClassRep *acr)
|
|
|
- {
|
|
|
- AbstractClassRep *walk = this;
|
|
|
+ /// This is a function pointer typedef to support optional writing for fields.
|
|
|
+ typedef bool (*WriteDataNotify)( void* obj, const char* pFieldName );
|
|
|
|
|
|
- // Walk up parents, checking for equivalence.
|
|
|
- while(walk)
|
|
|
- {
|
|
|
- if(walk == acr)
|
|
|
- return true;
|
|
|
-
|
|
|
- walk = walk->parentClass;
|
|
|
- };
|
|
|
-
|
|
|
- return false;
|
|
|
- }
|
|
|
-
|
|
|
- virtual ConsoleObject* create () const = 0;
|
|
|
+ /// Allows the writing of a custom TAML schema.
|
|
|
+ typedef void (*WriteCustomTamlSchema)( const AbstractClassRep* pClassRep, TiXmlElement* pParentElement );
|
|
|
|
|
|
protected:
|
|
|
- virtual void init() const = 0;
|
|
|
-
|
|
|
- const char * mClassName;
|
|
|
- AbstractClassRep * nextClass;
|
|
|
- AbstractClassRep * parentClass;
|
|
|
- Namespace * mNamespace;
|
|
|
+ const char * mClassName;
|
|
|
+ AbstractClassRep * nextClass;
|
|
|
+ AbstractClassRep * parentClass;
|
|
|
+ Namespace * mNamespace;
|
|
|
|
|
|
- /// @}
|
|
|
+ static AbstractClassRep ** classTable[NetClassGroupsCount][NetClassTypesCount];
|
|
|
+ static AbstractClassRep * classLinkList;
|
|
|
+ static U32 classCRC[NetClassGroupsCount];
|
|
|
+ static bool initialized;
|
|
|
|
|
|
+ static ConsoleObject* create(const char* in_pClassName);
|
|
|
+ static ConsoleObject* create(const U32 groupId, const U32 typeId, const U32 in_classId);
|
|
|
|
|
|
- /// @name Fields
|
|
|
- /// @{
|
|
|
public:
|
|
|
+ enum ACRFieldTypes
|
|
|
+ {
|
|
|
+ StartGroupFieldType = 0xFFFFFFFD,
|
|
|
+ EndGroupFieldType = 0xFFFFFFFE,
|
|
|
+ DepricatedFieldType = 0xFFFFFFFF
|
|
|
+ };
|
|
|
+
|
|
|
+ struct Field {
|
|
|
+ const char* pFieldname; ///< Name of the field.
|
|
|
+ const char* pGroupname; ///< Optionally filled field containing the group name.
|
|
|
+ ///
|
|
|
+ /// This is filled when type is StartField or EndField
|
|
|
+
|
|
|
+ const char* pFieldDocs; ///< Documentation about this field; see consoleDoc.cc.
|
|
|
+ bool groupExpand; ///< Flag to track expanded/not state of this group in the editor.
|
|
|
+ U32 type; ///< A type ID. @see ACRFieldTypes
|
|
|
+ U32 offset; ///< Memory offset from beginning of class for this field.
|
|
|
+ S32 elementCount; ///< Number of elements, if this is an array.
|
|
|
+ EnumTable * table; ///< If this is an enum, this points to the table defining it.
|
|
|
+ BitSet32 flag; ///< Stores various flags
|
|
|
+ ConsoleTypeValidator *validator; ///< Validator, if any.
|
|
|
+ SetDataNotify setDataFn; ///< Set data notify Fn
|
|
|
+ GetDataNotify getDataFn; ///< Get data notify Fn
|
|
|
+ WriteDataNotify writeDataFn; ///< Function to determine whether data should be written or not.
|
|
|
+ };
|
|
|
+ typedef Vector<Field> FieldList;
|
|
|
+
|
|
|
+ FieldList mFieldList;
|
|
|
+
|
|
|
+ bool mDynamicGroupExpand;
|
|
|
+
|
|
|
+ static U32 NetClassCount [NetClassGroupsCount][NetClassTypesCount];
|
|
|
+ static U32 NetClassBitSize[NetClassGroupsCount][NetClassTypesCount];
|
|
|
+
|
|
|
+ static void registerClassRep(AbstractClassRep*);
|
|
|
+ static AbstractClassRep* findClassRep(const char* in_pClassName);
|
|
|
+ static void initialize(); // Called from Con::init once on startup
|
|
|
+ static void destroyFieldValidators(AbstractClassRep::FieldList &mFieldList);
|
|
|
|
|
|
- /// This is a function pointer typedef to support get/set callbacks for fields
|
|
|
- typedef bool (*SetDataNotify)( void *obj, const char *data );
|
|
|
- typedef const char *(*GetDataNotify)( void *obj, const char *data );
|
|
|
-
|
|
|
- /// This is a function pointer typedef to support optional writing for fields.
|
|
|
- typedef bool (*WriteDataNotify)( void* obj, const char* pFieldName );
|
|
|
-
|
|
|
- enum ACRFieldTypes
|
|
|
- {
|
|
|
- StartGroupFieldType = 0xFFFFFFFD,
|
|
|
- EndGroupFieldType = 0xFFFFFFFE,
|
|
|
- DepricatedFieldType = 0xFFFFFFFF
|
|
|
- };
|
|
|
-
|
|
|
- struct Field {
|
|
|
- const char* pFieldname; ///< Name of the field.
|
|
|
- const char* pGroupname; ///< Optionally filled field containing the group name.
|
|
|
- ///
|
|
|
- /// This is filled when type is StartField or EndField
|
|
|
-
|
|
|
- const char* pFieldDocs; ///< Documentation about this field; see consoleDoc.cc.
|
|
|
- bool groupExpand; ///< Flag to track expanded/not state of this group in the editor.
|
|
|
- U32 type; ///< A type ID. @see ACRFieldTypes
|
|
|
- U32 offset; ///< Memory offset from beginning of class for this field.
|
|
|
- S32 elementCount; ///< Number of elements, if this is an array.
|
|
|
- EnumTable * table; ///< If this is an enum, this points to the table defining it.
|
|
|
- BitSet32 flag; ///< Stores various flags
|
|
|
- ConsoleTypeValidator *validator; ///< Validator, if any.
|
|
|
- SetDataNotify setDataFn; ///< Set data notify Fn
|
|
|
- GetDataNotify getDataFn; ///< Get data notify Fn
|
|
|
- WriteDataNotify writeDataFn; ///< Function to determine whether data should be written or not.
|
|
|
- };
|
|
|
- typedef Vector<Field> FieldList;
|
|
|
-
|
|
|
- FieldList mFieldList;
|
|
|
-
|
|
|
- bool mDynamicGroupExpand;
|
|
|
-
|
|
|
- const Field *findField(StringTableEntry fieldName) const;
|
|
|
-
|
|
|
- AbstractClassRep* findFieldRoot( StringTableEntry fieldName );
|
|
|
-
|
|
|
- AbstractClassRep* findContainerChildRoot( AbstractClassRep* pChild );
|
|
|
-
|
|
|
- /// @}
|
|
|
+public:
|
|
|
+ AbstractClassRep()
|
|
|
+ {
|
|
|
+ VECTOR_SET_ASSOCIATION(mFieldList);
|
|
|
+ parentClass = NULL;
|
|
|
+ }
|
|
|
+ virtual ~AbstractClassRep() { }
|
|
|
+
|
|
|
+ S32 mClassGroupMask; ///< Mask indicating in which NetGroups this object belongs.
|
|
|
+ S32 mClassType; ///< Stores the NetClass of this class.
|
|
|
+ S32 mNetEventDir; ///< Stores the NetDirection of this class.
|
|
|
+ S32 mClassId[NetClassGroupsCount]; ///< Stores the IDs assigned to this class for each group.
|
|
|
+
|
|
|
+ S32 getClassId (U32 netClassGroup) const;
|
|
|
+ static U32 getClassCRC (U32 netClassGroup);
|
|
|
+ const char* getClassName() const;
|
|
|
+ static AbstractClassRep* getClassList();
|
|
|
+ Namespace* getNameSpace();
|
|
|
+ AbstractClassRep* getNextClass();
|
|
|
+ AbstractClassRep* getParentClass();
|
|
|
+ virtual AbstractClassRep* getContainerChildClass( const bool recurse ) = 0;
|
|
|
+ virtual WriteCustomTamlSchema getCustomTamlSchema( void ) = 0;
|
|
|
+
|
|
|
+ /// Helper class to see if we are a given class, or a subclass thereof.
|
|
|
+ bool isClass(AbstractClassRep *acr)
|
|
|
+ {
|
|
|
+ AbstractClassRep *walk = this;
|
|
|
|
|
|
- /// @name Abstract Class Database
|
|
|
- /// @{
|
|
|
+ // Walk up parents, checking for equivalence.
|
|
|
+ while(walk)
|
|
|
+ {
|
|
|
+ if(walk == acr)
|
|
|
+ return true;
|
|
|
|
|
|
-protected:
|
|
|
- static AbstractClassRep ** classTable[NetClassGroupsCount][NetClassTypesCount];
|
|
|
- static AbstractClassRep * classLinkList;
|
|
|
- static U32 classCRC[NetClassGroupsCount];
|
|
|
- static bool initialized;
|
|
|
+ walk = walk->parentClass;
|
|
|
+ };
|
|
|
|
|
|
- static ConsoleObject* create(const char* in_pClassName);
|
|
|
- static ConsoleObject* create(const U32 groupId, const U32 typeId, const U32 in_classId);
|
|
|
+ return false;
|
|
|
+ }
|
|
|
|
|
|
public:
|
|
|
- static U32 NetClassCount [NetClassGroupsCount][NetClassTypesCount];
|
|
|
- static U32 NetClassBitSize[NetClassGroupsCount][NetClassTypesCount];
|
|
|
-
|
|
|
- static void registerClassRep(AbstractClassRep*);
|
|
|
- static AbstractClassRep* findClassRep(const char* in_pClassName);
|
|
|
- static void initialize(); // Called from Con::init once on startup
|
|
|
- static void destroyFieldValidators(AbstractClassRep::FieldList &mFieldList);
|
|
|
+ virtual ConsoleObject* create() const = 0;
|
|
|
+ const Field *findField(StringTableEntry fieldName) const;
|
|
|
+ AbstractClassRep* findFieldRoot( StringTableEntry fieldName );
|
|
|
+ AbstractClassRep* findContainerChildRoot( AbstractClassRep* pChild );
|
|
|
|
|
|
-
|
|
|
- /// @}
|
|
|
+protected:
|
|
|
+ virtual void init() const = 0;
|
|
|
};
|
|
|
|
|
|
+//-----------------------------------------------------------------------------
|
|
|
+
|
|
|
inline AbstractClassRep *AbstractClassRep::getClassList()
|
|
|
{
|
|
|
- return classLinkList;
|
|
|
+ return classLinkList;
|
|
|
}
|
|
|
|
|
|
+//-----------------------------------------------------------------------------
|
|
|
+
|
|
|
inline U32 AbstractClassRep::getClassCRC(U32 group)
|
|
|
{
|
|
|
- return classCRC[group];
|
|
|
+ return classCRC[group];
|
|
|
}
|
|
|
|
|
|
+//-----------------------------------------------------------------------------
|
|
|
+
|
|
|
inline AbstractClassRep *AbstractClassRep::getNextClass()
|
|
|
{
|
|
|
- return nextClass;
|
|
|
+ return nextClass;
|
|
|
}
|
|
|
|
|
|
+//-----------------------------------------------------------------------------
|
|
|
+
|
|
|
inline AbstractClassRep *AbstractClassRep::getParentClass()
|
|
|
{
|
|
|
- return parentClass;
|
|
|
+ return parentClass;
|
|
|
}
|
|
|
|
|
|
+
|
|
|
+//-----------------------------------------------------------------------------
|
|
|
inline S32 AbstractClassRep::getClassId(U32 group) const
|
|
|
{
|
|
|
- return mClassId[group];
|
|
|
+ return mClassId[group];
|
|
|
}
|
|
|
|
|
|
+//-----------------------------------------------------------------------------
|
|
|
+
|
|
|
inline const char* AbstractClassRep::getClassName() const
|
|
|
{
|
|
|
- return mClassName;
|
|
|
+ return mClassName;
|
|
|
}
|
|
|
|
|
|
+//-----------------------------------------------------------------------------
|
|
|
+
|
|
|
inline Namespace *AbstractClassRep::getNameSpace()
|
|
|
{
|
|
|
- return mNamespace;
|
|
|
+ return mNamespace;
|
|
|
}
|
|
|
|
|
|
-//------------------------------------------------------------------------------
|
|
|
-//-------------------------------------- ConcreteClassRep
|
|
|
-//
|
|
|
-
|
|
|
+//-----------------------------------------------------------------------------
|
|
|
|
|
|
-/// Helper class for AbstractClassRep.
|
|
|
-///
|
|
|
-/// @see AbtractClassRep
|
|
|
-/// @see ConsoleObject
|
|
|
template <class T>
|
|
|
class ConcreteClassRep : public AbstractClassRep
|
|
|
{
|
|
|
public:
|
|
|
- ConcreteClassRep(const char *name, S32 netClassGroupMask, S32 netClassType, S32 netEventDir, AbstractClassRep *parent )
|
|
|
- {
|
|
|
- // name is a static compiler string so no need to worry about copying or deleting
|
|
|
- mClassName = name;
|
|
|
+ ConcreteClassRep(const char *name, S32 netClassGroupMask, S32 netClassType, S32 netEventDir, AbstractClassRep *parent )
|
|
|
+ {
|
|
|
+ // name is a static compiler string so no need to worry about copying or deleting
|
|
|
+ mClassName = name;
|
|
|
|
|
|
- // Clean up mClassId
|
|
|
- for(U32 i = 0; i < NetClassGroupsCount; i++)
|
|
|
- mClassId[i] = -1;
|
|
|
+ // Clean up mClassId
|
|
|
+ for(U32 i = 0; i < NetClassGroupsCount; i++)
|
|
|
+ mClassId[i] = -1;
|
|
|
|
|
|
- // Set properties for this ACR
|
|
|
- mClassType = netClassType;
|
|
|
- mClassGroupMask = netClassGroupMask;
|
|
|
- mNetEventDir = netEventDir;
|
|
|
- parentClass = parent;
|
|
|
+ // Set properties for this ACR
|
|
|
+ mClassType = netClassType;
|
|
|
+ mClassGroupMask = netClassGroupMask;
|
|
|
+ mNetEventDir = netEventDir;
|
|
|
+ parentClass = parent;
|
|
|
|
|
|
- // Finally, register ourselves.
|
|
|
- registerClassRep(this);
|
|
|
- };
|
|
|
+ // Finally, register ourselves.
|
|
|
+ registerClassRep(this);
|
|
|
+ };
|
|
|
|
|
|
virtual AbstractClassRep* getContainerChildClass( const bool recurse )
|
|
|
{
|
|
|
@@ -387,33 +391,40 @@ public:
|
|
|
return pParent->getContainerChildClass( recurse );
|
|
|
}
|
|
|
|
|
|
- /// Perform class specific initialization tasks.
|
|
|
- ///
|
|
|
- /// Link namespaces, call initPersistFields() and consoleInit().
|
|
|
- void init() const
|
|
|
- {
|
|
|
- // Get handle to our parent class, if any, and ourselves (we are our parent's child).
|
|
|
- AbstractClassRep *parent = T::getParentStaticClassRep();
|
|
|
- AbstractClassRep *child = T::getStaticClassRep();
|
|
|
-
|
|
|
- // If we got reps, then link those namespaces! (To get proper inheritance.)
|
|
|
- if(parent && child)
|
|
|
- Con::classLinkNamespaces(parent->getNameSpace(), child->getNameSpace());
|
|
|
-
|
|
|
- // Finally, do any class specific initialization...
|
|
|
- T::initPersistFields();
|
|
|
- T::consoleInit();
|
|
|
- }
|
|
|
-
|
|
|
- /// Wrap constructor.
|
|
|
- ConsoleObject* create() const { return new T; }
|
|
|
+ virtual WriteCustomTamlSchema getCustomTamlSchema( void )
|
|
|
+ {
|
|
|
+ return T::getStaticWriteCustomTamlSchema();
|
|
|
+ }
|
|
|
+
|
|
|
+ /// Perform class specific initialization tasks.
|
|
|
+ ///
|
|
|
+ /// Link namespaces, call initPersistFields() and consoleInit().
|
|
|
+ void init() const
|
|
|
+ {
|
|
|
+ // Get handle to our parent class, if any, and ourselves (we are our parent's child).
|
|
|
+ AbstractClassRep *parent = T::getParentStaticClassRep();
|
|
|
+ AbstractClassRep *child = T::getStaticClassRep();
|
|
|
+
|
|
|
+ // If we got reps, then link those namespaces! (To get proper inheritance.)
|
|
|
+ if(parent && child)
|
|
|
+ Con::classLinkNamespaces(parent->getNameSpace(), child->getNameSpace());
|
|
|
+
|
|
|
+ // Finally, do any class specific initialization...
|
|
|
+ T::initPersistFields();
|
|
|
+ T::consoleInit();
|
|
|
+ }
|
|
|
+
|
|
|
+ /// Wrap constructor.
|
|
|
+ ConsoleObject* create() const { return new T; }
|
|
|
};
|
|
|
|
|
|
-//------------------------------------------------------------------------------
|
|
|
+//-----------------------------------------------------------------------------
|
|
|
+
|
|
|
// Forward declarations so they can be used in the class
|
|
|
const char *defaultProtectedGetFn( void *obj, const char *data );
|
|
|
bool defaultProtectedWriteFn( void* obj, StringTableEntry pFieldName );
|
|
|
|
|
|
+//-----------------------------------------------------------------------------
|
|
|
/// Interface class to the console.
|
|
|
///
|
|
|
/// @section ConsoleObject_basics The Basics
|
|
|
@@ -464,407 +475,451 @@ bool defaultProtectedWriteFn( void* obj, StringTableEntry pFieldName );
|
|
|
///
|
|
|
/// @see AbstractClassRep for gory implementation details.
|
|
|
/// @nosubgrouping
|
|
|
+//-----------------------------------------------------------------------------
|
|
|
+
|
|
|
class ConsoleObject
|
|
|
{
|
|
|
protected:
|
|
|
- /// @deprecated This is disallowed.
|
|
|
- ConsoleObject() { /* disallowed */ }
|
|
|
- /// @deprecated This is disallowed.
|
|
|
- ConsoleObject(const ConsoleObject&);
|
|
|
+ /// @deprecated This is disallowed.
|
|
|
+ ConsoleObject() { /* disallowed */ }
|
|
|
+ /// @deprecated This is disallowed.
|
|
|
+ ConsoleObject(const ConsoleObject&);
|
|
|
|
|
|
public:
|
|
|
- /// Get a reference to a field by name.
|
|
|
- const AbstractClassRep::Field* findField(StringTableEntry fieldName) const;
|
|
|
+ /// Get a reference to a field by name.
|
|
|
+ const AbstractClassRep::Field* findField(StringTableEntry fieldName) const;
|
|
|
|
|
|
- /// Gets the ClassRep.
|
|
|
- virtual AbstractClassRep* getClassRep() const;
|
|
|
+ /// Gets the ClassRep.
|
|
|
+ virtual AbstractClassRep* getClassRep() const;
|
|
|
|
|
|
- /// Set the value of a field.
|
|
|
- bool setField(const char *fieldName, const char *value);
|
|
|
- virtual ~ConsoleObject();
|
|
|
+ /// Set the value of a field.
|
|
|
+ bool setField(const char *fieldName, const char *value);
|
|
|
+ virtual ~ConsoleObject();
|
|
|
|
|
|
public:
|
|
|
- /// @name Object Creation
|
|
|
- /// @{
|
|
|
- static ConsoleObject* create(const char* in_pClassName);
|
|
|
- static ConsoleObject* create(const U32 groupId, const U32 typeId, const U32 in_classId);
|
|
|
- /// @}
|
|
|
+ /// @name Object Creation
|
|
|
+ /// @{
|
|
|
+ static ConsoleObject* create(const char* in_pClassName);
|
|
|
+ static ConsoleObject* create(const U32 groupId, const U32 typeId, const U32 in_classId);
|
|
|
+ /// @}
|
|
|
|
|
|
public:
|
|
|
- /// Get the classname from a class tag.
|
|
|
- static const char* lookupClassName(const U32 in_classTag);
|
|
|
+ /// Get the classname from a class tag.
|
|
|
+ static const char* lookupClassName(const U32 in_classTag);
|
|
|
|
|
|
protected:
|
|
|
- /// @name Fields
|
|
|
- /// @{
|
|
|
-
|
|
|
- /// Mark the beginning of a group of fields.
|
|
|
- ///
|
|
|
- /// This is used in the consoleDoc system.
|
|
|
- /// @see console_autodoc
|
|
|
- static void addGroup(const char* in_pGroupname, const char* in_pGroupDocs = NULL);
|
|
|
-
|
|
|
- /// Mark the end of a group of fields.
|
|
|
- ///
|
|
|
- /// This is used in the consoleDoc system.
|
|
|
- /// @see console_autodoc
|
|
|
- static void endGroup(const char* in_pGroupname);
|
|
|
-
|
|
|
- /// Register a complex field.
|
|
|
- ///
|
|
|
- /// @param in_pFieldname Name of the field.
|
|
|
- /// @param in_fieldType Type of the field. @see ConsoleDynamicTypes
|
|
|
- /// @param in_fieldOffset Offset to the field from the start of the class; calculated using the Offset() macro.
|
|
|
- /// @param in_elementCount Number of elements in this field. Arrays of elements are assumed to be contiguous in memory.
|
|
|
- /// @param in_table An EnumTable, if this is an enumerated field.
|
|
|
- /// @param in_pFieldDocs Usage string for this field. @see console_autodoc
|
|
|
- static void addField(const char* in_pFieldname,
|
|
|
- const U32 in_fieldType,
|
|
|
- const dsize_t in_fieldOffset,
|
|
|
- const U32 in_elementCount = 1,
|
|
|
- EnumTable * in_table = NULL,
|
|
|
- const char* in_pFieldDocs = NULL);
|
|
|
-
|
|
|
- /// Register a complex field with a write notify.
|
|
|
- ///
|
|
|
- /// @param in_pFieldname Name of the field.
|
|
|
- /// @param in_fieldType Type of the field. @see ConsoleDynamicTypes
|
|
|
- /// @param in_fieldOffset Offset to the field from the start of the class; calculated using the Offset() macro.
|
|
|
- /// @param in_writeDataFn This method will return whether the field should be written or not.
|
|
|
- /// @param in_elementCount Number of elements in this field. Arrays of elements are assumed to be contiguous in memory.
|
|
|
- /// @param in_table An EnumTable, if this is an enumerated field.
|
|
|
- /// @param in_pFieldDocs Usage string for this field. @see console_autodoc
|
|
|
- static void addField(const char* in_pFieldname,
|
|
|
- const U32 in_fieldType,
|
|
|
- const dsize_t in_fieldOffset,
|
|
|
- AbstractClassRep::WriteDataNotify in_writeDataFn,
|
|
|
- const U32 in_elementCount = 1,
|
|
|
- EnumTable * in_table = NULL,
|
|
|
- const char* in_pFieldDocs = NULL);
|
|
|
-
|
|
|
- /// Register a simple field.
|
|
|
- ///
|
|
|
- /// @param in_pFieldname Name of the field.
|
|
|
- /// @param in_fieldType Type of the field. @see ConsoleDynamicTypes
|
|
|
- /// @param in_fieldOffset Offset to the field from the start of the class; calculated using the Offset() macro.
|
|
|
- /// @param in_pFieldDocs Usage string for this field. @see console_autodoc
|
|
|
- static void addField(const char* in_pFieldname,
|
|
|
- const U32 in_fieldType,
|
|
|
- const dsize_t in_fieldOffset,
|
|
|
- const char* in_pFieldDocs);
|
|
|
-
|
|
|
-
|
|
|
- /// Register a simple field with a write notify.
|
|
|
- ///
|
|
|
- /// @param in_pFieldname Name of the field.
|
|
|
- /// @param in_fieldType Type of the field. @see ConsoleDynamicTypes
|
|
|
- /// @param in_fieldOffset Offset to the field from the start of the class; calculated using the Offset() macro.
|
|
|
- /// @param in_writeDataFn This method will return whether the field should be written or not.
|
|
|
- /// @param in_pFieldDocs Usage string for this field. @see console_autodoc
|
|
|
- static void addField(const char* in_pFieldname,
|
|
|
- const U32 in_fieldType,
|
|
|
- const dsize_t in_fieldOffset,
|
|
|
- AbstractClassRep::WriteDataNotify in_writeDataFn,
|
|
|
- const char* in_pFieldDocs );
|
|
|
-
|
|
|
- /// Register a validated field.
|
|
|
- ///
|
|
|
- /// A validated field is just like a normal field except that you can't
|
|
|
- /// have it be an array, and that you give it a pointer to a ConsoleTypeValidator
|
|
|
- /// subclass, which is then used to validate any value placed in it. Invalid
|
|
|
- /// values are ignored and an error is printed to the console.
|
|
|
- ///
|
|
|
- /// @see addField
|
|
|
- /// @see typeValidators.h
|
|
|
- static void addFieldV(const char* in_pFieldname,
|
|
|
- const U32 in_fieldType,
|
|
|
- const dsize_t in_fieldOffset,
|
|
|
- ConsoleTypeValidator *v,
|
|
|
- const char * in_pFieldDocs = NULL);
|
|
|
-
|
|
|
- /// Register a complex protected field.
|
|
|
- ///
|
|
|
- /// @param in_pFieldname Name of the field.
|
|
|
- /// @param in_fieldType Type of the field. @see ConsoleDynamicTypes
|
|
|
- /// @param in_fieldOffset Offset to the field from the start of the class; calculated using the Offset() macro.
|
|
|
- /// @param in_setDataFn When this field gets set, it will call the callback provided. @see console_protected
|
|
|
- /// @param in_getDataFn When this field is accessed for it's data, it will return the value of this function
|
|
|
- /// @param in_elementCount Number of elements in this field. Arrays of elements are assumed to be contiguous in memory.
|
|
|
- /// @param in_table An EnumTable, if this is an enumerated field.
|
|
|
- /// @param in_pFieldDocs Usage string for this field. @see console_autodoc
|
|
|
- static void addProtectedField(const char* in_pFieldname,
|
|
|
- const U32 in_fieldType,
|
|
|
- const dsize_t in_fieldOffset,
|
|
|
- AbstractClassRep::SetDataNotify in_setDataFn,
|
|
|
- AbstractClassRep::GetDataNotify in_getDataFn = &defaultProtectedGetFn,
|
|
|
- const U32 in_elementCount = 1,
|
|
|
- EnumTable * in_table = NULL,
|
|
|
- const char* in_pFieldDocs = NULL);
|
|
|
-
|
|
|
- /// Register a complex protected field.
|
|
|
- ///
|
|
|
- /// @param in_pFieldname Name of the field.
|
|
|
- /// @param in_fieldType Type of the field. @see ConsoleDynamicTypes
|
|
|
- /// @param in_fieldOffset Offset to the field from the start of the class; calculated using the Offset() macro.
|
|
|
- /// @param in_setDataFn When this field gets set, it will call the callback provided. @see console_protected
|
|
|
- /// @param in_getDataFn When this field is accessed for it's data, it will return the value of this function
|
|
|
- /// @param in_writeDataFn This method will return whether the field should be written or not.
|
|
|
- /// @param in_elementCount Number of elements in this field. Arrays of elements are assumed to be contiguous in memory.
|
|
|
- /// @param in_table An EnumTable, if this is an enumerated field.
|
|
|
- /// @param in_pFieldDocs Usage string for this field. @see console_autodoc
|
|
|
- static void addProtectedField(const char* in_pFieldname,
|
|
|
- const U32 in_fieldType,
|
|
|
- const dsize_t in_fieldOffset,
|
|
|
- AbstractClassRep::SetDataNotify in_setDataFn,
|
|
|
- AbstractClassRep::GetDataNotify in_getDataFn = &defaultProtectedGetFn,
|
|
|
- AbstractClassRep::WriteDataNotify in_writeDataFn = &defaultProtectedWriteFn,
|
|
|
- const U32 in_elementCount = 1,
|
|
|
- EnumTable * in_table = NULL,
|
|
|
- const char* in_pFieldDocs = NULL);
|
|
|
-
|
|
|
- /// Register a simple protected field.
|
|
|
- ///
|
|
|
- /// @param in_pFieldname Name of the field.
|
|
|
- /// @param in_fieldType Type of the field. @see ConsoleDynamicTypes
|
|
|
- /// @param in_fieldOffset Offset to the field from the start of the class; calculated using the Offset() macro.
|
|
|
- /// @param in_setDataFn When this field gets set, it will call the callback provided. @see console_protected
|
|
|
- /// @param in_getDataFn When this field is accessed for it's data, it will return the value of this function
|
|
|
- /// @param in_pFieldDocs Usage string for this field. @see console_autodoc
|
|
|
- static void addProtectedField(const char* in_pFieldname,
|
|
|
- const U32 in_fieldType,
|
|
|
- const dsize_t in_fieldOffset,
|
|
|
- AbstractClassRep::SetDataNotify in_setDataFn,
|
|
|
- AbstractClassRep::GetDataNotify in_getDataFn = &defaultProtectedGetFn,
|
|
|
- const char* in_pFieldDocs = NULL);
|
|
|
-
|
|
|
- /// Register a simple protected field.
|
|
|
- ///
|
|
|
- /// @param in_pFieldname Name of the field.
|
|
|
- /// @param in_fieldType Type of the field. @see ConsoleDynamicTypes
|
|
|
- /// @param in_fieldOffset Offset to the field from the start of the class; calculated using the Offset() macro.
|
|
|
- /// @param in_setDataFn When this field gets set, it will call the callback provided. @see console_protected
|
|
|
- /// @param in_getDataFn When this field is accessed for it's data, it will return the value of this function
|
|
|
- /// @param in_writeDataFn This method will return whether the field should be written or not.
|
|
|
- /// @param in_pFieldDocs Usage string for this field. @see console_autodoc
|
|
|
- static void addProtectedField(const char* in_pFieldname,
|
|
|
- const U32 in_fieldType,
|
|
|
- const dsize_t in_fieldOffset,
|
|
|
- AbstractClassRep::SetDataNotify in_setDataFn,
|
|
|
- AbstractClassRep::GetDataNotify in_getDataFn = &defaultProtectedGetFn,
|
|
|
- AbstractClassRep::WriteDataNotify in_writeDataFn = &defaultProtectedWriteFn,
|
|
|
- const char* in_pFieldDocs = NULL);
|
|
|
-
|
|
|
- /// Add a deprecated field.
|
|
|
- ///
|
|
|
- /// A deprecated field will always be undefined, even if you assign a value to it. This
|
|
|
- /// is useful when you need to make sure that a field is not being used anymore.
|
|
|
- static void addDepricatedField(const char *fieldName);
|
|
|
-
|
|
|
- /// Remove a field.
|
|
|
- ///
|
|
|
- /// Sometimes, you just have to remove a field!
|
|
|
- /// @returns True on success.
|
|
|
- static bool removeField(const char* in_pFieldname);
|
|
|
-
|
|
|
- /// @}
|
|
|
+ /// @name Fields
|
|
|
+ /// @{
|
|
|
+
|
|
|
+ /// Mark the beginning of a group of fields.
|
|
|
+ ///
|
|
|
+ /// This is used in the consoleDoc system.
|
|
|
+ /// @see console_autodoc
|
|
|
+ static void addGroup(const char* in_pGroupname, const char* in_pGroupDocs = NULL);
|
|
|
+
|
|
|
+ /// Mark the end of a group of fields.
|
|
|
+ ///
|
|
|
+ /// This is used in the consoleDoc system.
|
|
|
+ /// @see console_autodoc
|
|
|
+ static void endGroup(const char* in_pGroupname);
|
|
|
+
|
|
|
+ /// Register a complex field.
|
|
|
+ ///
|
|
|
+ /// @param in_pFieldname Name of the field.
|
|
|
+ /// @param in_fieldType Type of the field. @see ConsoleDynamicTypes
|
|
|
+ /// @param in_fieldOffset Offset to the field from the start of the class; calculated using the Offset() macro.
|
|
|
+ /// @param in_elementCount Number of elements in this field. Arrays of elements are assumed to be contiguous in memory.
|
|
|
+ /// @param in_table An EnumTable, if this is an enumerated field.
|
|
|
+ /// @param in_pFieldDocs Usage string for this field. @see console_autodoc
|
|
|
+ static void addField(const char* in_pFieldname,
|
|
|
+ const U32 in_fieldType,
|
|
|
+ const dsize_t in_fieldOffset,
|
|
|
+ const U32 in_elementCount = 1,
|
|
|
+ EnumTable * in_table = NULL,
|
|
|
+ const char* in_pFieldDocs = NULL);
|
|
|
+
|
|
|
+ /// Register a complex field with a write notify.
|
|
|
+ ///
|
|
|
+ /// @param in_pFieldname Name of the field.
|
|
|
+ /// @param in_fieldType Type of the field. @see ConsoleDynamicTypes
|
|
|
+ /// @param in_fieldOffset Offset to the field from the start of the class; calculated using the Offset() macro.
|
|
|
+ /// @param in_writeDataFn This method will return whether the field should be written or not.
|
|
|
+ /// @param in_elementCount Number of elements in this field. Arrays of elements are assumed to be contiguous in memory.
|
|
|
+ /// @param in_table An EnumTable, if this is an enumerated field.
|
|
|
+ /// @param in_pFieldDocs Usage string for this field. @see console_autodoc
|
|
|
+ static void addField(const char* in_pFieldname,
|
|
|
+ const U32 in_fieldType,
|
|
|
+ const dsize_t in_fieldOffset,
|
|
|
+ AbstractClassRep::WriteDataNotify in_writeDataFn,
|
|
|
+ const U32 in_elementCount = 1,
|
|
|
+ EnumTable * in_table = NULL,
|
|
|
+ const char* in_pFieldDocs = NULL);
|
|
|
+
|
|
|
+ /// Register a simple field.
|
|
|
+ ///
|
|
|
+ /// @param in_pFieldname Name of the field.
|
|
|
+ /// @param in_fieldType Type of the field. @see ConsoleDynamicTypes
|
|
|
+ /// @param in_fieldOffset Offset to the field from the start of the class; calculated using the Offset() macro.
|
|
|
+ /// @param in_pFieldDocs Usage string for this field. @see console_autodoc
|
|
|
+ static void addField(const char* in_pFieldname,
|
|
|
+ const U32 in_fieldType,
|
|
|
+ const dsize_t in_fieldOffset,
|
|
|
+ const char* in_pFieldDocs);
|
|
|
+
|
|
|
+
|
|
|
+ /// Register a simple field with a write notify.
|
|
|
+ ///
|
|
|
+ /// @param in_pFieldname Name of the field.
|
|
|
+ /// @param in_fieldType Type of the field. @see ConsoleDynamicTypes
|
|
|
+ /// @param in_fieldOffset Offset to the field from the start of the class; calculated using the Offset() macro.
|
|
|
+ /// @param in_writeDataFn This method will return whether the field should be written or not.
|
|
|
+ /// @param in_pFieldDocs Usage string for this field. @see console_autodoc
|
|
|
+ static void addField(const char* in_pFieldname,
|
|
|
+ const U32 in_fieldType,
|
|
|
+ const dsize_t in_fieldOffset,
|
|
|
+ AbstractClassRep::WriteDataNotify in_writeDataFn,
|
|
|
+ const char* in_pFieldDocs );
|
|
|
+
|
|
|
+ /// Register a validated field.
|
|
|
+ ///
|
|
|
+ /// A validated field is just like a normal field except that you can't
|
|
|
+ /// have it be an array, and that you give it a pointer to a ConsoleTypeValidator
|
|
|
+ /// subclass, which is then used to validate any value placed in it. Invalid
|
|
|
+ /// values are ignored and an error is printed to the console.
|
|
|
+ ///
|
|
|
+ /// @see addField
|
|
|
+ /// @see typeValidators.h
|
|
|
+ static void addFieldV(const char* in_pFieldname,
|
|
|
+ const U32 in_fieldType,
|
|
|
+ const dsize_t in_fieldOffset,
|
|
|
+ ConsoleTypeValidator *v,
|
|
|
+ const char * in_pFieldDocs = NULL);
|
|
|
+
|
|
|
+ /// Register a complex protected field.
|
|
|
+ ///
|
|
|
+ /// @param in_pFieldname Name of the field.
|
|
|
+ /// @param in_fieldType Type of the field. @see ConsoleDynamicTypes
|
|
|
+ /// @param in_fieldOffset Offset to the field from the start of the class; calculated using the Offset() macro.
|
|
|
+ /// @param in_setDataFn When this field gets set, it will call the callback provided. @see console_protected
|
|
|
+ /// @param in_getDataFn When this field is accessed for it's data, it will return the value of this function
|
|
|
+ /// @param in_elementCount Number of elements in this field. Arrays of elements are assumed to be contiguous in memory.
|
|
|
+ /// @param in_table An EnumTable, if this is an enumerated field.
|
|
|
+ /// @param in_pFieldDocs Usage string for this field. @see console_autodoc
|
|
|
+ static void addProtectedField(const char* in_pFieldname,
|
|
|
+ const U32 in_fieldType,
|
|
|
+ const dsize_t in_fieldOffset,
|
|
|
+ AbstractClassRep::SetDataNotify in_setDataFn,
|
|
|
+ AbstractClassRep::GetDataNotify in_getDataFn = &defaultProtectedGetFn,
|
|
|
+ const U32 in_elementCount = 1,
|
|
|
+ EnumTable * in_table = NULL,
|
|
|
+ const char* in_pFieldDocs = NULL);
|
|
|
+
|
|
|
+ /// Register a complex protected field.
|
|
|
+ ///
|
|
|
+ /// @param in_pFieldname Name of the field.
|
|
|
+ /// @param in_fieldType Type of the field. @see ConsoleDynamicTypes
|
|
|
+ /// @param in_fieldOffset Offset to the field from the start of the class; calculated using the Offset() macro.
|
|
|
+ /// @param in_setDataFn When this field gets set, it will call the callback provided. @see console_protected
|
|
|
+ /// @param in_getDataFn When this field is accessed for it's data, it will return the value of this function
|
|
|
+ /// @param in_writeDataFn This method will return whether the field should be written or not.
|
|
|
+ /// @param in_elementCount Number of elements in this field. Arrays of elements are assumed to be contiguous in memory.
|
|
|
+ /// @param in_table An EnumTable, if this is an enumerated field.
|
|
|
+ /// @param in_pFieldDocs Usage string for this field. @see console_autodoc
|
|
|
+ static void addProtectedField(const char* in_pFieldname,
|
|
|
+ const U32 in_fieldType,
|
|
|
+ const dsize_t in_fieldOffset,
|
|
|
+ AbstractClassRep::SetDataNotify in_setDataFn,
|
|
|
+ AbstractClassRep::GetDataNotify in_getDataFn = &defaultProtectedGetFn,
|
|
|
+ AbstractClassRep::WriteDataNotify in_writeDataFn = &defaultProtectedWriteFn,
|
|
|
+ const U32 in_elementCount = 1,
|
|
|
+ EnumTable * in_table = NULL,
|
|
|
+ const char* in_pFieldDocs = NULL);
|
|
|
+
|
|
|
+ /// Register a simple protected field.
|
|
|
+ ///
|
|
|
+ /// @param in_pFieldname Name of the field.
|
|
|
+ /// @param in_fieldType Type of the field. @see ConsoleDynamicTypes
|
|
|
+ /// @param in_fieldOffset Offset to the field from the start of the class; calculated using the Offset() macro.
|
|
|
+ /// @param in_setDataFn When this field gets set, it will call the callback provided. @see console_protected
|
|
|
+ /// @param in_getDataFn When this field is accessed for it's data, it will return the value of this function
|
|
|
+ /// @param in_pFieldDocs Usage string for this field. @see console_autodoc
|
|
|
+ static void addProtectedField(const char* in_pFieldname,
|
|
|
+ const U32 in_fieldType,
|
|
|
+ const dsize_t in_fieldOffset,
|
|
|
+ AbstractClassRep::SetDataNotify in_setDataFn,
|
|
|
+ AbstractClassRep::GetDataNotify in_getDataFn = &defaultProtectedGetFn,
|
|
|
+ const char* in_pFieldDocs = NULL);
|
|
|
+
|
|
|
+ /// Register a simple protected field.
|
|
|
+ ///
|
|
|
+ /// @param in_pFieldname Name of the field.
|
|
|
+ /// @param in_fieldType Type of the field. @see ConsoleDynamicTypes
|
|
|
+ /// @param in_fieldOffset Offset to the field from the start of the class; calculated using the Offset() macro.
|
|
|
+ /// @param in_setDataFn When this field gets set, it will call the callback provided. @see console_protected
|
|
|
+ /// @param in_getDataFn When this field is accessed for it's data, it will return the value of this function
|
|
|
+ /// @param in_writeDataFn This method will return whether the field should be written or not.
|
|
|
+ /// @param in_pFieldDocs Usage string for this field. @see console_autodoc
|
|
|
+ static void addProtectedField(const char* in_pFieldname,
|
|
|
+ const U32 in_fieldType,
|
|
|
+ const dsize_t in_fieldOffset,
|
|
|
+ AbstractClassRep::SetDataNotify in_setDataFn,
|
|
|
+ AbstractClassRep::GetDataNotify in_getDataFn = &defaultProtectedGetFn,
|
|
|
+ AbstractClassRep::WriteDataNotify in_writeDataFn = &defaultProtectedWriteFn,
|
|
|
+ const char* in_pFieldDocs = NULL);
|
|
|
+
|
|
|
+ /// Add a deprecated field.
|
|
|
+ ///
|
|
|
+ /// A deprecated field will always be undefined, even if you assign a value to it. This
|
|
|
+ /// is useful when you need to make sure that a field is not being used anymore.
|
|
|
+ static void addDepricatedField(const char *fieldName);
|
|
|
+
|
|
|
+ /// Remove a field.
|
|
|
+ ///
|
|
|
+ /// Sometimes, you just have to remove a field!
|
|
|
+ /// @returns True on success.
|
|
|
+ static bool removeField(const char* in_pFieldname);
|
|
|
+
|
|
|
+ /// @}
|
|
|
public:
|
|
|
- /// Register dynamic fields in a subclass of ConsoleObject.
|
|
|
- ///
|
|
|
- /// @see addField(), addFieldV(), addDepricatedField(), addGroup(), endGroup()
|
|
|
- static void initPersistFields();
|
|
|
-
|
|
|
- /// Register global constant variables and do other one-time initialization tasks in
|
|
|
- /// a subclass of ConsoleObject.
|
|
|
- ///
|
|
|
- /// @deprecated You should use ConsoleMethod and ConsoleFunction, not this, to
|
|
|
- /// register methods or commands.
|
|
|
- /// @see console
|
|
|
- static void consoleInit();
|
|
|
-
|
|
|
- /// @name Field List
|
|
|
- /// @{
|
|
|
-
|
|
|
- /// Get a list of all the fields. This information cannot be modified.
|
|
|
- const AbstractClassRep::FieldList& getFieldList() const;
|
|
|
-
|
|
|
- /// Get a list of all the fields, set up so we can modify them.
|
|
|
- ///
|
|
|
- /// @note This is a bad trick to pull if you aren't very careful,
|
|
|
- /// since you can blast field data!
|
|
|
- AbstractClassRep::FieldList& getModifiableFieldList();
|
|
|
-
|
|
|
- /// Get a handle to a boolean telling us if we expanded the dynamic group.
|
|
|
- ///
|
|
|
- /// @see GuiInspector::Inspect()
|
|
|
- bool& getDynamicGroupExpand();
|
|
|
- /// @}
|
|
|
-
|
|
|
- /// @name ConsoleObject Implementation
|
|
|
- ///
|
|
|
- /// These functions are implemented in every subclass of
|
|
|
- /// ConsoleObject by an IMPLEMENT_CONOBJECT or IMPLEMENT_CO_* macro.
|
|
|
- /// @{
|
|
|
-
|
|
|
- /// Get the abstract class information for this class.
|
|
|
- static AbstractClassRep *getStaticClassRep() { return NULL; }
|
|
|
-
|
|
|
- /// Get the abstract class information for this class's superclass.
|
|
|
- static AbstractClassRep *getParentStaticClassRep() { return NULL; }
|
|
|
-
|
|
|
- /// Get our network-layer class id.
|
|
|
- ///
|
|
|
- /// @param netClassGroup The net class for which we want our ID.
|
|
|
- /// @see
|
|
|
- S32 getClassId(U32 netClassGroup) const;
|
|
|
-
|
|
|
- /// Get our compiler and platform independent class name.
|
|
|
- ///
|
|
|
- /// @note This name can be used to instantiate another instance using create()
|
|
|
- const char *getClassName() const;
|
|
|
-
|
|
|
- /// @}
|
|
|
+ /// Register dynamic fields in a subclass of ConsoleObject.
|
|
|
+ ///
|
|
|
+ /// @see addField(), addFieldV(), addDepricatedField(), addGroup(), endGroup()
|
|
|
+ static void initPersistFields();
|
|
|
+
|
|
|
+ /// Register global constant variables and do other one-time initialization tasks in
|
|
|
+ /// a subclass of ConsoleObject.
|
|
|
+ ///
|
|
|
+ /// @deprecated You should use ConsoleMethod and ConsoleFunction, not this, to
|
|
|
+ /// register methods or commands.
|
|
|
+ /// @see console
|
|
|
+ static void consoleInit();
|
|
|
+
|
|
|
+ /// @name Field List
|
|
|
+ /// @{
|
|
|
+
|
|
|
+ /// Get a list of all the fields. This information cannot be modified.
|
|
|
+ const AbstractClassRep::FieldList& getFieldList() const;
|
|
|
+
|
|
|
+ /// Get a list of all the fields, set up so we can modify them.
|
|
|
+ ///
|
|
|
+ /// @note This is a bad trick to pull if you aren't very careful,
|
|
|
+ /// since you can blast field data!
|
|
|
+ AbstractClassRep::FieldList& getModifiableFieldList();
|
|
|
+
|
|
|
+ /// Get a handle to a boolean telling us if we expanded the dynamic group.
|
|
|
+ ///
|
|
|
+ /// @see GuiInspector::Inspect()
|
|
|
+ bool& getDynamicGroupExpand();
|
|
|
+ /// @}
|
|
|
+
|
|
|
+ /// @name ConsoleObject Implementation
|
|
|
+ ///
|
|
|
+ /// These functions are implemented in every subclass of
|
|
|
+ /// ConsoleObject by an IMPLEMENT_CONOBJECT or IMPLEMENT_CO_* macro.
|
|
|
+ /// @{
|
|
|
+
|
|
|
+ /// Get the abstract class information for this class.
|
|
|
+ static AbstractClassRep *getStaticClassRep() { return NULL; }
|
|
|
+
|
|
|
+ /// Get the abstract class information for this class's superclass.
|
|
|
+ static AbstractClassRep *getParentStaticClassRep() { return NULL; }
|
|
|
+
|
|
|
+ /// Get our network-layer class id.
|
|
|
+ ///
|
|
|
+ /// @param netClassGroup The net class for which we want our ID.
|
|
|
+ /// @see
|
|
|
+ S32 getClassId(U32 netClassGroup) const;
|
|
|
+
|
|
|
+ /// Get our compiler and platform independent class name.
|
|
|
+ ///
|
|
|
+ /// @note This name can be used to instantiate another instance using create()
|
|
|
+ const char *getClassName() const;
|
|
|
+
|
|
|
+ /// @}
|
|
|
};
|
|
|
|
|
|
-// Deprecated? -pw
|
|
|
+//-----------------------------------------------------------------------------
|
|
|
+
|
|
|
#define addNamedField(fieldName,type,className) addField(#fieldName, type, Offset(fieldName,className))
|
|
|
#define addNamedFieldV(fieldName,type,className, validator) addFieldV(#fieldName, type, Offset(fieldName,className), validator)
|
|
|
|
|
|
-//------------------------------------------------------------------------------
|
|
|
-//-------------------------------------- Inlines
|
|
|
-//
|
|
|
+//-----------------------------------------------------------------------------
|
|
|
+
|
|
|
inline S32 ConsoleObject::getClassId(U32 netClassGroup) const
|
|
|
{
|
|
|
- AssertFatal(getClassRep() != NULL,"Cannot get tag from non-declared dynamic class!");
|
|
|
- return getClassRep()->getClassId(netClassGroup);
|
|
|
+ AssertFatal(getClassRep() != NULL,"Cannot get tag from non-declared dynamic class!");
|
|
|
+ return getClassRep()->getClassId(netClassGroup);
|
|
|
}
|
|
|
|
|
|
+//-----------------------------------------------------------------------------
|
|
|
+
|
|
|
inline const char * ConsoleObject::getClassName() const
|
|
|
{
|
|
|
- AssertFatal(getClassRep() != NULL,
|
|
|
- "Cannot get tag from non-declared dynamic class");
|
|
|
- return getClassRep()->getClassName();
|
|
|
+ AssertFatal(getClassRep() != NULL,
|
|
|
+ "Cannot get tag from non-declared dynamic class");
|
|
|
+ return getClassRep()->getClassName();
|
|
|
}
|
|
|
|
|
|
+//-----------------------------------------------------------------------------
|
|
|
+
|
|
|
inline const AbstractClassRep::Field * ConsoleObject::findField(StringTableEntry name) const
|
|
|
{
|
|
|
- AssertFatal(getClassRep() != NULL,
|
|
|
- avar("Cannot get field '%s' from non-declared dynamic class.", name));
|
|
|
- return getClassRep()->findField(name);
|
|
|
+ AssertFatal(getClassRep() != NULL,
|
|
|
+ avar("Cannot get field '%s' from non-declared dynamic class.", name));
|
|
|
+ return getClassRep()->findField(name);
|
|
|
}
|
|
|
|
|
|
+//-----------------------------------------------------------------------------
|
|
|
+
|
|
|
inline bool ConsoleObject::setField(const char *fieldName, const char *value)
|
|
|
{
|
|
|
- //sanity check
|
|
|
- if ((! fieldName) || (! fieldName[0]) || (! value))
|
|
|
- return false;
|
|
|
+ //sanity check
|
|
|
+ if ((! fieldName) || (! fieldName[0]) || (! value))
|
|
|
+ return false;
|
|
|
|
|
|
- if (! getClassRep())
|
|
|
- return false;
|
|
|
+ if (! getClassRep())
|
|
|
+ return false;
|
|
|
|
|
|
- const AbstractClassRep::Field *myField = getClassRep()->findField(StringTable->insert(fieldName));
|
|
|
+ const AbstractClassRep::Field *myField = getClassRep()->findField(StringTable->insert(fieldName));
|
|
|
|
|
|
- if (! myField)
|
|
|
- return false;
|
|
|
+ if (! myField)
|
|
|
+ return false;
|
|
|
|
|
|
- Con::setData(
|
|
|
- myField->type,
|
|
|
- (void *) (((const char *)(this)) + myField->offset),
|
|
|
- 0,
|
|
|
- 1,
|
|
|
- &value,
|
|
|
- myField->table,
|
|
|
- myField->flag);
|
|
|
+ Con::setData(
|
|
|
+ myField->type,
|
|
|
+ (void *) (((const char *)(this)) + myField->offset),
|
|
|
+ 0,
|
|
|
+ 1,
|
|
|
+ &value,
|
|
|
+ myField->table,
|
|
|
+ myField->flag);
|
|
|
|
|
|
- return true;
|
|
|
+ return true;
|
|
|
}
|
|
|
|
|
|
+//-----------------------------------------------------------------------------
|
|
|
+
|
|
|
inline ConsoleObject* ConsoleObject::create(const char* in_pClassName)
|
|
|
{
|
|
|
- return AbstractClassRep::create(in_pClassName);
|
|
|
+ return AbstractClassRep::create(in_pClassName);
|
|
|
}
|
|
|
|
|
|
+//-----------------------------------------------------------------------------
|
|
|
+
|
|
|
inline ConsoleObject* ConsoleObject::create(const U32 groupId, const U32 typeId, const U32 in_classId)
|
|
|
{
|
|
|
- return AbstractClassRep::create(groupId, typeId, in_classId);
|
|
|
+ return AbstractClassRep::create(groupId, typeId, in_classId);
|
|
|
}
|
|
|
|
|
|
+//-----------------------------------------------------------------------------
|
|
|
+
|
|
|
inline const AbstractClassRep::FieldList& ConsoleObject::getFieldList() const
|
|
|
{
|
|
|
- return getClassRep()->mFieldList;
|
|
|
+ return getClassRep()->mFieldList;
|
|
|
}
|
|
|
|
|
|
+//-----------------------------------------------------------------------------
|
|
|
+
|
|
|
inline AbstractClassRep::FieldList& ConsoleObject::getModifiableFieldList()
|
|
|
{
|
|
|
- return getClassRep()->mFieldList;
|
|
|
+ return getClassRep()->mFieldList;
|
|
|
}
|
|
|
|
|
|
+//-----------------------------------------------------------------------------
|
|
|
+
|
|
|
inline bool& ConsoleObject::getDynamicGroupExpand()
|
|
|
{
|
|
|
- return getClassRep()->mDynamicGroupExpand;
|
|
|
+ return getClassRep()->mDynamicGroupExpand;
|
|
|
}
|
|
|
|
|
|
-/// @name ConsoleObject Macros
|
|
|
-/// @{
|
|
|
-
|
|
|
-#define DECLARE_CONOBJECT(className) \
|
|
|
- static ConcreteClassRep<className> dynClassRep; \
|
|
|
- static AbstractClassRep* getParentStaticClassRep(); \
|
|
|
- static AbstractClassRep* getContainerChildStaticClassRep(); \
|
|
|
- static AbstractClassRep* getStaticClassRep(); \
|
|
|
- virtual AbstractClassRep* getClassRep() const
|
|
|
+//-----------------------------------------------------------------------------
|
|
|
|
|
|
-#define IMPLEMENT_CONOBJECT(className) \
|
|
|
- AbstractClassRep* className::getClassRep() const { return &className::dynClassRep; } \
|
|
|
- AbstractClassRep* className::getStaticClassRep() { return &dynClassRep; } \
|
|
|
- AbstractClassRep* className::getParentStaticClassRep() { return Parent::getStaticClassRep(); } \
|
|
|
- AbstractClassRep* className::getContainerChildStaticClassRep() { return NULL; } \
|
|
|
- ConcreteClassRep<className> className::dynClassRep(#className, 0, -1, 0, className::getParentStaticClassRep())
|
|
|
+#define DECLARE_CONOBJECT(className) \
|
|
|
+ static ConcreteClassRep<className> dynClassRep; \
|
|
|
+ static AbstractClassRep* getParentStaticClassRep(); \
|
|
|
+ static AbstractClassRep* getContainerChildStaticClassRep(); \
|
|
|
+ static AbstractClassRep* getStaticClassRep(); \
|
|
|
+ static AbstractClassRep::WriteCustomTamlSchema className::getStaticWriteCustomTamlSchema(); \
|
|
|
+ virtual AbstractClassRep* getClassRep() const
|
|
|
+
|
|
|
+#define IMPLEMENT_CONOBJECT(className) \
|
|
|
+ AbstractClassRep* className::getClassRep() const { return &className::dynClassRep; } \
|
|
|
+ AbstractClassRep* className::getStaticClassRep() { return &dynClassRep; } \
|
|
|
+ AbstractClassRep* className::getParentStaticClassRep() { return Parent::getStaticClassRep(); } \
|
|
|
+ AbstractClassRep* className::getContainerChildStaticClassRep() { return NULL; } \
|
|
|
+ AbstractClassRep::WriteCustomTamlSchema className::getStaticWriteCustomTamlSchema() { return NULL; } \
|
|
|
+ ConcreteClassRep<className> className::dynClassRep(#className, 0, -1, 0, className::getParentStaticClassRep())
|
|
|
|
|
|
#define IMPLEMENT_CONOBJECT_CHILDREN(className) \
|
|
|
- AbstractClassRep* className::getClassRep() const { return &className::dynClassRep; } \
|
|
|
- AbstractClassRep* className::getStaticClassRep() { return &dynClassRep; } \
|
|
|
- AbstractClassRep* className::getParentStaticClassRep() { return Parent::getStaticClassRep(); } \
|
|
|
- AbstractClassRep* className::getContainerChildStaticClassRep() { return Children::getStaticClassRep(); } \
|
|
|
- ConcreteClassRep<className> className::dynClassRep(#className, 0, -1, 0, className::getParentStaticClassRep())
|
|
|
-
|
|
|
-#define IMPLEMENT_CO_NETOBJECT_V1(className) \
|
|
|
- AbstractClassRep* className::getClassRep() const { return &className::dynClassRep; } \
|
|
|
- AbstractClassRep* className::getStaticClassRep() { return &dynClassRep; } \
|
|
|
- AbstractClassRep* className::getParentStaticClassRep() { return Parent::getStaticClassRep(); } \
|
|
|
- AbstractClassRep* className::getContainerChildStaticClassRep() { return NULL; } \
|
|
|
- ConcreteClassRep<className> className::dynClassRep(#className, NetClassGroupGameMask, NetClassTypeObject, 0, className::getParentStaticClassRep())
|
|
|
-
|
|
|
-#define IMPLEMENT_CO_DATABLOCK_V1(className) \
|
|
|
- AbstractClassRep* className::getClassRep() const { return &className::dynClassRep; } \
|
|
|
- AbstractClassRep* className::getStaticClassRep() { return &dynClassRep; } \
|
|
|
- AbstractClassRep* className::getParentStaticClassRep() { return Parent::getStaticClassRep(); } \
|
|
|
- AbstractClassRep* className::getContainerChildStaticClassRep() {return NULL; } \
|
|
|
- ConcreteClassRep<className> className::dynClassRep(#className, NetClassGroupGameMask, NetClassTypeDataBlock, 0, className::getParentStaticClassRep())
|
|
|
-
|
|
|
-/// @}
|
|
|
-
|
|
|
-//------------------------------------------------------------------------------
|
|
|
+ AbstractClassRep* className::getClassRep() const { return &className::dynClassRep; } \
|
|
|
+ AbstractClassRep* className::getStaticClassRep() { return &dynClassRep; } \
|
|
|
+ AbstractClassRep* className::getParentStaticClassRep() { return Parent::getStaticClassRep(); } \
|
|
|
+ AbstractClassRep* className::getContainerChildStaticClassRep() { return Children::getStaticClassRep(); } \
|
|
|
+ AbstractClassRep::WriteCustomTamlSchema className::getStaticWriteCustomTamlSchema() { return NULL; } \
|
|
|
+ ConcreteClassRep<className> className::dynClassRep(#className, 0, -1, 0, className::getParentStaticClassRep())
|
|
|
+
|
|
|
+#define IMPLEMENT_CONOBJECT_SCHEMA(className, schema) \
|
|
|
+ AbstractClassRep* className::getClassRep() const { return &className::dynClassRep; } \
|
|
|
+ AbstractClassRep* className::getStaticClassRep() { return &dynClassRep; } \
|
|
|
+ AbstractClassRep* className::getParentStaticClassRep() { return Parent::getStaticClassRep(); } \
|
|
|
+ AbstractClassRep* className::getContainerChildStaticClassRep() { return NULL; } \
|
|
|
+ AbstractClassRep::WriteCustomTamlSchema className::getStaticWriteCustomTamlSchema() { return schema; } \
|
|
|
+ ConcreteClassRep<className> className::dynClassRep(#className, 0, -1, 0, className::getParentStaticClassRep())
|
|
|
+
|
|
|
+#define IMPLEMENT_CONOBJECT_CHILDREN_SCHEMA(className, schema) \
|
|
|
+ AbstractClassRep* className::getClassRep() const { return &className::dynClassRep; } \
|
|
|
+ AbstractClassRep* className::getStaticClassRep() { return &dynClassRep; } \
|
|
|
+ AbstractClassRep* className::getParentStaticClassRep() { return Parent::getStaticClassRep(); } \
|
|
|
+ AbstractClassRep* className::getContainerChildStaticClassRep() { return Children::getStaticClassRep(); } \
|
|
|
+ AbstractClassRep::WriteCustomTamlSchema className::getStaticWriteCustomTamlSchema() { return schema; } \
|
|
|
+ ConcreteClassRep<className> className::dynClassRep(#className, 0, -1, 0, className::getParentStaticClassRep())
|
|
|
+
|
|
|
+#define IMPLEMENT_CO_NETOBJECT_V1(className) \
|
|
|
+ AbstractClassRep* className::getClassRep() const { return &className::dynClassRep; } \
|
|
|
+ AbstractClassRep* className::getStaticClassRep() { return &dynClassRep; } \
|
|
|
+ AbstractClassRep* className::getParentStaticClassRep() { return Parent::getStaticClassRep(); } \
|
|
|
+ AbstractClassRep* className::getContainerChildStaticClassRep() { return NULL; } \
|
|
|
+ AbstractClassRep::WriteCustomTamlSchema className::getStaticWriteCustomTamlSchema() { return NULL; } \
|
|
|
+ ConcreteClassRep<className> className::dynClassRep(#className, NetClassGroupGameMask, NetClassTypeObject, 0, className::getParentStaticClassRep())
|
|
|
+
|
|
|
+#define IMPLEMENT_CO_DATABLOCK_V1(className) \
|
|
|
+ AbstractClassRep* className::getClassRep() const { return &className::dynClassRep; } \
|
|
|
+ AbstractClassRep* className::getStaticClassRep() { return &dynClassRep; } \
|
|
|
+ AbstractClassRep* className::getParentStaticClassRep() { return Parent::getStaticClassRep(); } \
|
|
|
+ AbstractClassRep* className::getContainerChildStaticClassRep() {return NULL; } \
|
|
|
+ AbstractClassRep::WriteCustomTamlSchema className::getStaticWriteCustomTamlSchema() { return NULL; } \
|
|
|
+ ConcreteClassRep<className> className::dynClassRep(#className, NetClassGroupGameMask, NetClassTypeDataBlock, 0, className::getParentStaticClassRep())
|
|
|
+
|
|
|
+//-----------------------------------------------------------------------------
|
|
|
|
|
|
inline bool defaultProtectedSetFn( void *obj, const char *data )
|
|
|
{
|
|
|
- return true;
|
|
|
+ return true;
|
|
|
}
|
|
|
|
|
|
+//-----------------------------------------------------------------------------
|
|
|
+
|
|
|
inline const char *defaultProtectedGetFn( void *obj, const char *data )
|
|
|
{
|
|
|
- return data;
|
|
|
+ return data;
|
|
|
}
|
|
|
|
|
|
+//-----------------------------------------------------------------------------
|
|
|
+
|
|
|
inline bool defaultProtectedWriteFn( void* obj, StringTableEntry pFieldName )
|
|
|
{
|
|
|
return true;
|
|
|
}
|
|
|
|
|
|
+//-----------------------------------------------------------------------------
|
|
|
+
|
|
|
inline bool defaultProtectedNotSetFn(void* obj, const char* data)
|
|
|
{
|
|
|
return false;
|
|
|
}
|
|
|
|
|
|
+//-----------------------------------------------------------------------------
|
|
|
+
|
|
|
inline bool defaultProtectedNotWriteFn( void* obj, StringTableEntry pFieldName )
|
|
|
{
|
|
|
return false;
|
MelvMay-GG