Configuration

Config_SetValue("SecretSue", "1");. More...

Functions
CAVESTORY_MOD_API bool	Config_GetBool (const char *pCVarName)
	Get a boolean value from a configuration variable. More...
CAVESTORY_MOD_API int	Config_GetInt (const char *pCVarName)
	Get an integer value from a configuration variable. More...
CAVESTORY_MOD_API const char *	Config_GetString (const char *pCVarName)
	Get a string value from a configuration variable. More...
CAVESTORY_MOD_API void	Config_GetColor (const char *pCVarName, GUI_COLOR &pColor)
	Get a color value from a configuration variable. More...
CAVESTORY_MOD_API bool	Config_SetValue (const char *pCVarName, const char *pValue, bool bUserInput=false)
	Set the value of a configuration variable. More...

Detailed Description

Config_SetValue("SecretSue", "1");.

Functions to manipulate game configuration variables.

Function Documentation

Config_GetBool()

CAVESTORY_MOD_API bool Config_GetBool

(

const char *

pCVarName

)

Get a boolean value from a configuration variable.

Parameters

pCVarName

The name of the configuration variable

Returns

Returns the value.

Config_GetColor()

CAVESTORY_MOD_API void Config_GetColor	(	const char *	pCVarName,
		GUI_COLOR &	pColor
	)

Get a color value from a configuration variable.

Parameters

pCVarName	The name of the configuration variable
pColor	The color.

Returns

Retursn the value.

Config_GetInt()

CAVESTORY_MOD_API int Config_GetInt

(

const char *

pCVarName

)

Get an integer value from a configuration variable.

Parameters

pCVarName

The name of the configuration variable

Returns

Returns the value.

Config_GetString()

CAVESTORY_MOD_API const char* Config_GetString

(

const char *

pCVarName

)

Get a string value from a configuration variable.

Parameters

pCVarName

The name of the configuration variable

Returns

Returns the value.

Config_SetValue()

CAVESTORY_MOD_API bool Config_SetValue	(	const char *	pCVarName,
		const char *	pValue,
		bool	bUserInput = false
	)

Set the value of a configuration variable.

Parameters

pCVarName	The name of the configuration variable
pValue	The new value
bUserInput	Whether this was inputted by a user

Returns

Returns true on success, false if otherwise.