MultiplayerSettings Class Reference

#include <MultiplayerSettings.h>

Inherits SubsystemInterface.

Public Member Functions
	MultiplayerSettings (void)
virtual void	init ()
virtual void	update ()
virtual void	reset ()
const FieldParse *	getFieldParse (void) const
MultiplayerColorDefinition *	findMultiplayerColorDefinitionByName (AsciiString name)
MultiplayerColorDefinition *	newMultiplayerColorDefinition (AsciiString name)
Int	getStartCountdownTimerSeconds (void)
Int	getMaxBeaconsPerPlayer (void)
Bool	isShroudInMultiplayer (void)
Bool	showRandomPlayerTemplate (void)
Bool	showRandomStartPos (void)
Bool	showRandomColor (void)
Int	getNumColors (void)
MultiplayerColorDefinition *	getColor (Int which)
const Money &	getDefaultStartingMoney () const
const MultiplayerStartingMoneyList &	getStartingMoneyList () const
void	addStartingMoneyChoice (const Money &money, Bool isDefault)
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 Attributes
static const FieldParse	m_multiplayerSettingsFieldParseTable []
	the parse table for INI definition

Additional Inherited Members
Protected Attributes inherited from SubsystemInterface
AsciiString	m_name

Detailed Description

Multiplayer Settings container class Defines multiplayer settings

Definition at line 80 of file MultiplayerSettings.h.

Constructor & Destructor Documentation

MultiplayerSettings()

MultiplayerSettings::MultiplayerSettings

(

void

)

Definition at line 72 of file MultiplayerSettings.cpp.

Member Function Documentation

addStartingMoneyChoice()

void MultiplayerSettings::addStartingMoneyChoice	(	const Money &	money,
		Bool	isDefault )

Definition at line 143 of file MultiplayerSettings.cpp.

findMultiplayerColorDefinitionByName()

MultiplayerColorDefinition * MultiplayerSettings::findMultiplayerColorDefinitionByName

(

AsciiString

name

)

Definition at line 117 of file MultiplayerSettings.cpp.

getColor()

MultiplayerColorDefinition * MultiplayerSettings::getColor

(

Int

which

)

Definition at line 99 of file MultiplayerSettings.cpp.

getDefaultStartingMoney()

const Money & MultiplayerSettings::getDefaultStartingMoney ( ) const

inline

Definition at line 115 of file MultiplayerSettings.h.

getFieldParse()

const FieldParse * MultiplayerSettings::getFieldParse ( void ) const

inline

Definition at line 92 of file MultiplayerSettings.h.

getMaxBeaconsPerPlayer()

Int MultiplayerSettings::getMaxBeaconsPerPlayer ( void )

inline

Definition at line 99 of file MultiplayerSettings.h.

getNumColors()

Int MultiplayerSettings::getNumColors ( void )

inline

Definition at line 105 of file MultiplayerSettings.h.

getStartCountdownTimerSeconds()

Int MultiplayerSettings::getStartCountdownTimerSeconds ( void )

inline

Definition at line 98 of file MultiplayerSettings.h.

getStartingMoneyList()

const MultiplayerStartingMoneyList & MultiplayerSettings::getStartingMoneyList ( ) const

inline

Definition at line 121 of file MultiplayerSettings.h.

init()

virtual void MultiplayerSettings::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 86 of file MultiplayerSettings.h.

isShroudInMultiplayer()

Bool MultiplayerSettings::isShroudInMultiplayer ( void )

inline

Definition at line 100 of file MultiplayerSettings.h.

newMultiplayerColorDefinition()

MultiplayerColorDefinition * MultiplayerSettings::newMultiplayerColorDefinition

(

AsciiString

name

)

Definition at line 132 of file MultiplayerSettings.cpp.

reset()

virtual void MultiplayerSettings::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 88 of file MultiplayerSettings.h.

showRandomColor()

Bool MultiplayerSettings::showRandomColor ( void )

inline

Definition at line 103 of file MultiplayerSettings.h.

showRandomPlayerTemplate()

Bool MultiplayerSettings::showRandomPlayerTemplate ( void )

inline

Definition at line 101 of file MultiplayerSettings.h.

showRandomStartPos()

Bool MultiplayerSettings::showRandomStartPos ( void )

inline

Definition at line 102 of file MultiplayerSettings.h.

update()

virtual void MultiplayerSettings::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 87 of file MultiplayerSettings.h.

Member Data Documentation

m_multiplayerSettingsFieldParseTable

const FieldParse MultiplayerSettings::m_multiplayerSettingsFieldParseTable

static

Initial value:

= 
{
 
    { "StartCountdownTimer",            INI::parseInt, NULL,   offsetof( MultiplayerSettings, m_startCountdownTimerSeconds ) },
    { "MaxBeaconsPerPlayer",            INI::parseInt, NULL,   offsetof( MultiplayerSettings, m_maxBeaconsPerPlayer ) },
    { "UseShroud",                              INI::parseBool,   NULL,   offsetof( MultiplayerSettings, m_isShroudInMultiplayer ) },
    { "ShowRandomPlayerTemplate",   INI::parseBool,   NULL,   offsetof( MultiplayerSettings, m_showRandomPlayerTemplate ) },
    { "ShowRandomStartPos",             INI::parseBool,   NULL,   offsetof( MultiplayerSettings, m_showRandomStartPos ) },
    { "ShowRandomColor",                    INI::parseBool,   NULL,   offsetof( MultiplayerSettings, m_showRandomColor ) },
 
    { NULL,                 NULL,                       NULL,                       0 }  
 
}

the parse table for INI definition

Definition at line 56 of file MultiplayerSettings.h.

---

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

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