---

GameState Class Reference

#include <GameState.h>

Collaboration diagram for GameState:

[legend]List of all members.

Static Public Methods
vector< Player * > &	players ()
	The global list of players.
vector< MilitaryUnit * > &	units ()
	The global list of military units.
vector< MilitaryUnit * > &	selectedUnits ()
	The list of units currently selected.
vector< City * > &	cities ()
	The global list of cities.
vector< DrawableObject * > &	drawables ()
	The global list of drawable objects. (list of units and cities).
void	addMilitaryUnit (MilitaryUnit *unit)
	Add a unit to the game state.
MilitaryUnit *	getMilitaryUnit (uint uniqueID)
	returns a pointer to the military unit with the uniqueID given or NULL if no unit exists.
void	addCity (City *city)
	Add a city to the game state.
City *	getCity (uint uniqueID)
	returns a pointer to the city with the uniqueID given or NULL if no city exists.
Player *	findPlayer (const Vec3D &teamColor)
	Find a player given the team color.
vector< BattleEntry * > &	battles ()
	The battles happening in the game.
BattleEntry *	activeBattle ()
	The currently active battle.
void	setActiveBattle (BattleEntry *battle)
	Set the active battle.
BattleEntry *	getBattle (uint uniqueID)
	returns a pointer to the battle with the uniqueID given or NULL if no battle exists.
MessagesReceived &	messagesReceived (void)
	For printing chat messages received over the network.
Vec3D &	camTarget ()
	The camera target, the point where the camera is centered.
void	setWorldMap (const Map::WorldMap &map)
	Set the world map, contains bounds the units must be contained in.
const Map::WorldMap &	worldMap ()
Player *	consolePlayer ()
	Gets and sets for the player sitting at the console. i.e. physically at the machine the game is running on.
void	setConsolePlayer (Player *consolePlayer)
ControlMode	controlMode ()
	Get and set for the control mode: NORMAL --> player can only control their side GOD --> player can control all sides.
void	setControlMode (ControlMode mode)
vector< int > &	availableRFM ()
Private Methods
	GameState ()
Static Private Attributes
BattleEntry *	m_activeBattle
Map::WorldMap	m_worldMap
Player *	m_consolePlayer
ControlMode	m_controlMode

---

Constructor & Destructor Documentation

GameState::GameState (    )  [private]

---

Member Function Documentation

BattleEntry * GameState::activeBattle (    )  [static]

The currently active battle. Definition at line 123 of file GameState.cpp. References m_activeBattle. Referenced by BattleGroup::destroyUnit(), Overhead::doCollisionDetection(), BattleGroup::fire(), BattleJets::fireAntiAirMissiles(), BattleJets::fireAntiSurfaceMissiles(), Overhead::overhead_render(), Overhead::overhead_update(), Overhead::processInput(), HUD::processOverheadInput(), HUD::render(), sendReinforcement(), HUD::switchToNextBattle(), HUD::switchToPrevBattle(), BattleJets::takeHit(), and Overhead::updateBattleEntries(). { return m_activeBattle; }

void GameState::addCity (  City *    city )  [static]

Add a city to the game state. Definition at line 70 of file GameState.cpp. References cities(), and drawables(). Referenced by Overhead::loadMap(). { cities().push_back(city); drawables().push_back(city); }

void GameState::addMilitaryUnit (  MilitaryUnit *    unit )  [static]

Add a unit to the game state. Definition at line 54 of file GameState.cpp. References drawables(), and units(). Referenced by Overhead::loadMap(), City::update(), and Overhead::updateBattleEntries(). { units().push_back(unit); drawables().push_back(unit); }

vector< int > & GameState::availableRFM (    )  [static]

Definition at line 171 of file GameState.cpp. Referenced by Overhead::overhead_init(), Overhead::overhead_update(), and HUD::render(). { static vector<int> availableRFMVec; return availableRFMVec; }

vector< BattleEntry * > & GameState::battles (    )  [static]

