#include </home/jenkins/workspace/orxonox_doxygen_trunk/src/orxonox/gametypes/Gametype.h>

Inheritance diagram for orxonox::Gametype:

Public Member Functions
	Gametype (Context *context)

virtual	~Gametype ()

virtual void	addBots (unsigned int amount)

virtual void	addTime (float t)

virtual bool	allowPawnDamage (Pawn victim, Pawn originator=nullptr)

virtual bool	allowPawnDeath (Pawn victim, Pawn originator=nullptr)

virtual bool	allowPawnHit (Pawn victim, Pawn originator=nullptr)

virtual void	end ()

const GametypeInfo *	getGametypeInfo () const

const std::string &	getHUDTemplate () const

unsigned int	getNumberOfPlayers () const
	Get number of Players in game. More...

const std::map< PlayerInfo *, Player > &	getPlayers () const

int	getScore (PlayerInfo *player) const

float	getStartCountdown () const

float	getTime ()

bool	getTimerIsActive ()

bool	hasEnded () const

bool	hasStarted () const

virtual void	init ()
	Initializes sub-objects of the Gametype. More...

bool	isStartCountdownRunning () const

void	killBots (unsigned int amount=0)

virtual void	pawnKilled (Pawn victim, Pawn killer=nullptr)

virtual void	pawnPostSpawn (Pawn *pawn)

virtual void	pawnPreSpawn (Pawn *pawn)

virtual bool	playerChangedName (PlayerInfo *player)

virtual void	playerEntered (PlayerInfo *player)

virtual bool	playerLeft (PlayerInfo *player)

virtual void	playerPostSpawn (PlayerInfo *player)

virtual void	playerPreSpawn (PlayerInfo *player)

virtual void	playerScored (PlayerInfo *player, int score=1)

virtual void	playerStartsControllingPawn (PlayerInfo player, Pawn pawn)

virtual void	playerStopsControllingPawn (PlayerInfo player, Pawn pawn)

virtual void	playerSwitched (PlayerInfo player, Gametype newgametype)

virtual void	playerSwitchedBack (PlayerInfo player, Gametype oldgametype)

void	registerSpawnPoint (SpawnPoint *spawnpoint)

virtual void	removeTime (float t)

virtual void	resetTimer ()

virtual void	resetTimer (float t)

void	setConfigValues ()

void	setHUDTemplate (const std::string &name)

void	setTimeLimit (float t)

void	showMenu ()

virtual void	start ()

void	startTimer ()

void	stopTimer ()

virtual void	tick (float dt) override
	Gets called every frame. More...

Public Member Functions inherited from orxonox::BaseObject
	BaseObject (Context *context)
	Constructor: Registers the object in the BaseObject-list. More...

virtual	~BaseObject ()
	Destructor. More...

void	addEventListener (BaseObject *listener)
	Adds an object which listens to the events of this object. More...

void	addEventSource (BaseObject *source, const std::string &state)
	Adds a new event source for a specific state. More...

void	addTemplate (const std::string &name)
	Adds a Template to the object. More...

void	addTemplate (Template *temp)
	Adds a Template to the object. More...

virtual void	changedActivity ()
	This function gets called if the activity of the object changes. More...

virtual void	changedMainStateName ()
	This function gets called if the main state name of the object changes. More...

virtual void	changedName ()
	This function gets called if the name of the object changes. More...

virtual void	changedVisibility ()
	This function gets called if the visibility of the object changes. More...

void	fireEvent (const std::string &name="")
	Fires an event (without a state). More...

void	fireEvent (bool activate, const std::string &name="")
	Fires an event which activates or deactivates a state. More...

void	fireEvent (bool activate, BaseObject *originator, const std::string &name="")
	Fires an event which activates or deactivates a state with agiven originator (the object which triggered the event). More...

void	fireEvent (Event &event)
	Fires an event, using the Event struct. More...

BaseObject *	getCreator () const

BaseObject *	getEventListener (unsigned int index) const
	Returns an event listener with a given index. More...

