Torque Game Engine Documentation
TGE Version 1.5.2

engine/console/consoleObject.h File Reference

#include "platform/platform.h"
#include "core/tVector.h"
#include "core/stringTable.h"
#include "core/bitSet.h"
#include "console/console.h"

Data Structures

class AbstractClassRep

Core functionality for class manipulation. More...

struct AbstractClassRep::Field

class ConcreteClassRep< T >

Helper class for AbstractClassRep. More...

class ConsoleObject

Interface class to the console. More...

Defines

#define addNamedField(fieldName, type, className)   addField(#fieldName, type, Offset(fieldName,className))

#define addNamedFieldV(fieldName, type, className, validator)   addFieldV(#fieldName, type, Offset(fieldName,className), validator)

ConsoleObject Macros

#define DECLARE_CONOBJECT(className)

#define IMPLEMENT_CONOBJECT(className)

#define IMPLEMENT_CO_NETOBJECT_V1(className)

#define IMPLEMENT_CO_DATABLOCK_V1(className)

Enumerations

enum NetClassTypes {
  NetClassTypeObject = 0,
  NetClassTypeDataBlock,
  NetClassTypeEvent,
  NetClassTypesCount
}

enum NetClassGroups {
  NetClassGroupGame = 0,
  NetClassGroupCommunity,
  NetClassGroup3,
  NetClassGroup4,
  NetClassGroupsCount
}

enum NetClassMasks {
  NetClassGroupGameMask = BIT(NetClassGroupGame),
  NetClassGroupCommunityMask = BIT(NetClassGroupCommunity)
}

enum NetDirection {
  NetEventDirAny,
  NetEventDirServerToClient,
  NetEventDirClientToServer
}

Functions

const char * defaultProtectedGetFn (void *obj, const char *data)

bool defaultProtectedSetFn (void *obj, const char *data)

Define Documentation

#define addNamedField	(	fieldName,
		type,
		className	)	addField(#fieldName, type, Offset(fieldName,className))

#define addNamedFieldV	(	fieldName,
		type,
		className,
		validator	)	addFieldV(#fieldName, type, Offset(fieldName,className), validator)

#define DECLARE_CONOBJECT ( className )

Value:

static ConcreteClassRep<className> dynClassRep;      \
   static AbstractClassRep* getParentStaticClassRep();  \
   static AbstractClassRep* getStaticClassRep();        \
   virtual AbstractClassRep* getClassRep() const

#define IMPLEMENT_CONOBJECT ( className )

Value:

AbstractClassRep* className::getClassRep() const { return &className::dynClassRep; }           \
   AbstractClassRep* className::getStaticClassRep() { return &dynClassRep; }                      \
   AbstractClassRep* className::getParentStaticClassRep() { return Parent::getStaticClassRep(); } \
   ConcreteClassRep<className> className::dynClassRep(#className, 0, -1, 0, className::getParentStaticClassRep())

#define IMPLEMENT_CO_NETOBJECT_V1 ( className )

Value:

AbstractClassRep* className::getClassRep() const { return &className::dynClassRep; }                 \
   AbstractClassRep* className::getStaticClassRep() { return &dynClassRep; }                            \
   AbstractClassRep* className::getParentStaticClassRep() { return Parent::getStaticClassRep(); }       \
   ConcreteClassRep<className> className::dynClassRep(#className, NetClassGroupGameMask, NetClassTypeObject, 0, className::getParentStaticClassRep())

#define IMPLEMENT_CO_DATABLOCK_V1 ( className )

Value:

AbstractClassRep* className::getClassRep() const { return &className::dynClassRep; }                 \
   AbstractClassRep* className::getStaticClassRep() { return &dynClassRep; }                            \
   AbstractClassRep* className::getParentStaticClassRep() { return Parent::getStaticClassRep(); }       \
   ConcreteClassRep<className> className::dynClassRep(#className, NetClassGroupGameMask, NetClassTypeDataBlock, 0, className::getParentStaticClassRep())

Enumeration Type Documentation

enum NetClassTypes

Enumerator:

NetClassTypeObject
NetClassTypeDataBlock
NetClassTypeEvent
NetClassTypesCount

enum NetClassGroups

Enumerator:

NetClassGroupGame
NetClassGroupCommunity
NetClassGroup3
NetClassGroup4
NetClassGroupsCount

enum NetClassMasks

Enumerator:

NetClassGroupGameMask
NetClassGroupCommunityMask

enum NetDirection

Enumerator:

NetEventDirAny
NetEventDirServerToClient
NetEventDirClientToServer

Function Documentation

const char * defaultProtectedGetFn	(	void *	obj,
		const char *	data
	)			`[inline]`

bool defaultProtectedSetFn	(	void *	obj,
		const char *	data
	)			`[inline]`