The battles happening in the game. Definition at line 92 of file GameState.cpp. Referenced by Overhead::doTutorial(), Overhead::doVictoryTest(), getBattle(), Overhead::overheadRender(), HUD::processMiniMapInput(), Overhead::processOverheadInput(), HUD::processOverheadInput(), HUD::renderMiniMap(), HUD::switchToNextBattle(), HUD::switchToPrevBattle(), and Helper::totalUnitsForPlayer(). { static vector<BattleEntry*> theBattles; return theBattles; }

Vec3D & GameState::camTarget (    )  [static]

The camera target, the point where the camera is centered. Definition at line 114 of file GameState.cpp. References Vec3D. Referenced by Overhead::overhead_init(), Overhead::overhead_update(), HUD::processMiniMapInput(), and Overhead::processOverheadInput(). { static Vec3D m_camTarget(0.0f, 0.0f, 0.0f); return m_camTarget; }

vector< City * > & GameState::cities (    )  [static]

The global list of cities. Definition at line 42 of file GameState.cpp. Referenced by addCity(), Overhead::doVictoryTest(), getCity(), Jet::goal(), Overhead::overhead_init(), Globals::OverheadCollisionWithCity(), HUD::renderMiniMap(), Helper::totalCitiesForPlayer(), and Helper::totalUnitsBeingBuiltForPlayer(). { static vector<City*> m_cities; return m_cities; }

Player * GameState::consolePlayer (    )  [static]

Gets and sets for the player sitting at the console. i.e. physically at the machine the game is running on. Definition at line 149 of file GameState.cpp. References m_consolePlayer. Referenced by Overhead::amIInThisBattle(), Overhead::doCollisionDetection(), Overhead::doVictoryTest(), BattleGroup::fire(), BattleEntry::initBattle(), Overhead::overhead_update(), Overhead::processCommand(), NetworkSubsystem::processNetworkData(), Overhead::processOverheadInput(), HUD::processOverheadInput(), HUD::render(), City::trainUnit(), and City::update(). { return m_consolePlayer; }

ControlMode GameState::controlMode (    )  [static]

Get and set for the control mode: NORMAL --> player can only control their side GOD --> player can control all sides. Definition at line 161 of file GameState.cpp. References ControlMode, and m_controlMode. Referenced by BattleEntry::inputSelectGroups(), and Overhead::processOverheadInput(). { return m_controlMode; }

vector< DrawableObject * > & GameState::drawables (    )  [static]

The global list of drawable objects. (list of units and cities). Definition at line 48 of file GameState.cpp. Referenced by addCity(), and addMilitaryUnit(). { static vector<DrawableObject*> m_drawables; return m_drawables; }

Player * GameState::findPlayer (  const Vec3D &    teamColor )  [static]

Find a player given the team color. Definition at line 85 of file GameState.cpp. References players(). Referenced by Overhead::updateBattleEntries(). { for(size_t i=0; i < players().size(); ++i) if( players()[i]->color() == teamColor) return players()[i]; return 0; }

BattleEntry * GameState::getBattle (  uint    uniqueID )  [static]

returns a pointer to the battle with the uniqueID given or NULL if no battle exists. Definition at line 98 of file GameState.cpp. References battles(). { for(vector<BattleEntry*>::iterator iter = battles().begin(); iter != battles().end(); ++iter) { BattleEntry* battle = *iter; if((*iter)->uniqueID() == uniqueID) return *iter; } return 0; }

City * GameState::getCity (  uint    uniqueID )  [static]

returns a pointer to the city with the uniqueID given or NULL if no city exists. Definition at line 76 of file GameState.cpp. References cities(). Referenced by Jet::goal(), Jet::Jet(), Overhead::updateBattleEntries(), and Jet::~Jet(). { for(vector<City*>::iterator iter = cities().begin(); iter != cities().end(); ++iter) { if ((*iter)->uniqueID() == uniqueID) return *iter; } return 0; }

MilitaryUnit * GameState::getMilitaryUnit (  uint    uniqueID )  [static]

returns a pointer to the military unit with the uniqueID given or NULL if no unit exists. : Definition at line 60 of file GameState.cpp. References units(). { for(vector<MilitaryUnit*>::iterator iter = units().begin(); iter != units().end(); ++iter) { if((*iter)->uniqueID() == uniqueID) return *iter; } return 0; }