BaseObject *	getEventSource (unsigned int index, const std::string &state) const
	Returns an eventsource with a given index. More...

const XMLFile *	getFile () const
	Returns a pointer to the XMLFile that loaded this object. More...

const std::string &	getFilename () const
	Returns the levelfile that loaded this object. More...

Gametype *	getGametype () const

Level *	getLevel () const

const std::string &	getLoaderIndentation () const
	Returns the indentation of the debug output in the Loader. More...

const std::string &	getMainStateName () const
	Returns the name of the main state. More...

const std::string &	getName () const
	Returns the name of the object. More...

Namespace *	getNamespace () const

const std::string &	getOldName () const
	Returns the old name of the object. More...

Scene *	getScene () const

virtual uint32_t	getSceneID () const

const std::set< Template * > &	getTemplates () const
	Returns the set of all aplied templates. More...

const mbool &	isActive () const
	Returns the state of the objects activity. More...

bool	isInitialized () const
	Returns if the object was initialized (passed the object registration). More...

const mbool &	isVisible () const
	Returns the state of the objects visibility. More...

virtual void	processEvent (Event &event)
	Processing an event by calling the right main state. More...

void	removeEventSource (BaseObject *source)
	Removes an eventsource (but doesn't unregister itself at the source). More...

void	setActive (bool bActive)
	Sets the state of the objects activity. More...

void	setCreator (BaseObject *creator)

void	setFile (const XMLFile *file)
	Sets a pointer to the xml file that loaded this object. More...

void	setGametype (const StrongOrWeakPtr< Gametype > &gametype)

void	setLevel (const StrongOrWeakPtr< Level > &level)

void	setLoaderIndentation (const std::string &indentation)
	Sets the indentation of the debug output in the Loader. More...

void	setMainState (bool state)
	Sets the main state of the object to a given boolean value. More...

void	setMainStateName (const std::string &name)
	Sets the name of the main state (used for event reactions). More...

void	setName (const std::string &name)
	Sets the name of the object. More...

void	setNamespace (const StrongOrWeakPtr< Namespace > &ns)

void	setScene (const StrongOrWeakPtr< Scene > &scene, uint32_t sceneID)

void	setVisible (bool bVisible)
	Sets the state of the objects visibility. More...

virtual void	XMLEventPort (Element &xmlelement, XMLPort::Mode mode)
	Defines the possible event states of this object and parses eventsources from an XML file. More...

virtual void	XMLPort (Element &xmlelement, XMLPort::Mode mode)
	XML loading and saving. More...

Public Member Functions inherited from orxonox::OrxonoxClass
	OrxonoxClass ()

OrxonoxClass &	operator= (const OrxonoxClass &)=default

Public Member Functions inherited from orxonox::Configurable
	Configurable ()

void	setConfigValues ()
	Function to collect the SetConfigValue-macro calls. More...

Public Member Functions inherited from orxonox::Listable
	Listable ()
	Constructor: Allocates space in the element list. More...

	Listable (Context *context)
	Constructor: Allocates space in the element list and assigns the context. More...

virtual	~Listable ()
	Destructor: Removes the object from the object-lists. More...

Context *	getContext () const

void	setContext (Context *context)
	Changes the context. More...

void	unregisterObject ()
	Removes this object from the object-lists. More...

Public Member Functions inherited from orxonox::Identifiable
	Identifiable ()
	Constructor: Sets the default values. More...

virtual	~Identifiable ()

ORX_FORCEINLINE void *	getDerivedPointer (unsigned int classID)
	Returns a valid pointer of any derived type that is registered in the class hierarchy. More...

template<class T >
ORX_FORCEINLINE T *	getDerivedPointer (unsigned int classID)
	Version of getDerivedPointer with template. More...

template<class T >
ORX_FORCEINLINE const T *	getDerivedPointer (unsigned int classID) const
	Const version of getDerivedPointer with template. More...

Identifier *	getIdentifier () const
	Returns the Identifier of the object. More...

bool	isA (const Identifier *identifier)
	Returns true if the object's class is of the given type or a derivative. More...

template<class B >
bool	isA (const SubclassIdentifier< B > *identifier)
	Returns true if the object's class is of the given type or a derivative. More...

bool	isA (const Identifiable *object)
	Returns true if the object's class is of the given type or a derivative. More...

bool	isChildOf (const Identifier *identifier)
	Returns true if the object's class is a child of the given type. More...

template<class B >
bool	isChildOf (const SubclassIdentifier< B > *identifier)
	Returns true if the object's class is a child of the given type. More...

bool	isChildOf (const Identifiable *object)
	Returns true if the object's class is a child of the given type. More...

bool	isDirectChildOf (const Identifier *identifier)
	Returns true if the object's class is a direct child of the given type. More...

template<class B >
bool	isDirectChildOf (const SubclassIdentifier< B > *identifier)
	Returns true if the object's class is a direct child of the given type. More...

bool	isDirectChildOf (const Identifiable *object)
	Returns true if the object's class is a direct child of the given type. More...

bool	isDirectParentOf (const Identifier *identifier)
	Returns true if the object's class is a direct parent of the given type. More...

template<class B >
bool	isDirectParentOf (const SubclassIdentifier< B > *identifier)
	Returns true if the object's class is a direct parent of the given type. More...

bool	isDirectParentOf (const Identifiable *object)
	Returns true if the object's class is a direct child of the given type. More...

bool	isExactlyA (const Identifier *identifier)
	Returns true if the object's class is exactly of the given type. More...

template<class B >
bool	isExactlyA (const SubclassIdentifier< B > *identifier)
	Returns true if the object's class is exactly of the given type. More...

bool	isExactlyA (const Identifiable *object)
	Returns true if the object's class is exactly of the given type. More...

bool	isParentOf (const Identifier *identifier)
	Returns true if the object's class is a parent of the given type. More...

template<class B >
bool	isParentOf (const SubclassIdentifier< B > *identifier)
	Returns true if the object's class is a parent of the given type. More...

bool	isParentOf (const Identifiable *object)
	Returns true if the object's class is a parent of the given type. More...

Public Member Functions inherited from orxonox::Destroyable
	Destroyable ()
	Constructor: Sets the default values. More...

virtual	~Destroyable ()
	Destructor: Notifies all DestructionListener (for example weak pointers) that this object is being deleted. More...

void	destroy ()
	Deletes the object if no strong pointers point to this object. More...

void	destroyLater ()
	Works like destroy() but doesn't destroy the object until the current tick has ended. More...

unsigned int	getReferenceCount () const
	Returns the number of strong pointers that point to this object. More...

Public Member Functions inherited from orxonox::OrxonoxInterface
	OrxonoxInterface ()

Public Member Functions inherited from orxonox::GSLevelMemento
	GSLevelMemento ()

Protected Member Functions
virtual void	assignDefaultPawnsIfNeeded ()

virtual void	checkStart ()

virtual GSLevelMementoState *	exportMementoState () override
	Returns the state of this memento. More...

virtual SpawnPoint *	getBestSpawnPoint (PlayerInfo *player) const

virtual void	importMementoState (const std::vector< GSLevelMementoState * > &states) override
	A list of the states of all mementos. More...

virtual void	spawnDeadPlayersIfRequested ()

virtual void	spawnPlayer (PlayerInfo *player)

virtual void	spawnPlayerAsDefaultPawn (PlayerInfo *player)

virtual void	spawnPlayersIfRequested ()

Protected Member Functions inherited from orxonox::BaseObject
void	addEventState (const std::string &name, EventState *container)
	Adds a new event-state to the object. More...

EventState *	getEventState (const std::string &name) const
	Returns the event-state with the given name. More...

Protected Member Functions inherited from orxonox::Destroyable
virtual void	preDestroy ()
	This virtual function is called if destroy() is called and no StrongPtr points to this object. More...

Protected Member Functions inherited from orxonox::Tickable
	Tickable ()
	Constructor: Registers the object in the Tickable-list. More...

Protected Attributes
bool	bAutoEnd_

bool	bAutoStart_

bool	bForceSpawn_

SubclassIdentifier< Bot >	botclass_

SubclassIdentifier< ControllableEntity >	defaultControllableEntity_

WeakPtr< GametypeInfo >	gtinfo_

float	initialStartCountdown_

unsigned int	numberOfBots_

std::map< PlayerInfo *, Player >	players_

OverlayGroup *	scoreboard_

std::string	scoreboardTemplate_

Timer	showMenuTimer_

std::set< SpawnPoint * >	spawnpoints_

float	time_

float	timeLimit_

bool	timerIsActive_

Protected Attributes inherited from orxonox::BaseObject
mbool	bActive_
	True = the object is active. More...

mbool	bVisible_
	True = the object is visible. More...

FunctorPtr	mainStateFunctor_

std::string	mainStateName_

std::string	name_
	The name of the object. More...

std::set< std::string >	networkTemplateNames_

std::string	oldName_
	The old name of the object. More...

Friends
class	PlayerInfo

Additional Inherited Members
Static Public Member Functions inherited from orxonox::BaseObject
static void	loadAllEventStates (Element &xmlelement, XMLPort::Mode mode, BaseObject object, Identifier identifier)
	Manually loads all event states, even if the class doesn't officially support them. More...

Constructor & Destructor Documentation

orxonox::Gametype::Gametype ( Context * context )

orxonox::Gametype::~Gametype ( )

virtual

Member Function Documentation

void orxonox::Gametype::addBots ( unsigned int amount )

virtual

Reimplemented in orxonox::DodgeRace, orxonox::OrxyRoad, orxonox::Asteroids2D, orxonox::SpaceRace, orxonox::Invader, and orxonox::Mission.

void orxonox::Gametype::addTime ( float t )

virtual

bool orxonox::Gametype::allowPawnDamage	(	Pawn *	victim,
		Pawn *	originator = `nullptr`
	)

virtual

Reimplemented in orxonox::SpaceRace, orxonox::Dynamicmatch, orxonox::LastTeamStanding, orxonox::LastManStanding, orxonox::TeamGametype, orxonox::UnderAttack, and orxonox::TeamBaseMatch.

bool orxonox::Gametype::allowPawnDeath	(	Pawn *	victim,
		Pawn *	originator = `nullptr`
	)

virtual

Reimplemented in orxonox::SpaceRace, orxonox::Dynamicmatch, orxonox::LastTeamStanding, orxonox::LastManStanding, orxonox::TeamGametype, orxonox::UnderAttack, and orxonox::TeamBaseMatch.

bool orxonox::Gametype::allowPawnHit	(	Pawn *	victim,
		Pawn *	originator = `nullptr`
	)

virtual

Reimplemented in orxonox::SpaceRace, orxonox::TeamGametype, and orxonox::UnderAttack.

void orxonox::Gametype::assignDefaultPawnsIfNeeded ( )

protectedvirtual

void orxonox::Gametype::checkStart ( )

protectedvirtual

void orxonox::Gametype::end ( void )

virtual

GSLevelMementoState * orxonox::Gametype::exportMementoState ( )

overrideprotectedvirtual

Returns the state of this memento.

Returns nullptr if no state needed to persist.

Implements orxonox::GSLevelMemento.

SpawnPoint * orxonox::Gametype::getBestSpawnPoint ( PlayerInfo * player ) const

protectedvirtual

Reimplemented in orxonox::Dynamicmatch, and orxonox::TeamGametype.

const GametypeInfo* orxonox::Gametype::getGametypeInfo ( ) const

inline

const std::string& orxonox::Gametype::getHUDTemplate ( ) const

inline

unsigned int orxonox::Gametype::getNumberOfPlayers ( ) const

inline

Get number of Players in game.

const std::map<PlayerInfo*, Player>& orxonox::Gametype::getPlayers ( ) const

inline

int orxonox::Gametype::getScore ( PlayerInfo * player ) const

float orxonox::Gametype::getStartCountdown ( ) const

inline

float orxonox::Gametype::getTime ( )

inline

bool orxonox::Gametype::getTimerIsActive ( )

inline

bool orxonox::Gametype::hasEnded ( ) const

inline

bool orxonox::Gametype::hasStarted ( ) const

inline

void orxonox::Gametype::importMementoState ( const std::vector< GSLevelMementoState * > & states )

overrideprotectedvirtual

A list of the states of all mementos.

must find the correct one by itself.

Implements orxonox::GSLevelMemento.

void orxonox::Gametype::init ( )

virtual

Initializes sub-objects of the Gametype.

This must be called after the constructor. At this point, the context is expected to have the current gametype. This allows to pass the current gametype to the sub-objects via constructor.

bool orxonox::Gametype::isStartCountdownRunning ( ) const

inline

void orxonox::Gametype::killBots ( unsigned int amount = 0 )

void orxonox::Gametype::pawnKilled	(	Pawn *	victim,
		Pawn *	killer = `nullptr`
	)

virtual

Reimplemented in orxonox::Mission, orxonox::Asteroids, orxonox::TeamDeathmatch, and orxonox::Deathmatch.

void orxonox::Gametype::pawnPostSpawn ( Pawn * pawn )

virtual

void orxonox::Gametype::pawnPreSpawn ( Pawn * pawn )

virtual

bool orxonox::Gametype::playerChangedName ( PlayerInfo * player )

virtual

Reimplemented in orxonox::Dynamicmatch, orxonox::TeamDeathmatch, and orxonox::Deathmatch.

void orxonox::Gametype::playerEntered ( PlayerInfo * player )

virtual

Reimplemented in orxonox::SOB, orxonox::Dynamicmatch, orxonox::LastManStanding, orxonox::LastTeamStanding, orxonox::SpaceRace, orxonox::UnderAttack, orxonox::TeamGametype, orxonox::TeamDeathmatch, and orxonox::Deathmatch.

bool orxonox::Gametype::playerLeft ( PlayerInfo * player )

virtual

Reimplemented in orxonox::Dynamicmatch, orxonox::LastManStanding, orxonox::LastTeamStanding, orxonox::Tetris, orxonox::TeamGametype, orxonox::TeamDeathmatch, and orxonox::Deathmatch.

void orxonox::Gametype::playerPostSpawn ( PlayerInfo * player )

virtual

void orxonox::Gametype::playerPreSpawn ( PlayerInfo * player )

virtual

Reimplemented in orxonox::DodgeRace, orxonox::OrxyRoad, and orxonox::Asteroids2D.

void orxonox::Gametype::playerScored	(	PlayerInfo *	player,
		int	score = `1`
	)

virtual

Reimplemented in orxonox::Pong, orxonox::TeamDeathmatch, orxonox::Deathmatch, and orxonox::TeamBaseMatch.

void orxonox::Gametype::playerStartsControllingPawn	(	PlayerInfo *	player,
		Pawn *	pawn
	)

virtual

Reimplemented in orxonox::Dynamicmatch, orxonox::LastTeamStanding, orxonox::LastManStanding, and orxonox::TeamGametype.

void orxonox::Gametype::playerStopsControllingPawn	(	PlayerInfo *	player,
		Pawn *	pawn
	)

virtual

void orxonox::Gametype::playerSwitched	(	PlayerInfo *	player,
		Gametype *	newgametype
	)

virtual

void orxonox::Gametype::playerSwitchedBack	(	PlayerInfo *	player,
		Gametype *	oldgametype
	)

virtual

void orxonox::Gametype::registerSpawnPoint ( SpawnPoint * spawnpoint )

inline

void orxonox::Gametype::removeTime ( float t )

virtual

void orxonox::Gametype::resetTimer ( )

virtual

void orxonox::Gametype::resetTimer ( float t )

virtual

void orxonox::Gametype::setConfigValues ( void )

void orxonox::Gametype::setHUDTemplate ( const std::string & name )

inline

void orxonox::Gametype::setTimeLimit ( float t )

inline

void orxonox::Gametype::showMenu ( )

void orxonox::Gametype::spawnDeadPlayersIfRequested ( )

protectedvirtual

Reimplemented in orxonox::LastTeamStanding, orxonox::LastManStanding, and orxonox::TeamGametype.

void orxonox::Gametype::spawnPlayer ( PlayerInfo * player )

protectedvirtual

Reimplemented in orxonox::Pong, orxonox::Tetris, orxonox::Mini4Dgame, orxonox::TowerDefense, orxonox::SOB, and orxonox::Jump.

void orxonox::Gametype::spawnPlayerAsDefaultPawn ( PlayerInfo * player )

protectedvirtual

void orxonox::Gametype::spawnPlayersIfRequested ( )

protectedvirtual

Reimplemented in orxonox::Pong, orxonox::Tetris, and orxonox::Mini4Dgame.

void orxonox::Gametype::start ( void )

virtual

Reimplemented in orxonox::Dynamicmatch, orxonox::DodgeRace, orxonox::OrxyRoad, orxonox::Pong, orxonox::FlappyOrx, orxonox::Pacman, orxonox::Wagnis, orxonox::SpaceRace, orxonox::Tetris, orxonox::Asteroids2D, orxonox::Mini4Dgame, orxonox::SOB, orxonox::TowerDefense, orxonox::Invader, orxonox::Mission, orxonox::Asteroids, orxonox::TeamDeathmatch, orxonox::Jump, and orxonox::Deathmatch.

void orxonox::Gametype::startTimer ( )

inline

void orxonox::Gametype::stopTimer ( )

inline

void orxonox::Gametype::tick ( float dt )

overridevirtual

Gets called every frame.

Parameters

dt	The time since the last frame in seconds

Reimplemented from orxonox::Tickable.

Reimplemented in orxonox::Dynamicmatch, orxonox::LastManStanding, orxonox::LastTeamStanding, orxonox::DodgeRace, orxonox::OrxyRoad, orxonox::Pacman, orxonox::Wagnis, orxonox::SpaceRace, orxonox::Tetris, orxonox::Asteroids2D, orxonox::TowerDefense, orxonox::Hover, orxonox::OrxoKart, orxonox::SOB, orxonox::UnderAttack, orxonox::Mission, orxonox::Asteroids, and orxonox::Jump.

Friends And Related Function Documentation

friend class PlayerInfo

friend

Member Data Documentation

bool orxonox::Gametype::bAutoEnd_

protected

bool orxonox::Gametype::bAutoStart_

protected

bool orxonox::Gametype::bForceSpawn_

protected

SubclassIdentifier<Bot> orxonox::Gametype::botclass_

protected

SubclassIdentifier<ControllableEntity> orxonox::Gametype::defaultControllableEntity_

protected

WeakPtr<GametypeInfo> orxonox::Gametype::gtinfo_

protected

float orxonox::Gametype::initialStartCountdown_

protected

unsigned int orxonox::Gametype::numberOfBots_

protected

std::map<PlayerInfo*, Player> orxonox::Gametype::players_

protected

OverlayGroup* orxonox::Gametype::scoreboard_

protected

std::string orxonox::Gametype::scoreboardTemplate_

protected

Timer orxonox::Gametype::showMenuTimer_

protected

std::set<SpawnPoint*> orxonox::Gametype::spawnpoints_

protected

float orxonox::Gametype::time_

protected

float orxonox::Gametype::timeLimit_

protected

bool orxonox::Gametype::timerIsActive_

protected

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

orxonox/gametypes/Gametype.h
orxonox/gametypes/Gametype.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation