GameMessageList Class Reference

#include <MessageStream.h>

Inherits SubsystemInterface.

Inherited by CommandList, and MessageStream.

Public Member Functions
	GameMessageList (void)
virtual	~GameMessageList ()
virtual void	init (void)
virtual void	reset (void)
	Initialize system.
virtual void	update (void)
	Reset system.
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 Attributes
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 GameMessageList class encapsulates the manipulation of lists of GameMessages. Both MessageStream and CommandList derive from this class.

Definition at line 689 of file MessageStream.h.

Constructor & Destructor Documentation

GameMessageList()

GameMessageList::GameMessageList

(

void

)

Constructor

Definition at line 694 of file MessageStream.cpp.

~GameMessageList()

GameMessageList::~GameMessageList ( )

virtual

Destructor

Definition at line 703 of file MessageStream.cpp.

Member Function Documentation

appendMessage()

void GameMessageList::appendMessage ( GameMessage * msg )

virtual

Add message to end of the list.

Append message to end of message list

Definition at line 720 of file MessageStream.cpp.

containsMessageOfType()

Bool GameMessageList::containsMessageOfType ( GameMessage::Type type )

virtual

Return true if a message of type is in the message stream.

Return whether or not a message of the given type is in the message list

Definition at line 787 of file MessageStream.cpp.

getFirstMessage()

GameMessage * GameMessageList::getFirstMessage ( void )

inline

Update system.

Return the first message

Definition at line 701 of file MessageStream.h.

init()

virtual void GameMessageList::init ( void )

inlinevirtual

• Assign any default values to data required for the class
  • Allocate any memory and resources needed throughout the lifetime of the class

Implements SubsystemInterface.

Reimplemented in CommandList, and MessageStream.

Definition at line 697 of file MessageStream.h.

insertMessage()

void GameMessageList::insertMessage ( GameMessage * msg, GameMessage * messageToInsertAfter )

virtual

Inserts the msg after messageToInsertAfter.

Definition at line 745 of file MessageStream.cpp.

removeMessage()

void GameMessageList::removeMessage ( GameMessage * msg )

virtual

Remove message from the list.

Remove given message from the list.

Definition at line 769 of file MessageStream.cpp.

reset()

virtual void GameMessageList::reset ( void )

inlinevirtual

Initialize system.

Implements SubsystemInterface.

Reimplemented in CommandList, and MessageStream.

Definition at line 698 of file MessageStream.h.

update()

virtual void GameMessageList::update ( void )

inlinevirtual

Reset system.

Implements SubsystemInterface.

Reimplemented in CommandList, and MessageStream.

Definition at line 699 of file MessageStream.h.

Member Data Documentation

m_firstMessage

GameMessage* GameMessageList::m_firstMessage

protected

The first message on the list.

Definition at line 711 of file MessageStream.h.

m_lastMessage

GameMessage* GameMessageList::m_lastMessage

protected

The last message on the list.

Definition at line 712 of file MessageStream.h.

---

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

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