Torque Game Engine Documentation
TGE Version 1.5.2

MessageVector Class Reference

#include <messageVector.h>

Inheritance diagram for MessageVector:

Detailed Description

Store a list of chat messages.

This is responsible for managing messages which appear in the chat HUD.

Public Types

enum MessageCode {
  LineInserted = 0,
  LineDeleted = 1,
  VectorDeletion = 2
}

typedef void(*) SpectatorCallback (void *spectatorKey, const MessageCode code, const U32 argument)

Public Member Functions

MessageVector ()

~MessageVector ()

void registerSpectator (SpectatorCallback, void *spectatorKey)

void unregisterSpectator (void *spectatorKey)

U32 getNumLines () const

const MessageLine & getLine (const U32 line) const

void pushBackLine (const char *, const S32)

void popBackLine ()

void pushFrontLine (const char *, const S32)

void popFrontLine ()

void clear ()

virtual void insertLine (const U32 position, const char *, const S32)

virtual void deleteLine (const U32)

bool dump (const char *filename, const char *header=NULL)

DECLARE_CONOBJECT (MessageVector)

Static Public Member Functions

static void initPersistFields ()

Register dynamic fields in a subclass of ConsoleObject.

Protected Member Functions

bool onAdd ()

Called when the object is added to the sim.

void onRemove ()

Called when the object is removed from the sim.

Private Types

typedef SimObject Parent

Private Member Functions

void spectatorMessage (MessageCode, const U32 arg)

Private Attributes

Vector< MessageLine > mMessageLines

Vector< SpectatorRef > mSpectators

Data Structures

struct MessageLine

struct SpectatorRef

typedef SimObject MessageVector::Parent [private]

Reimplemented from SimObject.

typedef void(*) MessageVector::SpectatorCallback(void *spectatorKey, const MessageCode code, const U32 argument)

Enumerator:

MessageVector::MessageVector ( )

MessageVector::~MessageVector ( )

void MessageVector::registerSpectator	(	SpectatorCallback	,
		void *	spectatorKey
	)

void MessageVector::unregisterSpectator ( void * spectatorKey )

U32 MessageVector::getNumLines ( ) const [inline]

const MessageVector::MessageLine & MessageVector::getLine ( const U32 line ) const [inline]

void MessageVector::pushBackLine	(	const char *	,
		const	S32
	)

void MessageVector::popBackLine ( )

void MessageVector::pushFrontLine	(	const char *	,
		const	S32
	)

void MessageVector::popFrontLine ( )

void MessageVector::clear ( )

virtual void MessageVector::insertLine	(	const U32	position,
		const char *	,
		const	S32
	)			`[virtual]`

virtual void MessageVector::deleteLine ( const U32 ) [virtual]

bool MessageVector::onAdd ( ) [protected, virtual]

Called when the object is added to the sim.

Reimplemented from SimObject.

void MessageVector::onRemove ( ) [protected, virtual]

Called when the object is removed from the sim.

Reimplemented from SimObject.

void MessageVector::spectatorMessage	(	MessageCode	,
		const U32	arg
	)			`[private]`

MessageVector::DECLARE_CONOBJECT ( MessageVector )

static void MessageVector::initPersistFields ( ) [static]

See also:: addField(), addFieldV(), addDepricatedField(), addGroup(), endGroup()

Reimplemented from SimObject.