localinfoAPI_t Struct Reference

About this class

LocalInfo library.

Public Member Functions
string	GetString (string serverKey)
	Returns the string value of a server local (hidden-from-clients) info-key. More...
int	GetInteger (string serverKey)
	Returns the integer value of a server local (hidden-from-clients) info-key. More...
float	GetFloat (string serverKey)
	Returns the floating-point value of a server local (hidden-from-clients) info-key. More...
bool	GetBool (string serverKey)
	Returns the boolean value of a server local (hidden-from-clients) info-key. More...
vector	GetVector (string serverKey)
	Returns the vector value of a server local (hidden-from-clients) info-key. More...
void	SetString (string serverKey, string setValue)
	Server only. More...
void	SetInteger (string serverKey, int setValue)
	Server only. More...
void	SetBool (string serverKey, bool setValue)
	Server only. More...
void	SetFloat (string serverKey, float setValue)
	Server only. More...
void	SetVector (string serverKey, vector setValue)
	Server only. More...

Member Function Documentation

GetBool()

bool localinfoAPI_t::GetBool

(

string

serverKey

)

Returns the boolean value of a server local (hidden-from-clients) info-key.

Parameters

serverKey

specifies the server local (hidden-from-clients) info-key to query.

Returns

The value in boolean form.

GetFloat()

float localinfoAPI_t::GetFloat

(

string

serverKey

)

Returns the floating-point value of a server local (hidden-from-clients) info-key.

Parameters

serverKey

specifies the server local (hidden-from-clients) info-key to query.

Returns

The value in floating-point format.

GetInteger()

int localinfoAPI_t::GetInteger

(

string

serverKey

)

Returns the integer value of a server local (hidden-from-clients) info-key.

Parameters

serverKey

specifies the server local (hidden-from-clients) info-key to query.

Returns

The value in integer format.

GetString()

string localinfoAPI_t::GetString

(

string

serverKey

)

Returns the string value of a server local (hidden-from-clients) info-key.

Parameters

serverKey

specifies the server local (hidden-from-clients) info-key to query.

Returns

The value in string format.

GetVector()

vector localinfoAPI_t::GetVector

(

string

serverKey

)

Returns the vector value of a server local (hidden-from-clients) info-key.

Parameters

serverKey

specifies the server local (hidden-from-clients) info-key to query.

Returns

The value in vector form.

SetBool()

void localinfoAPI_t::SetBool	(	string	serverKey,
		bool	setValue
	)

Server only.

Sets the specified server local (hidden-from-clients) info-key to a set boolean value.

Parameters

serverKey	specifies the server local (hidden-from-clients) info-key to set.
setValue	specifies the value of said key.

SetFloat()

void localinfoAPI_t::SetFloat	(	string	serverKey,
		float	setValue
	)

Server only.

Sets the specified server local (hidden-from-clients) info-key to a set floating-point value.

Parameters

serverKey	specifies the server local (hidden-from-clients) info-key to set.
setValue	specifies the value of said key.

SetInteger()

void localinfoAPI_t::SetInteger	(	string	serverKey,
		int	setValue
	)

Server only.

Sets the specified server local (hidden-from-clients) info-key to a set integer value.

Parameters

serverKey	specifies the server local (hidden-from-clients) info-key to set.
setValue	specifies the value of said key.

SetString()

void localinfoAPI_t::SetString	(	string	serverKey,
		string	setValue
	)

Server only.

Sets the specified server local (hidden-from-clients) info-key to a set string value.

Parameters

serverKey	specifies the server local (hidden-from-clients) info-key to set.
setValue	specifies the value of said key.

SetVector()

void localinfoAPI_t::SetVector	(	string	serverKey,
		vector	setValue
	)

Server only.

Sets the specified server local (hidden-from-clients) info-key to a set vector.

Parameters

serverKey	specifies the server local (hidden-from-clients) info-key to set.
setValue	specifies the value of said key.

---

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

• src/server/api_func.h