Emergency 20 Dokumentation  4.2.0
em5::Mod Class Reference

EMERGENCY 5 mod class. More...

#include <Mod.h>

Inheritance diagram for em5::Mod:

Public Types

enum  EnableCheckResult { MOD_OKAY, MOD_PLUGINS_UNSUPPORTED }
 

Public Member Functions

 Mod (uint32)
 Default constructor. More...
 
 ~Mod ()
 Destructor. More...
 
const std::string & getName () const
 
const std::string & getDisplayName () const
 
const std::string & getIconFilename () const
 
qsf::ProjectgetProject () const
 
uint32 getOrderingIndex () const
 
void setOrderingIndex (uint32 index)
 
EnableCheckResult canBeEnabled ()
 
bool isEnabled () const
 
void setEnabled (bool enabled)
 
bool isMounted () const
 

Protected Member Functions

void initialize (qsf::Project &project, uint32 index=0)
 
void mount ()
 
void unmount ()
 
void loadPlugins (const std::vector< qsf::NamedIdentifier > &applicationTags)
 

Friends

class ModSystem
 

Detailed Description

EMERGENCY 5 mod class.

Member Enumeration Documentation

Enumerator
MOD_OKAY 
MOD_PLUGINS_UNSUPPORTED 

Constructor & Destructor Documentation

em5::Mod::Mod ( uint32  )
inlineexplicit

Default constructor.

em5::Mod::~Mod ( )
inline

Destructor.

Member Function Documentation

EnableCheckResult em5::Mod::canBeEnabled ( )
const std::string & em5::Mod::getDisplayName ( ) const
inline
const std::string & em5::Mod::getIconFilename ( ) const
inline
const std::string & em5::Mod::getName ( ) const
inline
uint32 em5::Mod::getOrderingIndex ( ) const
inline
qsf::Project & em5::Mod::getProject ( ) const
inline
void em5::Mod::initialize ( qsf::Project project,
uint32  index = 0 
)
protected
bool em5::Mod::isEnabled ( ) const
inline
bool em5::Mod::isMounted ( ) const
inline
void em5::Mod::loadPlugins ( const std::vector< qsf::NamedIdentifier > &  applicationTags)
protected
void em5::Mod::mount ( )
protected
void em5::Mod::setEnabled ( bool  enabled)
inline
void em5::Mod::setOrderingIndex ( uint32  index)
inline
void em5::Mod::unmount ( )
protected

Friends And Related Function Documentation

friend class ModSystem
friend

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