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

About this class

ServerInfo library.

Public Member Functions

string GetString (string serverKey)
 Returns the string value of a server info-key. More...
 
int GetInteger (string serverKey)
 Returns the integer value of a server info-key. More...
 
float GetFloat (string serverKey)
 Returns the floating-point value of a server info-key. More...
 
float GetBool (string serverKey)
 Returns the boolean value of a server info-key. More...
 
vector GetVector (string serverKey)
 Returns the vector value of a server 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, float 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()

float serverinfoAPI_t::GetBool ( string  serverKey)

Returns the boolean value of a server info-key.

Parameters
serverKeyspecifies the server info-key to query.
Returns
The value in boolean form.

◆ GetFloat()

float serverinfoAPI_t::GetFloat ( string  serverKey)

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

Parameters
serverKeyspecifies the server info-key to query.
Returns
The value in floating-point format.

◆ GetInteger()

int serverinfoAPI_t::GetInteger ( string  serverKey)

Returns the integer value of a server info-key.

Parameters
serverKeyspecifies the server info-key to query.
Returns
The value in integer format.

◆ GetString()

string serverinfoAPI_t::GetString ( string  serverKey)

Returns the string value of a server info-key.

Parameters
serverKeyspecifies the server info-key to query.
Returns
The value in string format.

◆ GetVector()

vector serverinfoAPI_t::GetVector ( string  serverKey)

Returns the vector value of a server info-key.

Parameters
serverKeyspecifies the server info-key to query.
Returns
The value in vector form.

◆ SetBool()

void serverinfoAPI_t::SetBool ( string  serverKey,
float  setValue 
)

Server only.

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

Parameters
serverKeyspecifies the server info-key to set.
setValuespecifies the value of said key.

◆ SetFloat()

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

Server only.

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

Parameters
serverKeyspecifies the server info-key to set.
setValuespecifies the value of said key.

◆ SetInteger()

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

Server only.

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

Parameters
serverKeyspecifies the server info-key to set.
setValuespecifies the value of said key.

◆ SetString()

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

Server only.

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

Parameters
serverKeyspecifies the server info-key to set.
setValuespecifies the value of said key.

◆ SetVector()

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

Server only.

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

Parameters
serverKeyspecifies the server info-key to set.
setValuespecifies the value of said key.

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