SpecialPowerStore Class Reference

#include <SpecialPower.h>

Inherits SubsystemInterface.

Public Member Functions
	SpecialPowerStore (void)
	~SpecialPowerStore (void)
virtual void	init (void)
virtual void	update (void)
virtual void	reset (void)
const SpecialPowerTemplate *	findSpecialPowerTemplate (AsciiString name)
const SpecialPowerTemplate *	findSpecialPowerTemplateByID (UnsignedInt id)
const SpecialPowerTemplate *	getSpecialPowerTemplateByIndex (UnsignedInt index)
Bool	canUseSpecialPower (Object *obj, const SpecialPowerTemplate *specialPowerTemplate)
	does the object (and therefore the player) meet all the requirements to use this power
Int	getNumSpecialPowers (void)
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)

Static Public Member Functions
static void	parseSpecialPowerDefinition (INI *ini)

Protected Types
typedef std::vector< SpecialPowerTemplate * >	SpecialPowerTemplatePtrVector

Protected Member Functions
SpecialPowerTemplate *	findSpecialPowerTemplatePrivate (AsciiString name)

Protected Attributes
SpecialPowerTemplatePtrVector	m_specialPowerTemplates
	the special power templates
UnsignedInt	m_nextSpecialPowerID
Protected Attributes inherited from SubsystemInterface
AsciiString	m_name

Detailed Description

Definition at line 157 of file SpecialPower.h.

Member Typedef Documentation

SpecialPowerTemplatePtrVector

typedef std::vector<SpecialPowerTemplate *> SpecialPowerStore::SpecialPowerTemplatePtrVector

protected

Definition at line 185 of file SpecialPower.h.

Constructor & Destructor Documentation

SpecialPowerStore()

SpecialPowerStore::SpecialPowerStore

(

void

)

Definition at line 245 of file SpecialPower.cpp.

~SpecialPowerStore()

SpecialPowerStore::~SpecialPowerStore

(

void

)

Definition at line 254 of file SpecialPower.cpp.

Member Function Documentation

canUseSpecialPower()

Bool SpecialPowerStore::canUseSpecialPower	(	Object *	obj,
		const SpecialPowerTemplate *	specialPowerTemplate )

does the object (and therefore the player) meet all the requirements to use this power

does the object (and therefore the player) meet all the requirements to use this power

Definition at line 324 of file SpecialPower.cpp.

findSpecialPowerTemplate()

const SpecialPowerTemplate * SpecialPowerStore::findSpecialPowerTemplate ( AsciiString name )

inline

Definition at line 169 of file SpecialPower.h.

findSpecialPowerTemplateByID()

const SpecialPowerTemplate * SpecialPowerStore::findSpecialPowerTemplateByID

(

UnsignedInt

id

)

Find a special power template given unique ID

Definition at line 286 of file SpecialPower.cpp.

findSpecialPowerTemplatePrivate()

SpecialPowerTemplate * SpecialPowerStore::findSpecialPowerTemplatePrivate ( AsciiString name )

protected

Definition at line 271 of file SpecialPower.cpp.

getNumSpecialPowers()

Int SpecialPowerStore::getNumSpecialPowers

(

void

)

Return the size of the store (WB)

Definition at line 314 of file SpecialPower.cpp.

getSpecialPowerTemplateByIndex()

const SpecialPowerTemplate * SpecialPowerStore::getSpecialPowerTemplateByIndex

(

UnsignedInt

index

)

Find a special power template given index (WB)

Definition at line 301 of file SpecialPower.cpp.

init()

virtual void SpecialPowerStore::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.

Definition at line 165 of file SpecialPower.h.

parseSpecialPowerDefinition()

void SpecialPowerStore::parseSpecialPowerDefinition ( INI * ini )

static

Definition at line 141 of file SpecialPower.cpp.

reset()

void SpecialPowerStore::reset ( void )

virtual

Reset

Implements SubsystemInterface.

Definition at line 366 of file SpecialPower.cpp.

update()

virtual void SpecialPowerStore::update ( void )

inlinevirtual

• Update methods are the place to do system per frame processing. You should call the system update once each time through the game loop to service the system.
  • Note that currently the GameClient and GameLogic will be updating at different rates where the logic is running real time, and the client will adjust how many loops can be done during one server time slice in order to improve performance on low end machines.

Implements SubsystemInterface.

Definition at line 166 of file SpecialPower.h.

Member Data Documentation

m_nextSpecialPowerID

UnsignedInt SpecialPowerStore::m_nextSpecialPowerID

protected

Definition at line 188 of file SpecialPower.h.

m_specialPowerTemplates

SpecialPowerTemplatePtrVector SpecialPowerStore::m_specialPowerTemplates

protected

the special power templates

Definition at line 186 of file SpecialPower.h.

---

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

• Code/GameEngine/Include/Common/SpecialPower.h
• Code/GameEngine/Source/Common/RTS/SpecialPower.cpp