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

EMERGENCY 5 mod system. More...

#include <ModSystem.h>

Public Member Functions

 ModSystem ()
 Default constructor. More...
 
virtual ~ModSystem ()
 Destructor. More...
 
const std::string & getModsUserDirectory () const
 
const boost::container::flat_map< uint32, Mod * > & getMods () const
 
void getModsSorted (std::vector< Mod * > &outModList) const
 
bool isAnyModEnabled () const
 
void getEnabledMods (std::vector< Mod * > &outMods) const
 
void disableAllMods () const
 
void mountEnabledMods ()
 
void unmountMods ()
 
void filterCoreProjectsFromMods ()
 
void loadModPluginsForApplicationTags (const std::vector< qsf::NamedIdentifier > &applicationTags)
 
bool loadModUserSettings ()
 
bool saveModUserSettings ()
 
void gatherModStateFromProjects ()
 
void eraseModFromDisk (uint32 modId)
 
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

EMERGENCY 5 mod system.

Todo:
  • TODO(fw): Move this to QSF (best qsf::game) as it's not really EM5-specific

Definition at line 56 of file ModSystem.h.

Constructor & Destructor Documentation

em5::ModSystem::ModSystem ( )

Default constructor.

virtual em5::ModSystem::~ModSystem ( )
virtual

Destructor.

Member Function Documentation

void em5::ModSystem::disableAllMods ( ) const
void em5::ModSystem::eraseModFromDisk ( uint32  modId)
void em5::ModSystem::filterCoreProjectsFromMods ( )
void em5::ModSystem::gatherModStateFromProjects ( )
void em5::ModSystem::getEnabledMods ( std::vector< Mod * > &  outMods) const
const boost::container::flat_map< uint32, Mod * > & em5::ModSystem::getMods ( ) const
inline

Definition at line 19 of file ModSystem-inl.h.

void em5::ModSystem::getModsSorted ( std::vector< Mod * > &  outModList) const
const std::string & em5::ModSystem::getModsUserDirectory ( ) const
inline

Definition at line 14 of file ModSystem-inl.h.

const char * em5::ModSystem::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 28 of file ModSystem-inl.h.

bool em5::ModSystem::isAnyModEnabled ( ) const
void em5::ModSystem::loadModPluginsForApplicationTags ( const std::vector< qsf::NamedIdentifier > &  applicationTags)
bool em5::ModSystem::loadModUserSettings ( )
void em5::ModSystem::mountEnabledMods ( )
virtual void em5::ModSystem::onShutdown ( )
overridevirtual

Shutdown the system.

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

Implements qsf::System.

virtual bool em5::ModSystem::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.

bool em5::ModSystem::saveModUserSettings ( )
void em5::ModSystem::unmountMods ( )

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