cvarAPI_t Struct Reference

Public Member Functions
string	GetString (string cvarName)
	Returns the string value of a console variable. More...
int	GetInteger (string cvarName)
	Returns the integer value of a console variable. More...
float	GetFloat (string cvarName)
	Returns the floating-point value of a console variable. More...
float	GetBool (string cvarName)
	Returns the boolean value of a console variable. More...
vector	GetVector (string cvarName)
	Returns the vector value of a console variable. More...
void	SetString (string cvarName, string setValue)
	Sets the specified console variable to a set string value. More...
void	SetInteger (string cvarName, int setValue)
	Sets the specified console variable to a set integer value. More...
void	SetBool (string cvarName, float setValue)
	Sets the specified console variable to a set boolean value. More...
void	SetFloat (string cvarName, float setValue)
	Sets the specified console variable to a set floating-point value. More...
void	SetVector (string cvarName, vector setValue)
	Sets the specified console variable to a set vector. More...

Member Function Documentation

GetBool()

float cvarAPI_t::GetBool

(

string

cvarName

)

Returns the boolean value of a console variable.

Parameters

cvarName

specifies the console variable key to query.

Returns

The value in boolean form.

GetFloat()

float cvarAPI_t::GetFloat

(

string

cvarName

)

Returns the floating-point value of a console variable.

Parameters

cvarName

specifies the console variable key to query.

Returns

The value in floating-point format.

GetInteger()

int cvarAPI_t::GetInteger

(

string

cvarName

)

Returns the integer value of a console variable.

Parameters

cvarName

specifies the console variable key to query.

Returns

The value in integer format.

GetString()

string cvarAPI_t::GetString

(

string

cvarName

)

Returns the string value of a console variable.

Parameters

cvarName

specifies the console variable key to query.

Returns

The value in string format.

GetVector()

vector cvarAPI_t::GetVector

(

string

cvarName

)

Returns the vector value of a console variable.

Parameters

cvarName

specifies the console variable key to query.

Returns

The value in vector form.

SetBool()

void cvarAPI_t::SetBool	(	string	cvarName,
		float	setValue
	)

Sets the specified console variable to a set boolean value.

Parameters

cvarName	specifies the console variable to set.
setValue	specifies the value of said key.

SetFloat()

void cvarAPI_t::SetFloat	(	string	cvarName,
		float	setValue
	)

Sets the specified console variable to a set floating-point value.

Parameters

cvarName	specifies the console variable to set.
setValue	specifies the value of said key.

SetInteger()

void cvarAPI_t::SetInteger	(	string	cvarName,
		int	setValue
	)

Sets the specified console variable to a set integer value.

Parameters

cvarName	specifies the console variable to set.
setValue	specifies the value of said key.

SetString()

void cvarAPI_t::SetString	(	string	cvarName,
		string	setValue
	)

Sets the specified console variable to a set string value.

Parameters

cvarName	specifies the console variable to set.
setValue	specifies the value of said key.

SetVector()

void cvarAPI_t::SetVector	(	string	cvarName,
		vector	setValue
	)

Sets the specified console variable to a set vector.

Parameters

cvarName	specifies the console variable to set.
setValue	specifies the value of said key.

---

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

• src/shared/api.h