TerrainTypeCollection Class Reference

#include <TerrainTypes.h>

Inherits SubsystemInterface.

Public Member Functions
	TerrainTypeCollection (void)
	~TerrainTypeCollection (void)
void	init ()
void	reset ()
void	update ()
TerrainType *	findTerrain (AsciiString name)
	find terrain by name
TerrainType *	newTerrain (AsciiString name)
	allocate a new terrain
TerrainType *	firstTerrain (void)
	get first terrain in list
TerrainType *	nextTerrain (TerrainType *terrainType)
	get next terrain in list
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
TerrainType *	m_terrainList
	list of available terrain types
Protected Attributes inherited from SubsystemInterface
AsciiString	m_name

Detailed Description

The collection of all terrain types

Definition at line 217 of file TerrainTypes.h.

Constructor & Destructor Documentation

TerrainTypeCollection()

TerrainTypeCollection::TerrainTypeCollection

(

void

)

Definition at line 81 of file TerrainTypes.cpp.

~TerrainTypeCollection()

TerrainTypeCollection::~TerrainTypeCollection

(

void

)

Definition at line 90 of file TerrainTypes.cpp.

Member Function Documentation

findTerrain()

TerrainType * TerrainTypeCollection::findTerrain

(

AsciiString

name

)

find terrain by name

Find a terrain type given the name

Definition at line 114 of file TerrainTypes.cpp.

firstTerrain()

TerrainType * TerrainTypeCollection::firstTerrain ( void )

inline

get first terrain in list

Definition at line 233 of file TerrainTypes.h.

init()

void TerrainTypeCollection::init ( )

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 225 of file TerrainTypes.h.

newTerrain()

TerrainType * TerrainTypeCollection::newTerrain

(

AsciiString

name

)

allocate a new terrain

Allocate a new type, assign the name, and tie to type list

Definition at line 134 of file TerrainTypes.cpp.

nextTerrain()

TerrainType * TerrainTypeCollection::nextTerrain ( TerrainType * terrainType )

inline

get next terrain in list

Definition at line 236 of file TerrainTypes.h.

reset()

void TerrainTypeCollection::reset ( )

inlinevirtual

• 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 226 of file TerrainTypes.h.

update()

void TerrainTypeCollection::update ( )

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 227 of file TerrainTypes.h.

Member Data Documentation

m_terrainList

TerrainType* TerrainTypeCollection::m_terrainList

protected

list of available terrain types

Definition at line 240 of file TerrainTypes.h.

---

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

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