ConsoleBaseType
Engine/source/console/dynamicTypes.h
Information about a console type.
cbt_list List Interface
Interface for accessing/traversing the list of types.
Get the head of the list.
Get the item that follows this item in the list.
Value Handling Interface
const char *
void *
Allocate a single value.
deleteNativeVariable(void * var)
Delete a single value allocated with getNativeVariable().
const bool
Return true if this is datablock object type.
Protected Attributes
const char *
Name of GuiInspectorField subclass to instantiate for field edit controls in inspectors.
Next item in the list of all console types.
Type info object for the engine type corresponding to this console type.
Name of this console type (TypeXXX).
Protected Static Attributes
Total number of defined console types. This is used to generate unique IDs for each type.
We maintain a linked list of all console types; this is its head.
Protected Functions
ConsoleBaseType(const S32 size, S32 * idPtr, const char * aTypeName)
The constructor is responsible for linking an element into the master list, registering the type ID, etc.
Destructor is private to avoid people mucking up the list.
Public Static Functions
getTypeByClassName(const char * typeName)
getTypeByName(const char * typeName)
Call to get a pointer to a type's info.
Called once to initialize the console type system.
Public Functions
const char *
Return the documentation string for this type.
Return the EnumTable for this type (only for enumeration types).
const char *
Return the name of the GuiInspectorField subclass that fields of this type should use for editing.
Return the type info for the engine type corresponding to this console type or NULL if there is no mapping for the console type.
Return the console type name (TypeXXX).
Return the size of a single value in bytes.
setInspectorFieldType(const char * type)
Set the name of the GuiInspectorField subclass that fields of this type should use for editing.
Detailed Description
Information about a console type.
cbt_list List Interface
Interface for accessing/traversing the list of types.
getListHead()
Get the head of the list.
getListNext()
Get the item that follows this item in the list.
Value Handling Interface
setData(void * dptr, S32 argc, const char ** argv, const EnumTable * tbl, BitSet32 flag)
Reimplemented by: BitfieldConsoleBaseType, SimObjectRefConsoleBaseType, ConcreteAbstractClassRep, EnumConsoleBaseType, RuntimeClassRep
getData(void * dptr, const EnumTable * tbl, BitSet32 flag)
Reimplemented by: BitfieldConsoleBaseType, SimObjectRefConsoleBaseType, ConcreteAbstractClassRep, EnumConsoleBaseType, RuntimeClassRep
getTypeClassName()
Reimplemented by: ConcreteAbstractClassRep, RuntimeClassRep, SimObjectRefConsoleBaseType
getNativeVariable()
Allocate a single value.
Reimplemented by: AbstractClassRep, SimObjectRefConsoleBaseType
deleteNativeVariable(void * var)
Delete a single value allocated with getNativeVariable().
Reimplemented by: AbstractClassRep, SimObjectRefConsoleBaseType
isDatablock()
Return true if this is datablock object type.
Reimplemented by: ConcreteAbstractClassRep, RuntimeClassRep, SimObjectRefConsoleBaseType
prepData(const char * data, char * buffer, U32 bufferLen)
getTypePrefix(void )
Protected Attributes
const char * mInspectorFieldType
Name of GuiInspectorField subclass to instantiate for field edit controls in inspectors.
ConsoleBaseType * mListNext
Next item in the list of all console types.
S32 mTypeID
Unique numeric type ID.
const EngineTypeInfo * mTypeInfo
Type info object for the engine type corresponding to this console type.
Since several console types may be mapped to a single native type, this type info instance may be shared by multiple ConsoleBaseType instances. NULL if the console type is not mapped to an engine API type.
StringTableEntry mTypeName
Name of this console type (TypeXXX).
dsize_t mTypeSize
Size of a single data value point.
Protected Static Attributes
S32 smConsoleTypeCount
Total number of defined console types. This is used to generate unique IDs for each type.
ConsoleBaseType * smListHead
We maintain a linked list of all console types; this is its head.
Protected Functions
ConsoleBaseType(const S32 size, S32 * idPtr, const char * aTypeName)
The constructor is responsible for linking an element into the master list, registering the type ID, etc.
~ConsoleBaseType()
Destructor is private to avoid people mucking up the list.
Public Static Functions
getType(const S32 typeID)
Call me to get a pointer to a type's info.
getTypeByClassName(const char * typeName)
getTypeByName(const char * typeName)
Call to get a pointer to a type's info.
initialize()
Called once to initialize the console type system.
Public Functions
getDocString()
Return the documentation string for this type.
getEnumTable()
Return the EnumTable for this type (only for enumeration types).
getInspectorFieldType()
Return the name of the GuiInspectorField subclass that fields of this type should use for editing.
getTypeID()
Return the unique numeric ID of this type.
getTypeInfo()
Return the type info for the engine type corresponding to this console type or NULL if there is no mapping for the console type.
getTypeName()
Return the console type name (TypeXXX).
getTypeSize()
Return the size of a single value in bytes.
setInspectorFieldType(const char * type)
Set the name of the GuiInspectorField subclass that fields of this type should use for editing.