ConVar Class Reference

Represents a single console variable or command. More...

#include <Application/ConVar.h>

List of all members.

Public Types
enum	Type {   TYPE_INT = 0, TYPE_UNSIGNED_INT, TYPE_VECTOR, TYPE_POINT,   TYPE_COLOR, TYPE_FLOAT, TYPE_STRING, TYPE_COMMAND }
	The data type of the console variable. More...
Public Member Functions
int	GetInt () const
	Returns the ConVar value as a 32-bit signed int.
uint	GetUInt () const
	Returns the ConVar value as a 32-bit unsigned int.
float	GetFloat () const
	Returns the ConVar value as a float.
Vector2f	GetVector () const
	Returns the ConVar value as a 2 component floating point vector.
Point2f	GetPoint () const
	Returns the ConVar value as a 2 component floating point point.
Color4f	GetColor () const
	Returns the ConVar value as a 4 component floating point color.
const char *	GetString () const
	Returns the ConVar value as a string.
fnConCommad	GetCommand () const
	Returns the console command function.
void *	GetUserData () const
	Returns the user data associated with the variable.
void	SetInt (int v)
	Sets the int value of the ConVar.
void	SetUInt (uint v)
	Sets the unsigned int value of the ConVar.
void	SetFloat (float v)
	Sets the float value of the ConVar.
void	SetVector (const Vector2f &v)
	Sets the vector value of the ConVar.
void	SetPoint (const Point2f &v)
	Sets the point value of the ConVar.
void	SetColor (const Color4f &v)
	Sets the color value of the ConVar.
void	SetString (const char *v)
	Sets the string value of the ConVar.
void	Revert ()
	Reverts the variable to its default variable.
const std::string &	GetNameString () const
	Returns the name of the console variable.
const char *	GetName () const
	Returns the name of the console variable.
const char *	GetDefaultValue () const
	Returns the defualt console variable.
const char *	GetHelpStr () const
	Returns the help string for the console variable.
ConVar::Type	GetType () const
	Returns the type of the console variable.
void	AddListener (ConVarListener *lsn)
	Adds a listner to the console variable.
void	RemoveListener (ConVarListener *lsn)
	Removes a listner from the console variable.
Friends
class	Console

---

Detailed Description

Represents a single console variable or command.

---

Member Enumeration Documentation

enum ConVar::Type

The data type of the console variable.

Enumerator:

TYPE_INT	A 32-bit signed integer.
TYPE_UNSIGNED_INT	A 32-bit unsigned integer.
TYPE_VECTOR	A 2 component floating point vector.
TYPE_POINT	A 2 component floating point point.
TYPE_COLOR	A 4 component floating point color.
TYPE_FLOAT	A floating point value.
TYPE_STRING	An arbitrarily sized string.
TYPE_COMMAND	A console command.

---

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

• ConVar.h
• ConVar.cpp