CommandList Class Reference

#include <MessageStream.h>

Inherits GameMessageList.

Public Member Functions
	CommandList (void)
virtual	~CommandList ()
virtual void	init (void)
	Init command list.
virtual void	reset (void)
	Destroy all messages and reset list to empty.
virtual void	update (void)
	Update hook.
void	appendMessageList (GameMessage *list)
	Adds messages to the end of the command list.
Public Member Functions inherited from GameMessageList
	GameMessageList (void)
virtual	~GameMessageList ()
GameMessage *	getFirstMessage (void)
	Update system.
virtual void	appendMessage (GameMessage *msg)
	Add message to end of the list.
virtual void	insertMessage (GameMessage *msg, GameMessage *messageToInsertAfter)
virtual void	removeMessage (GameMessage *msg)
	Remove message from the list.
virtual Bool	containsMessageOfType (GameMessage::Type type)
	Return true if a message of type is in the message stream.
Public Member Functions inherited from SubsystemInterface
	SubsystemInterface ()
virtual	~SubsystemInterface ()
virtual void	postProcessLoad ()
virtual void	draw (void)
void	UPDATE (void)
void	DRAW (void)
AsciiString	getName (void)
void	setName (AsciiString name)

Protected Member Functions
void	destroyAllMessages (void)
	The meat of a reset and a shutdown.

Additional Inherited Members
Protected Attributes inherited from GameMessageList
GameMessage *	m_firstMessage
	The first message on the list.
GameMessage *	m_lastMessage
	The last message on the list.
Protected Attributes inherited from SubsystemInterface
AsciiString	m_name

Detailed Description

The CommandList is the final set of messages that have made their way through all of the Translators of the MessageStream, and reached the end. This set of commands will be executed by the GameLogic on its next iteration.

Definition at line 794 of file MessageStream.h.

Constructor & Destructor Documentation

CommandList()

CommandList::CommandList

(

void

)

Constructor

Definition at line 1126 of file MessageStream.cpp.

~CommandList()

CommandList::~CommandList ( )

virtual

Destructor

Definition at line 1133 of file MessageStream.cpp.

Member Function Documentation

appendMessageList()

void CommandList::appendMessageList

(

GameMessage *

list

)

Adds messages to the end of the command list.

Adds messages to the end of TheCommandList. Primarily used by TheMessageStream to put the final messages that reach the end of the stream on TheCommandList. Since TheGameClient will update faster than TheNetwork and TheGameLogic, messages will accumulate on this list.

Definition at line 1199 of file MessageStream.cpp.

destroyAllMessages()

void CommandList::destroyAllMessages ( void )

protected

The meat of a reset and a shutdown.

Destroy all messages on the command list, this will get called from the destructor and reset methods, DO NOT throw exceptions

Definition at line 1178 of file MessageStream.cpp.

init()

void CommandList::init ( void )

virtual

Init command list.

Init

Reimplemented from GameMessageList.

Definition at line 1141 of file MessageStream.cpp.

reset()

void CommandList::reset ( void )

virtual

Destroy all messages and reset list to empty.

Destroy all messages on the list, and reset list to empty

Reimplemented from GameMessageList.

Definition at line 1152 of file MessageStream.cpp.

update()

void CommandList::update ( void )

virtual

Update hook.

Update

Reimplemented from GameMessageList.

Definition at line 1166 of file MessageStream.cpp.

---

The documentation for this class was generated from the following files:

• Code/GameEngine/Include/Common/MessageStream.h
• Code/GameEngine/Source/Common/MessageStream.cpp