MessageVector

Engine/source/gui/utility/messageVector.h

Store a list of chat messages.

More...

Classes:

Public Types

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

Private Types

Parent 

Private Attributes

Protected Functions

bool

Called when the object is added to the sim.

Called when the object is removed from the sim.

Private Functions

Public Static Functions

Detailed Description

Store a list of chat messages.

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

see:

GuiMessageVectorCtrl for more details on how this is used.

Public Types

MessageCode

Enumerator

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

Private Types

typedef SimObject Parent 

Private Attributes

Vector< MessageLine > mMessageLines 
Vector< SpectatorRef > mSpectators 

Public Functions

MessageVector()

~MessageVector()

clear()

DECLARE_CONOBJECT(MessageVector )

deleteLine(const U32)

dump(const char * filename, const char * header)

getLine(const U32 line)

getNumLines()

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

popBackLine()

popFrontLine()

pushBackLine(const char * , const S32)

pushFrontLine(const char * , const S32)

registerSpectator(SpectatorCallback , void * spectatorKey)

unregisterSpectator(void * spectatorKey)

Protected Functions

onAdd()

Reimplemented from: SimObject

onRemove()

Reimplemented from: SimObject

Private Functions

spectatorMessage(MessageCode , const U32 arg)

Public Static Functions

initPersistFields()