Main Page | Modules | Data Structures | File List | Data Fields | Globals

Setting Options


Enumerations

enum  GS_OPTION { GS_OPTION_TIMEOUT = 0, GS_OPTION_COLORFILTER }
 Option types. More...

Functions

void GSSetOptBool (unsigned short option, unsigned char value)
 Sets an internal boolean for GameStat.
void GSSetOptInt (unsigned short option, int value)
 Sets an internal integer for GameStat.
unsigned char GSGetOptBool (unsigned short option)
 Gets an internal boolean for GameStat.
int GSGetOptInt (unsigned short option)
 Gets an internal integer for GameStat.

Enumeration Type Documentation

enum GS_OPTION
 

Option types.

Enumeration values:
GS_OPTION_TIMEOUT  int, Sets the timeout in milliseconds. default 1000.
GS_OPTION_COLORFILTER  bool, GS_TRUE = filter strings for color codes, GS_FALSE = no filtering. default GS_FALSE.


Function Documentation

unsigned char GSGetOptBool unsigned short  option  ) 
 

Gets an internal boolean for GameStat.

Parameters:
option Describes which option to get. Must be one of the boolean GS_OPTION_* enumerations.
Returns:
On success, the option's current value. On failure, GS_FALSE.
See also:
GS_OPTION

int GSGetOptInt unsigned short  option  ) 
 

Gets an internal integer for GameStat.

Parameters:
option Describes which option to get. Must be one of the integer GS_OPTION_* enumerations.
Returns:
On success, the option's current value. On failure, 0.
See also:
GS_OPTION

void GSSetOptBool unsigned short  option,
unsigned char  value
 

Sets an internal boolean for GameStat.

Parameters:
option Describes which option to set. Must be one of the boolean GS_OPTION_* enumerations.
value The value to set. Must be GS_TRUE or GS_FALSE.
See also:
GS_OPTION

void GSSetOptInt unsigned short  option,
int  value
 

Sets an internal integer for GameStat.

Parameters:
option Describes which option to set. Must be one of the integer GS_OPTION_* enumerations.
value The value to set.
See also:
GS_OPTION


Generated on Wed Oct 6 01:04:06 2004 for GameStat by  doxygen 1.3.9