PlayerTemplateStore Class Reference

#include <PlayerTemplate.h>

Inherits SubsystemInterface.

Public Member Functions
	PlayerTemplateStore ()
	~PlayerTemplateStore ()
virtual void	init ()
virtual void	reset ()
virtual void	update ()
const PlayerTemplate *	getNthPlayerTemplate (Int i) const
const PlayerTemplate *	findPlayerTemplate (NameKeyType namekey) const
Int	getPlayerTemplateCount () const
Int	getTemplateNumByName (AsciiString name) const
void	getAllSideStrings (AsciiStringList *outStringList)
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	parsePlayerTemplateDefinition (INI *ini)

Additional Inherited Members
Protected Attributes inherited from SubsystemInterface
AsciiString	m_name

Detailed Description

This is a singleton class that maintains the list of PlayerTemplates.

Definition at line 206 of file PlayerTemplate.h.

Constructor & Destructor Documentation

PlayerTemplateStore()

PlayerTemplateStore::PlayerTemplateStore

(

)

Definition at line 264 of file PlayerTemplate.cpp.

~PlayerTemplateStore()

PlayerTemplateStore::~PlayerTemplateStore

(

)

Definition at line 270 of file PlayerTemplate.cpp.

Member Function Documentation

findPlayerTemplate()

const PlayerTemplate * PlayerTemplateStore::findPlayerTemplate

(

NameKeyType

namekey

)

const

Definition at line 307 of file PlayerTemplate.cpp.

getAllSideStrings()

void PlayerTemplateStore::getAllSideStrings

(

AsciiStringList *

outStringList

)

Definition at line 363 of file PlayerTemplate.cpp.

getNthPlayerTemplate()

const PlayerTemplate * PlayerTemplateStore::getNthPlayerTemplate

(

Int

i

)

const

Definition at line 351 of file PlayerTemplate.cpp.

getPlayerTemplateCount()

Int PlayerTemplateStore::getPlayerTemplateCount ( ) const

inline

Definition at line 221 of file PlayerTemplate.h.

getTemplateNumByName()

Int PlayerTemplateStore::getTemplateNumByName

(

AsciiString

name

)

const

Definition at line 295 of file PlayerTemplate.cpp.

init()

void PlayerTemplateStore::init ( )

virtual

• 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 276 of file PlayerTemplate.cpp.

parsePlayerTemplateDefinition()

void PlayerTemplateStore::parsePlayerTemplateDefinition ( INI * ini )

static

Definition at line 392 of file PlayerTemplate.cpp.

reset()

void PlayerTemplateStore::reset ( )

virtual

• Any system should be able to reset all data and go back to an empty state that is ready to accept a completely new set of data. Reset() can expect to be used in the context of resetting the engine in order to start or load a new game.
  • Do NOT free and re-allocate resources needed, where possible reorganize and re-initialize the resources already allocated.
  • After a reset, the system does not need to be in EXACTLY the same state as a fresh instantiation. If there are persistent state information for the system make sure you maintain it while restoring or re-initializing other transient parts.

Implements SubsystemInterface.

Definition at line 282 of file PlayerTemplate.cpp.

update()

void PlayerTemplateStore::update ( )

virtual

• 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 289 of file PlayerTemplate.cpp.

---

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

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