MessagesReceived & GameState::messagesReceived (  void    )  [static]

For printing chat messages received over the network. Definition at line 108 of file GameState.cpp. Referenced by City::changeOwner(), Overhead::doCollisionDetection(), Overhead::overhead_init(), Overhead::overhead_render(), Overhead::overhead_update(), Overhead::printPlayerList(), Overhead::processCommand(), NetworkSubsystem::processNetworkData(), and City::trainUnit(). { static MessagesReceived theMessagesReceived; return theMessagesReceived; }

vector< Player * > & GameState::players (    )  [static]

The global list of players. Definition at line 24 of file GameState.cpp. Referenced by findPlayer(), Helper::playerNumberToPlayerPointer(), and NetworkSubsystem::processNetworkData(). { static vector<Player*> m_players; return m_players; }

vector< MilitaryUnit * > & GameState::selectedUnits (    )  [static]

The list of units currently selected. Definition at line 36 of file GameState.cpp. Referenced by HUD::processMiniMapInput(). { static vector<MilitaryUnit*> m_selectedUnits; return m_selectedUnits; }

void GameState::setActiveBattle (  BattleEntry *    battle )  [static]

Set the active battle. Definition at line 128 of file GameState.cpp. References m_activeBattle. Referenced by Overhead::doCollisionDetection(), Overhead::overhead_update(), HUD::processMiniMapInput(), Overhead::processOverheadInput(), HUD::switchToNextBattle(), HUD::switchToOverhead(), HUD::switchToPrevBattle(), and Overhead::updateBattleEntries(). { m_activeBattle = battle; }

void GameState::setConsolePlayer (  Player *    consolePlayer )  [static]

Definition at line 154 of file GameState.cpp. References m_consolePlayer. Referenced by Overhead::overhead_init(). { m_consolePlayer = cp; }

void GameState::setControlMode (  ControlMode    mode )  [static]

Definition at line 166 of file GameState.cpp. References m_controlMode. Referenced by Overhead::overhead_init(), and Overhead::processCommand(). { m_controlMode = mode; }

void GameState::setWorldMap (  const Map::WorldMap &    map )  [static]

Set the world map, contains bounds the units must be contained in. Definition at line 136 of file GameState.cpp. References m_worldMap. Referenced by Overhead::loadMap(). { m_worldMap = map; }

vector< MilitaryUnit * > & GameState::units (    )  [static]

The global list of military units. Definition at line 30 of file GameState.cpp. Referenced by addMilitaryUnit(), City::changeOwner(), Overhead::doVictoryTest(), getMilitaryUnit(), Overhead::getSelectedUnits(), Overhead::getSurroundingUnits(), Overhead::overhead_update(), Globals::OverheadCollisonWithIdleUnit(), HUD::renderMiniMap(), sendReinforcement(), Overhead::setSelectedUnits(), Helper::totalUnitsForPlayer(), and Overhead::updateBattleEntries(). { static vector<MilitaryUnit*> m_units; return m_units; }

const Map::WorldMap & GameState::worldMap (    )  [static]

Definition at line 141 of file GameState.cpp. References m_worldMap. Referenced by MilitaryUnit::move(), HUD::processMiniMapInput(), and Overhead::processOverheadInput(). { return m_worldMap; }

---

Member Data Documentation

BattleEntry * GameState::m_activeBattle [static, private]

Definition at line 121 of file GameState.cpp. Referenced by activeBattle(), and setActiveBattle().

Player * GameState::m_consolePlayer [static, private]

Definition at line 147 of file GameState.cpp. Referenced by consolePlayer(), and setConsolePlayer().

ControlMode GameState::m_controlMode [static, private]

Referenced by controlMode(), and setControlMode().

Map::WorldMap GameState::m_worldMap [static, private]

Definition at line 134 of file GameState.cpp. Referenced by setWorldMap(), and worldMap().

---

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

• GameState.h
• GameState.cpp

---