OpenMW
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | List of all members
ESM::GameSetting Struct Reference

#include <loadgmst.hpp>

Collaboration diagram for ESM::GameSetting:

Public Member Functions

void load (ESMReader &esm, bool &isDeleted)
 
int getInt () const
 Throws an exception if GMST is not of type int or float. More...
 
float getFloat () const
 Throws an exception if GMST is not of type int or float. More...
 
std::string getString () const
 Throwns an exception if GMST is not of type string. More...
 
void save (ESMWriter &esm, bool isDeleted=false) const
 
void blank ()
 Set record to default state (does not touch the ID). More...
 

Static Public Member Functions

static std::string getRecordType ()
 Return a string descriptor for this record type. Currently used for debugging / error logs only. More...
 

Public Attributes

std::string mId
 
Variant mValue
 

Static Public Attributes

static unsigned int sRecordId = REC_GMST
 

Member Function Documentation

void ESM::GameSetting::blank ( )

Set record to default state (does not touch the ID).

Here is the call graph for this function:

Here is the caller graph for this function:

float ESM::GameSetting::getFloat ( ) const

Throws an exception if GMST is not of type int or float.

Here is the call graph for this function:

int ESM::GameSetting::getInt ( ) const

Throws an exception if GMST is not of type int or float.

Todo:
remove the get* functions (redundant, since mValue has equivalent functions now).

Here is the call graph for this function:

Here is the caller graph for this function:

static std::string ESM::GameSetting::getRecordType ( )
inlinestatic

Return a string descriptor for this record type. Currently used for debugging / error logs only.

std::string ESM::GameSetting::getString ( ) const

Throwns an exception if GMST is not of type string.

Here is the call graph for this function:

Here is the caller graph for this function:

void ESM::GameSetting::load ( ESMReader esm,
bool isDeleted 
)

Here is the call graph for this function:

void ESM::GameSetting::save ( ESMWriter esm,
bool  isDeleted = false 
) const

Here is the call graph for this function:

Member Data Documentation

std::string ESM::GameSetting::mId
Variant ESM::GameSetting::mValue
unsigned int ESM::GameSetting::sRecordId = REC_GMST
static

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