Torque Game Engine Documentation
TGE Version 1.5.2

ConsoleBaseType Class Reference

#include <dynamicTypes.h>

cbt_list List Interface

Interface for accessing/traversing the list of types.

static ConsoleBaseType * getListHead ()

Get the head of the list.

static void initialize ()

Called once to initialize the console type system.

static ConsoleBaseType * getType (const S32 typeID)

Call me to get a pointer to a type's info.

ConsoleBaseType * getListNext () const

Get the item that follows this item in the list.

Public Member 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.

const S32 getTypeID () const

const S32 getTypeSize () const

const char * getTypeName () const

void setInspectorFieldType (const char *type)

const char * getInspectorFieldType ()

virtual void setData (void *dptr, S32 argc, const char **argv, EnumTable *tbl, BitSet32 flag)=0

virtual const char * getData (void *dptr, EnumTable *tbl, BitSet32 flag)=0

virtual const char * getTypeClassName ()=0

virtual const bool isDatablock ()

virtual const char * prepData (const char *data, char *buffer, U32 bufferLen)

Protected Member Functions

~ConsoleBaseType ()

Destructor is private to avoid people mucking up the list.

Protected Attributes

ConsoleBaseType * mListNext

Next item in the list of all console types.

S32 mTypeID

dsize_t mTypeSize

const char * mTypeName

const char * mInspectorFieldType

Static Protected Attributes

static S32 smConsoleTypeCount

This is used to generate unique IDs for each type.

static ConsoleBaseType * smListHead

We maintain a linked list of all console types; this is its head.

Constructor & Destructor Documentation

ConsoleBaseType::~ConsoleBaseType ( ) [protected]

Destructor is private to avoid people mucking up the list.

ConsoleBaseType::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.

Member Function Documentation

static ConsoleBaseType* ConsoleBaseType::getListHead ( ) [static]

Get the head of the list.

ConsoleBaseType* ConsoleBaseType::getListNext ( ) const [inline]

Get the item that follows this item in the list.

static void ConsoleBaseType::initialize ( ) [static]

Called once to initialize the console type system.

static ConsoleBaseType* ConsoleBaseType::getType ( const S32 typeID ) [static]

Call me to get a pointer to a type's info.

const S32 ConsoleBaseType::getTypeID ( ) const [inline]

const S32 ConsoleBaseType::getTypeSize ( ) const [inline]

const char* ConsoleBaseType::getTypeName ( ) const [inline]

void ConsoleBaseType::setInspectorFieldType ( const char * type ) [inline]

const char* ConsoleBaseType::getInspectorFieldType ( ) [inline]

virtual void ConsoleBaseType::setData	(	void *	dptr,
		S32	argc,
		const char **	argv,
		EnumTable *	tbl,
		BitSet32	flag
	)			`[pure virtual]`

virtual const char* ConsoleBaseType::getData	(	void *	dptr,
		EnumTable *	tbl,
		BitSet32	flag
	)			`[pure virtual]`

virtual const char* ConsoleBaseType::getTypeClassName ( ) [pure virtual]

virtual const bool ConsoleBaseType::isDatablock ( ) [inline, virtual]

virtual const char* ConsoleBaseType::prepData	(	const char *	data,
		char *	buffer,
		U32	bufferLen
	)			`[inline, virtual]`

Field Documentation

S32 ConsoleBaseType::smConsoleTypeCount [static, protected]

This is used to generate unique IDs for each type.

ConsoleBaseType* ConsoleBaseType::smListHead [static, protected]

We maintain a linked list of all console types; this is its head.

ConsoleBaseType* ConsoleBaseType::mListNext [protected]

Next item in the list of all console types.

S32 ConsoleBaseType::mTypeID [protected]

dsize_t ConsoleBaseType::mTypeSize [protected]

const char* ConsoleBaseType::mTypeName [protected]

const char* ConsoleBaseType::mInspectorFieldType [protected]