Orxonox  0.0.5 Codename: Arcturus
Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | Static Private Attributes | Friends | List of all members
orxonox::GametypeInfo Class Reference

The GametypeInfo class keeps track of the state of the game and provides facilities to inform the player about it. More...

#include </home/jenkins/workspace/orxonox_doxygen_trunk/src/orxonox/infos/GametypeInfo.h>

Inheritance diagram for orxonox::GametypeInfo:
orxonox::Info orxonox::BaseObject orxonox::Synchronisable orxonox::OrxonoxClass orxonox::OrxonoxInterface orxonox::Configurable orxonox::Destroyable orxonox::Configurable orxonox::Destroyable orxonox::Listable orxonox::Listable orxonox::Identifiable orxonox::Identifiable

Public Member Functions

 GametypeInfo (Context *context)
 Registers and initializes the object. More...
 
virtual ~GametypeInfo ()
 
void changedCountdownCounter (void)
 Is called when the start countdown counter has changed. More...
 
void changedEnded (void)
 Is called when the game has changed to ended. More...
 
void changedReadyToSpawn (bool ready)
 Inform the GametypeInfo that the local player has changed its ready to spawn status. More...
 
void changedSpawned (bool spawned)
 Inform the GametypeInfo that the local player has changed its spawned status. More...
 
void changedStartCountdownRunning (void)
 Is called when the start countdown has been either started or stopped. More...
 
void changedStarted (void)
 Is called when the game has changed to started. More...
 
void dispatchAnnounceMessage (const std::string &message) const
 
void dispatchDeathMessage (const std::string &message) const
 
void dispatchFadingMessage (const std::string &message) const
 
void dispatchKillMessage (const std::string &message) const
 
void dispatchStaticMessage (const std::string &message, const ColourValue &colour) const
 
const std::string & getHUDTemplate () const
 
float getStartCountdown () const
 Get the current value of the start countdown. More...
 
unsigned int getStartCountdownCounter () const
 Get the current start countdown counter. More...
 
bool hasEnded () const
 Get whether the game has ended yet. More...
 
bool hasStarted () const
 Get whether the game has started yet. More...
 
bool isReadyToSpawn () const
 Get whether the local player is ready to spawn. More...
 
bool isSpawned () const
 Get whether the local player is spawned. More...
 
bool isStartCountdownRunning () const
 Get whether the start countdown is currently running. More...
 
void sendAnnounceMessage (const std::string &message) const
 
void sendAnnounceMessage (const std::string &message, unsigned int clientID) const
 
void sendDeathMessage (const std::string &message, unsigned int clientID) const
 
void sendFadingMessage (const std::string &message, unsigned int clientID) const
 
void sendKillMessage (const std::string &message, unsigned int clientID) const
 
void sendStaticMessage (const std::string &message, unsigned int clientID, const ColourValue &colour) const
 
- Public Member Functions inherited from orxonox::Info
 Info (Context *context)
 
virtual ~Info ()
 
- 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...
 
BaseObjectgetCreator () const
 
BaseObjectgetEventListener (unsigned int index) const
 Returns an event listener with a given index. More...
 
BaseObjectgetEventSource (unsigned int index, const std::string &state) const
 Returns an eventsource with a given index. More...
 
const XMLFilegetFile () 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...
 
GametypegetGametype () const
 
LevelgetLevel () 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...
 
NamespacegetNamespace () const
 
const std::string & getOldName () const
 Returns the old name of the object. More...
 
ScenegetScene () const
 
virtual uint32_t getSceneID () const
 
const std::set< Template * > & getTemplates () const
 Returns the set of all aplied templates. More...
 
const mboolisActive () const
 Returns the state of the objects activity. More...
 
bool isInitialized () const
 Returns if the object was initialized (passed the object registration). More...
 
const mboolisVisible () 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 ()
 
