declAPI_t Struct Reference

Public Member Functions
decl	New (void)
	Returns the name of a new decl in which you can store key/value pairs in. More...
string	GetString (decl declHandle, string keyName)
	Returns the string value of a key from a decl. More...
int	GetInteger (decl declHandle, string keyName)
	Returns the integer value of a decl key. More...
float	GetFloat (decl declHandle, string keyName)
	Returns the floating-point value of a decl key. More...
float	GetBool (decl declHandle, string keyName)
	Returns the boolean value of a decl key. More...
vector	GetVector (decl declHandle, string keyName)
	Returns the vector value of a decl key. More...
void	AddKey (decl declHandle, string keyName, string setValue)
	Adds/updates a named key within a decl with a new string value. More...
void	RemoveKey (decl declHandle, string keyName)
	Removes a named key from a decl entirely. More...
void	Delete (decl declHandle)
	Removes a named decl from the game. More...

Member Function Documentation

AddKey()

void declAPI_t::AddKey	(	decl	declHandle,
		string	keyName,
		string	setValue
	)

Adds/updates a named key within a decl with a new string value.

Parameters

declHandle	is the decl reference to update.
keyName	specifies the key to set.
setValue	specifies the value we'll set the key to.

Delete()

void declAPI_t::Delete

(

decl

declHandle

)

Removes a named decl from the game.

Parameters

declHandle

specifies the decl to delete.

GetBool()

float declAPI_t::GetBool	(	decl	declHandle,
		string	keyName
	)

Returns the boolean value of a decl key.

Parameters

declHandle	is the decl reference to update.
keyName	specifies the name of the key to query within the decl.

Returns

The key its value in boolean form.

GetFloat()

float declAPI_t::GetFloat	(	decl	declHandle,
		string	keyName
	)

Returns the floating-point value of a decl key.

Parameters

declHandle	is the decl reference to update.
keyName	specifies the name of the key to query within the decl.

Returns

The key its value in floating-point format.

GetInteger()

int declAPI_t::GetInteger	(	decl	declHandle,
		string	keyName
	)

Returns the integer value of a decl key.

Parameters

declHandle	is the decl reference to update.
keyName	specifies the name of the key to query within the decl.

Returns

The key its value in integer format.

GetString()

string declAPI_t::GetString	(	decl	declHandle,
		string	keyName
	)

Returns the string value of a key from a decl.

Parameters

declHandle	is the decl reference to update.
keyName	specifies the name of the key to query within the decl.

Returns

The key its value in string format.

GetVector()

vector declAPI_t::GetVector	(	decl	declHandle,
		string	keyName
	)

Returns the vector value of a decl key.

Parameters

declHandle	is the decl reference to update.
keyName	specifies the name of the key to query within the decl.

Returns

The key its value in vector form.

New()

decl declAPI_t::New

(

void

)

Returns the name of a new decl in which you can store key/value pairs in.

RemoveKey()

void declAPI_t::RemoveKey	(	decl	declHandle,
		string	keyName
	)

Removes a named key from a decl entirely.

Parameters

declHandle	is the decl reference to update.
keyName	specifies the key to remove.

---

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

• src/shared/api.h