Emergency 2017 Dokumentation  v3.0.1
qsf::game::EquipmentSystem Class Reference

Equipment system. More...

#include <EquipmentSystem.h>

Public Member Functions

 EquipmentSystem ()
 Default constructor. More...
 
virtual ~EquipmentSystem ()
 Destructor. More...
 
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

Equipment system.

Todo:
  • TODO(fw): Still needs to be implemented

Definition at line 38 of file EquipmentSystem.h.

Constructor & Destructor Documentation

qsf::game::EquipmentSystem::EquipmentSystem ( )
inline

Default constructor.

Definition at line 16 of file EquipmentSystem-inl.h.

qsf::game::EquipmentSystem::~EquipmentSystem ( )
inlinevirtual

Destructor.

Definition at line 21 of file EquipmentSystem-inl.h.

Member Function Documentation

const char * qsf::game::EquipmentSystem::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 30 of file EquipmentSystem-inl.h.

virtual void qsf::game::EquipmentSystem::onShutdown ( )
overridevirtual

Shutdown the system.

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

Implements qsf::System.

virtual bool qsf::game::EquipmentSystem::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.


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