CGameDescription Class Reference

#include <preferences.h>

Public Member Functions
const std::string &	getKeyValue (const std::string &key) const
const std::string &	getRequiredKeyValue (const std::string &key) const
	CGameDescription (xmlDocPtr pDoc, const std::string &GameFile)
Data Fields
std::string	mGameFile
	the .game file that describes this game
const std::string	emptyString
GameDescription	m_gameDescription
Private Types
typedef std::map< std::string, std::string >	GameDescription

---

Detailed Description

holds game specific configuration stuff such as base names, engine names, some game specific features to activate in the various modules it is not strictly a prefs thing since the user is not supposed to edit that (unless he is hacking support for a new game)

what we do now is fully generate the information for this during the setup. We might want to generate a piece that just says "the game pack is there", but put the rest of the config somwhere else (i.e. not generated, copied over during setup .. for instance in the game tools directory)

Definition at line 197 of file preferences.h.

---

Member Typedef Documentation

typedef std::map<std::string, std::string> CGameDescription::GameDescription [private]

Definition at line 200 of file preferences.h.

---

Constructor & Destructor Documentation

CGameDescription::CGameDescription	(	xmlDocPtr	pDoc,
		const std::string &	GameFile
	)

---

Member Function Documentation

const std::string& CGameDescription::getKeyValue

(

const std::string &

key

)

const [inline]

Definition at line 207 of file preferences.h.

References emptyString, i, and m_gameDescription.

const std::string& CGameDescription::getRequiredKeyValue

(

const std::string &

key

)

const [inline]

Definition at line 215 of file preferences.h.

References emptyString, i, m_gameDescription, makeQuoted(), and mGameFile.

---

Field Documentation

const std::string CGameDescription::emptyString

Definition at line 204 of file preferences.h.

Referenced by getKeyValue(), and getRequiredKeyValue().

GameDescription CGameDescription::m_gameDescription

Definition at line 205 of file preferences.h.

Referenced by getKeyValue(), and getRequiredKeyValue().

std::string CGameDescription::mGameFile

the .game file that describes this game

Definition at line 203 of file preferences.h.

Referenced by getRequiredKeyValue().

---

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

• src/tools/radiant/radiant/settings/preferences.h