OrxonoxClassoperator= (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...
 
ContextgetContext () 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 voidgetDerivedPointer (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...
 
IdentifiergetIdentifier () 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::Synchronisable
virtual ~Synchronisable ()
 Destructor: Delete all callback objects and remove objectID_ from the objectMap_. More...
 
uint32_t getClassID () const
 
unsigned int getContextID () const
 
uint32_t getNrOfVariables ()
 
uint32_t getObjectID () const
 
unsigned int getPriority () const
 
uint8_t getSyncMode () const
 
uint32_t getVarSize (VariableID ID)
 
template<>
_NetworkExport void registerVariable (std::string &variable, uint8_t mode, NetworkCallbackBase *cb, bool bidirectional)
 
template<>
void registerVariable (std::string &variable, uint8_t mode, NetworkCallbackBase *cb, bool bidirectional)
 
void setSyncMode (uint8_t mode)
 This function sets the synchronisation mode of the object If set to 0x0 variables will not be synchronised at all If set to 0x1 variables will only be synchronised to the client If set to 0x2 variables will only be synchronised to the server If set to 0x3 variables will be synchronised bidirectionally (only if set so in registerVar) More...
 
template<>
_NetworkExport void unregisterVariable (std::string &variable)
 
template<>
void unregisterVariable (std::string &variable)
 
- Public Member Functions inherited from orxonox::OrxonoxInterface
 OrxonoxInterface ()
 

Protected Member Functions

void countDown ()
 Count down the start countdown counter. More...
 
void countdownStartCountdown (float countDown)
 Count down the start countdown by the specified value. More...
 
void end (void)
 Inform the GametypeInfo that the game has ended. More...
 
void pawnKilled (PlayerInfo *player)
 Inform the GametypeInfo about a player whose Pawn has been killed. More...
 
void playerEntered (PlayerInfo *player)
 Inform the GametypeInfo about a player that has entered,. More...
 
void playerReadyToSpawn (PlayerInfo *player)
 Inform the GametypeInfo about a player that is ready to spawn. More...
 
void playerSpawned (PlayerInfo *player)
 Inform the GametypeInfo about a player that has spawned. More...
 
void setHUDTemplate (const std::string &templateName)
 
void setStartCountdown (float countdown)
 Set the start countdown to the input value. More...
 
void start (void)
 Inform the GametypeInfo that the game has started. More...
 
void startStartCountdown (void)
 Inform the GametypeInfo about the start of the start countdown. More...
 
void stopStartCountdown (void)
 Inform the GametypeInfo about the stop of the start countdown. More...
 
- Protected Member Functions inherited from orxonox::BaseObject
void addEventState (const std::string &name, EventState *container)
 Adds a new event-state to the object. More...
 
EventStategetEventState (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::Synchronisable
 Synchronisable (Context *context)
 Constructor: Initializes all Variables and sets the right objectID_. More...
 
uint32_t findContextID (Context *context)
 Returns the id of the context. More...
 
template<class T >
void registerVariable (T &variable, uint8_t mode=0x1, NetworkCallbackBase *cb=nullptr, bool bidirectional=false)
 
template<class T >
void registerVariable (std::set< T > &variable, uint8_t mode=0x1, NetworkCallbackBase *cb=nullptr, bool bidirectional=false)
 
void setPriority (unsigned int freq)
 
template<class T >
void unregisterVariable (T &var)
 

Private Member Functions

void registerVariables ()
 
void setReadyToSpawnHelper (PlayerInfo *player, bool ready)
 Helper method. More...
 
void setSpawnedHelper (PlayerInfo *player, bool spawned)
 Helper method. More...
 

Private Attributes

bool bEnded_
 Whether the game has ended. More...
 
bool bStartCountdownRunning_
 Whether the start countdown is running. More...
 
bool bStarted_
 Whether the game has started,. More...
 
unsigned int counter_
 The current integer value of the start countdown, the start countdown counter. More...
 
std::string hudtemplate_
 
bool isFirstSpawn_
 
bool readyToSpawn_
 Whether the local Player is ready to spawn. More...
 
bool spawned_
 Whether the local Player is currently spawned. More...
 
std::set< PlayerInfo * > spawnedPlayers_
 A set of players that are currently spawned. More...
 
float startCountdown_
 The current value of the start countdown. More...
 

Static Private Attributes

static const std::string NOTIFICATION_SENDER
 The name of the sender for the sending of notifications. More...
 

Friends

class Gametype
 

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...
 
- Static Public Member Functions inherited from orxonox::Synchronisable
static bool deleteObject (uint32_t objectID_)
 Finds and deletes the Synchronisable with the appropriate objectID_. More...
 
static Synchronisablefabricate (uint8_t *&mem, uint8_t mode=0x0)
 This function fabricated a new synchrnisable (and children of it), sets calls updateData and create After calling this function the mem pointer will be increased by the size of the needed data. More...
 
static unsigned int getNumberOfDeletedObject ()
 
static SynchronisablegetSynchronisable (uint32_t objectID_)
 This function looks up the objectID_ in the objectMap_ and returns a pointer to the right Synchronisable. More...
 
static uint32_t popDeletedObject ()
 
static void setClient (bool b)
 This function sets the internal mode for synchronisation. More...
 
- 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...
 

Detailed Description

The GametypeInfo class keeps track of the state of the game and provides facilities to inform the player about it.

Author
Fabian 'x3n' Landau
Damian 'Mozork' Frick

Constructor & Destructor Documentation

orxonox::GametypeInfo::GametypeInfo ( Context context)

Registers and initializes the object.

orxonox::GametypeInfo::~GametypeInfo ( )
virtual

Member Function Documentation

void orxonox::GametypeInfo::changedCountdownCounter ( void  )

Is called when the start countdown counter has changed.

void orxonox::GametypeInfo::changedEnded ( void  )

Is called when the game has changed to ended.

void orxonox::GametypeInfo::changedReadyToSpawn ( bool  ready)

Inform the GametypeInfo that the local player has changed its ready to spawn status.

Parameters
readyWhether the player has become ready to spawn or not.
void orxonox::GametypeInfo::changedSpawned ( bool  spawned)

Inform the GametypeInfo that the local player has changed its spawned status.

Parameters
spawnedWhether the local player has changed to spawned or to not spawned.
void orxonox::GametypeInfo::changedStartCountdownRunning ( void  )

Is called when the start countdown has been either started or stopped.

void orxonox::GametypeInfo::changedStarted ( void  )

Is called when the game has changed to started.

void orxonox::GametypeInfo::countDown ( )
protected

Count down the start countdown counter.

void orxonox::GametypeInfo::countdownStartCountdown ( float  countDown)
protected

Count down the start countdown by the specified value.

Parameters
countDownThe amount by which we count down.
void orxonox::GametypeInfo::dispatchAnnounceMessage ( const std::string &  message) const
void orxonox::GametypeInfo::dispatchDeathMessage ( const std::string &  message) const
void orxonox::GametypeInfo::dispatchFadingMessage ( const std::string &  message) const
void orxonox::GametypeInfo::dispatchKillMessage ( const std::string &  message) const
void orxonox::GametypeInfo::dispatchStaticMessage ( const std::string &  message,
const ColourValue &  colour 
) const
void orxonox::GametypeInfo::end ( void  )
protected

Inform the GametypeInfo that the game has ended.

const std::string& orxonox::GametypeInfo::getHUDTemplate ( ) const
inline
float orxonox::GametypeInfo::getStartCountdown ( ) const
inline

Get the current value of the start countdown.

Returns
Returns the current value of the start countdown.
unsigned int orxonox::GametypeInfo::getStartCountdownCounter ( ) const
inline

Get the current start countdown counter.

The start countdown counter only has integer values that correspond to the actually displayed countdown.

Returns
Returns the current integer countdown counter.
bool orxonox::GametypeInfo::hasEnded ( ) const
inline

Get whether the game has ended yet.

Returns
Returns true if the game has ended, false if not.
bool orxonox::GametypeInfo::hasStarted ( ) const
inline

Get whether the game has started yet.

Returns
Returns true if the game has started, false if not.
bool orxonox::GametypeInfo::isReadyToSpawn ( ) const
inline

Get whether the local player is ready to spawn.

Returns
Returns true if the player is ready to spawn, false if not.
bool orxonox::GametypeInfo::isSpawned ( ) const
inline

Get whether the local player is spawned.

Returns
Returns true if the local player is currently spawned, false if not.
bool orxonox::GametypeInfo::isStartCountdownRunning ( ) const
inline

Get whether the start countdown is currently running.

Returns
Returns true if the countdown is running, false if not.
void orxonox::GametypeInfo::pawnKilled ( PlayerInfo player)
protected

Inform the GametypeInfo about a player whose Pawn has been killed.

Parameters
playerThe player whose Pawn has been killed.
void orxonox::GametypeInfo::playerEntered ( PlayerInfo player)
protected

Inform the GametypeInfo about a player that has entered,.

Parameters
playerThe player that has entered.
void orxonox::GametypeInfo::playerReadyToSpawn ( PlayerInfo player)
protected

Inform the GametypeInfo about a player that is ready to spawn.

Parameters
playerThe player that is ready to spawn.
void orxonox::GametypeInfo::playerSpawned ( PlayerInfo player)
protected

Inform the GametypeInfo about a player that has spawned.

Parameters
playerThe player that has spawned.
void orxonox::GametypeInfo::registerVariables ( void  )
private
void orxonox::GametypeInfo::sendAnnounceMessage ( const std::string &  message) const
void orxonox::GametypeInfo::sendAnnounceMessage ( const std::string &  message,
unsigned int  clientID 
) const
void orxonox::GametypeInfo::sendDeathMessage ( const std::string &  message,
unsigned int  clientID 
) const
void orxonox::GametypeInfo::sendFadingMessage ( const std::string &  message,
unsigned int  clientID 
) const
void orxonox::GametypeInfo::sendKillMessage ( const std::string &  message,
unsigned int  clientID 
) const
void orxonox::GametypeInfo::sendStaticMessage ( const std::string &  message,
unsigned int  clientID,
const ColourValue &  colour 
) const
void orxonox::GametypeInfo::setHUDTemplate ( const std::string &  templateName)
inlineprotected
void orxonox::GametypeInfo::setReadyToSpawnHelper ( PlayerInfo player,
bool  ready 
)
private

Helper method.

Sends changedReadyToSpawn notifiers over the network.

Parameters
playerThe player that has changed its ready to spawn status.
readyThe new ready to spawn status.
void orxonox::GametypeInfo::setSpawnedHelper ( PlayerInfo player,
bool  spawned 
)
private

Helper method.

Sends changedSpawned notifiers over the network.

Parameters
playerThe player that has changed its spawned status.
spawnedThe new spawned status.
void orxonox::GametypeInfo::setStartCountdown ( float  countdown)
protected

Set the start countdown to the input value.

Parameters
countdownThe countdown to be set.
void orxonox::GametypeInfo::start ( void  )
protected

Inform the GametypeInfo that the game has started.

void orxonox::GametypeInfo::startStartCountdown ( void  )
protected

Inform the GametypeInfo about the start of the start countdown.

void orxonox::GametypeInfo::stopStartCountdown ( void  )
protected

Inform the GametypeInfo about the stop of the start countdown.

Friends And Related Function Documentation

friend class Gametype
friend

Member Data Documentation

bool orxonox::GametypeInfo::bEnded_
private

Whether the game has ended.

bool orxonox::GametypeInfo::bStartCountdownRunning_
private

Whether the start countdown is running.

bool orxonox::GametypeInfo::bStarted_
private

Whether the game has started,.

unsigned int orxonox::GametypeInfo::counter_
private

The current integer value of the start countdown, the start countdown counter.

std::string orxonox::GametypeInfo::hudtemplate_
private
bool orxonox::GametypeInfo::isFirstSpawn_
private
const std::string orxonox::GametypeInfo::NOTIFICATION_SENDER
staticprivate

The name of the sender for the sending of notifications.

bool orxonox::GametypeInfo::readyToSpawn_
private

Whether the local Player is ready to spawn.

bool orxonox::GametypeInfo::spawned_
private

Whether the local Player is currently spawned.

std::set<PlayerInfo*> orxonox::GametypeInfo::spawnedPlayers_
private

A set of players that are currently spawned.

float orxonox::GametypeInfo::startCountdown_
private

The current value of the start countdown.


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