userinfoAPI_t Struct Reference

About this class

UserInfo library.

Public Member Functions
string	GetString (entity clientEnt, string userKey)
	Returns the string value of a user info-key. More...
int	GetInteger (entity clientEnt, string userKey)
	Returns the integer value of a user info-key. More...
float	GetFloat (entity clientEnt, string userKey)
	Returns the floating-point value of a user info-key. More...
float	GetBool (entity clientEnt, string userKey)
	Returns the boolean value of a user info-key. More...
vector	GetVector (entity clientEnt, string userKey)
	Returns the vector value of a user info-key. More...
void	SetString (entity clientEnt, string userKey, string setValue)
	Server only. More...
void	SetInteger (entity clientEnt, string userKey, int setValue)
	Server only. More...
void	SetBool (entity clientEnt, string userKey, float setValue)
	Sets the specified user info-key to a set boolean value. More...
void	SetFloat (entity clientEnt, string userKey, float setValue)
	Server only. More...
void	SetVector (entity clientEnt, string userKey, vector setValue)
	Server only. More...

Member Function Documentation

GetBool()

float userinfoAPI_t::GetBool	(	entity	clientEnt,
		string	userKey
	)

Returns the boolean value of a user info-key.

Parameters

clientEnt	specifies which user to query.
userKey	specifies the user info-key to query.

Returns

The value in boolean form.

GetFloat()

float userinfoAPI_t::GetFloat	(	entity	clientEnt,
		string	userKey
	)

Returns the floating-point value of a user info-key.

Parameters

clientEnt	specifies which user to query.
userKey	specifies the user info-key to query.

Returns

The value in floating-point format.

GetInteger()

int userinfoAPI_t::GetInteger	(	entity	clientEnt,
		string	userKey
	)

Returns the integer value of a user info-key.

Parameters

clientEnt	specifies which user to query.
userKey	specifies the user info-key to query.

Returns

The value in integer format.

GetString()

string userinfoAPI_t::GetString	(	entity	clientEnt,
		string	userKey
	)

Returns the string value of a user info-key.

Parameters

clientEnt	specifies which user to query.
userKey	specifies the user info-key to query.

Returns

The value in string format.

GetVector()

vector userinfoAPI_t::GetVector	(	entity	clientEnt,
		string	userKey
	)

Returns the vector value of a user info-key.

Parameters

clientEnt	specifies which user to query.
userKey	specifies the user info-key to query.

Returns

The value in vector form.

SetBool()

void userinfoAPI_t::SetBool	(	entity	clientEnt,
		string	userKey,
		float	setValue
	)

Sets the specified user info-key to a set boolean value.

Parameters

clientEnt	specifies which user to query.
userKey	specifies the user info-key to set.
setValue	specifies the value of said key.

SetFloat()

void userinfoAPI_t::SetFloat	(	entity	clientEnt,
		string	userKey,
		float	setValue
	)

Server only.

Sets the specified user info-key to a set floating-point value.

Parameters

clientEnt	specifies which user to query.
userKey	specifies the user info-key to set.
setValue	specifies the value of said key.

SetInteger()

void userinfoAPI_t::SetInteger	(	entity	clientEnt,
		string	userKey,
		int	setValue
	)

Server only.

Sets the specified user info-key to a set integer value.

Parameters

clientEnt	specifies which user to query.
userKey	specifies the user info-key to set.
setValue	specifies the value of said key.

SetString()

void userinfoAPI_t::SetString	(	entity	clientEnt,
		string	userKey,
		string	setValue
	)

Server only.

Sets the specified user info-key to a set string value.

Parameters

clientEnt	specifies which user to query.
userKey	specifies the user info-key to set.
setValue	specifies the value of said key.

SetVector()

void userinfoAPI_t::SetVector	(	entity	clientEnt,
		string	userKey,
		vector	setValue
	)

Server only.

Sets the specified user info-key to a set vector.

Parameters

clientEnt	specifies which user to query.
userKey	specifies the user info-key to set.
setValue	specifies the value of said key.

---

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

• src/shared/api.h