MessageVector Class Reference

#include <messageVector.h>

Inheritance diagram for MessageVector:

Inheritance graph
[legend]
List of all members.

Detailed Description

Store a list of chat messages.

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

See also:
GuiMessageVectorCtrl for more details on how this is used.


Public Types

typedef void(*) SpectatorCallback (void *spectatorKey, const MessageCode code, const U32 argument)
 LineInserted = 0
 LineDeleted = 1
 VectorDeletion = 2
enum  MessageCode {
  LineInserted = 0,
  LineDeleted = 1,
  VectorDeletion = 2
}

Public Member Functions

 MessageVector ()
 ~MessageVector ()
void registerSpectator (SpectatorCallback, void *spectatorKey)
void unregisterSpectator (void *spectatorKey)
U32 getNumLines () const
const MessageLinegetLine (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< MessageLinemMessageLines
Vector< SpectatorRefmSpectators

Classes

struct  MessageLine
struct  SpectatorRef


Member Typedef Documentation

typedef SimObject MessageVector::Parent [private]

Reimplemented from SimObject.

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


Member Enumeration Documentation

Enumerator:
LineInserted 
LineDeleted 
VectorDeletion 


Constructor & Destructor Documentation

MessageVector::MessageVector (  ) 

MessageVector::~MessageVector (  ) 


Member Function Documentation

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::dump ( const char *  filename,
const char *  header = NULL 
)

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]

Register dynamic fields in a subclass of ConsoleObject.

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

Reimplemented from SimObject.


Member Data Documentation