Emergency 2017 Dokumentation  v3.0.1
em5::ActivitySystem Class Reference

Activity system. More...

#include <ActivitySystem.h>

Public Member Functions

 ActivitySystem ()
 Default constructor. More...
 
virtual ~ActivitySystem ()
 Destructor. More...
 
ActivitygetActivityByAsset (const qsf::AssetProxy &assetProxy)
 
void reloadActivities ()
 
ActivityStepFactorygetActivityStepFactory () const
 
virtual const char * getName () const override
 Get the name of the system. More...
 
virtual bool onStartup (bool serverMode) override
 Startup the system. More...
 
virtual void onShutdown () override
 Shutdown the system. More...
 
- Public Member Functions inherited from qsf::System
virtual ~System ()
 Destructor. More...
 

Additional Inherited Members

- Protected Member Functions inherited from qsf::System
 System ()
 Default constructor. More...
 

Detailed Description

Activity system.

Todo:
  • TODO(fw): If made more generic, this could be moved to qsf::game

Definition at line 47 of file ActivitySystem.h.

Constructor & Destructor Documentation

em5::ActivitySystem::ActivitySystem ( )

Default constructor.

virtual em5::ActivitySystem::~ActivitySystem ( )
virtual

Destructor.

Member Function Documentation

Activity * em5::ActivitySystem::getActivityByAsset ( const qsf::AssetProxy assetProxy)
inline

Definition at line 20 of file ActivitySystem-inl.h.

ActivityStepFactory & em5::ActivitySystem::getActivityStepFactory ( ) const
inline

Definition at line 30 of file ActivitySystem-inl.h.

const char * em5::ActivitySystem::getName ( ) const
inlineoverridevirtual

Get the name of the system.

Returns
Null terminated ASCII name of the system, never a null pointer, do not manipulate or destroy the returned name

Implements qsf::System.

Definition at line 41 of file ActivitySystem-inl.h.

virtual void em5::ActivitySystem::onShutdown ( )
overridevirtual

Shutdown the system.

Note
  • This method is only called case "onStartup()" returned successfully

Implements qsf::System.

virtual bool em5::ActivitySystem::onStartup ( bool  serverMode)
overridevirtual

Startup the system.

Parameters
[in]serverMode"true" if the system should start in server mode, else "false"
Returns
"true" if all went fine, else "false"
Note
  • Server mode means that e.g. there's no need for audio & visual stuff because there's no display or sound hardware in the first place

Implements qsf::System.

void em5::ActivitySystem::reloadActivities ( )

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