SidesInfo Class Reference

#include <SidesList.h>

Public Member Functions
	SidesInfo (void)
	SidesInfo (const SidesInfo &thatref)
	~SidesInfo (void)
void	init (const Dict *d)
void	clear ()
Dict *	getDict ()
void	addToBuildList (BuildListInfo *pBuildList, Int position)
Int	removeFromBuildList (BuildListInfo *pBuildList)
void	reorderInBuildList (BuildListInfo *pBuildList, Int newPosition)
BuildListInfo *	getBuildList (void)
	Gets the build list.
void	releaseBuildList (void)
	Used when the build list is passed to class Player.
ScriptList *	getScriptList (void)
void	setScriptList (ScriptList *pScriptList)
SidesInfo &	operator= (const SidesInfo &that)

Protected Attributes
BuildListInfo *	m_pBuildList
	linked list.
Dict	m_dict
	general player dict.
ScriptList *	m_scripts
	linked list.

Detailed Description

This is a class that describes a Side, including build list. Note that a side corresponds to a Player in the game. The lightweight Side is used to give the WB Editor somewhere to hang build lists.

Definition at line 56 of file SidesList.h.

Constructor & Destructor Documentation

SidesInfo() [1/2]

SidesInfo::SidesInfo

(

void

)

SidesInfo - Constructor.

Definition at line 65 of file SidesList.cpp.

SidesInfo() [2/2]

SidesInfo::SidesInfo

(

const SidesInfo &

thatref

)

Definition at line 71 of file SidesList.cpp.

~SidesInfo()

SidesInfo::~SidesInfo

(

void

)

SidesInfo - Destructor -

Definition at line 81 of file SidesList.cpp.

Member Function Documentation

addToBuildList()

void SidesInfo::addToBuildList	(	BuildListInfo *	pBuildList,
		Int	position )

SidesInfo::addToBuildList - Adds a build list entry as the nth entry.

Definition at line 133 of file SidesList.cpp.

clear()

void SidesInfo::clear ( )

inline

Definition at line 68 of file SidesList.h.

getBuildList()

BuildListInfo * SidesInfo::getBuildList ( void )

inline

Gets the build list.

Definition at line 73 of file SidesList.h.

getDict()

Dict * SidesInfo::getDict ( )

inline

Definition at line 69 of file SidesList.h.

getScriptList()

ScriptList * SidesInfo::getScriptList ( void )

inline

Definition at line 75 of file SidesList.h.

init()

void SidesInfo::init

(

const Dict *

d

)

Definition at line 86 of file SidesList.cpp.

operator=()

SidesInfo & SidesInfo::operator=

(

const SidesInfo &

that

)

Definition at line 99 of file SidesList.cpp.

releaseBuildList()

void SidesInfo::releaseBuildList ( void )

inline

Used when the build list is passed to class Player.

Definition at line 74 of file SidesList.h.

removeFromBuildList()

Int SidesInfo::removeFromBuildList

(

BuildListInfo *

pBuildList

)

SidesInfo::removeFromBuildList - Removes a build list entry. Returns the position in the list that the item occupied.

Definition at line 174 of file SidesList.cpp.

reorderInBuildList()

void SidesInfo::reorderInBuildList	(	BuildListInfo *	pBuildList,
		Int	newPosition )

SidesInfo::reorderInBuildList - Reorders a build list entry as the nth entry.

Definition at line 163 of file SidesList.cpp.

setScriptList()

void SidesInfo::setScriptList ( ScriptList * pScriptList )

inline

Definition at line 76 of file SidesList.h.

Member Data Documentation

m_dict

Dict SidesInfo::m_dict

protected

general player dict.

Definition at line 60 of file SidesList.h.

m_pBuildList

BuildListInfo* SidesInfo::m_pBuildList

protected

linked list.

Definition at line 59 of file SidesList.h.

m_scripts

ScriptList* SidesInfo::m_scripts

protected

linked list.

Definition at line 61 of file SidesList.h.

---

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

• Code/GameEngine/Include/GameLogic/SidesList.h
• Code/GameEngine/Source/GameLogic/Map/SidesList.cpp