Nuclide
Software Development Kit for id Technology (BETA)
userinfoAPI_t Struct Reference

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)
 Sets the specified user info-key to a set string value. More...
 
void SetInteger (entity clientEnt, string userKey, int setValue)
 Sets the specified user info-key to a set integer value. 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)
 Sets the specified user info-key to a set floating-point value. More...
 
void SetVector (entity clientEnt, string userKey, vector setValue)
 Sets the specified user info-key to a set vector. More...
 

Member Function Documentation

◆ GetBool()

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

Returns the boolean value of a user info-key.

Parameters
clientEntspecifies which user to query.
userKeyspecifies 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
clientEntspecifies which user to query.
userKeyspecifies 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
clientEntspecifies which user to query.
userKeyspecifies 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
clientEntspecifies which user to query.
userKeyspecifies 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
clientEntspecifies which user to query.
userKeyspecifies 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
clientEntspecifies which user to query.
userKeyspecifies the user info-key to set.
setValuespecifies the value of said key.

◆ SetFloat()

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

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

Parameters
clientEntspecifies which user to query.
userKeyspecifies the user info-key to set.
setValuespecifies the value of said key.

◆ SetInteger()

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

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

Parameters
clientEntspecifies which user to query.
userKeyspecifies the user info-key to set.
setValuespecifies the value of said key.

◆ SetString()

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

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

Parameters
clientEntspecifies which user to query.
userKeyspecifies the user info-key to set.
setValuespecifies the value of said key.

◆ SetVector()

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

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

Parameters
clientEntspecifies which user to query.
userKeyspecifies the user info-key to set.
setValuespecifies the value of said key.

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