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

gamestat.h File Reference

Defines all the public GameStat functions. More...

Go to the source code of this file.

Data Structures

struct  GS_PLAYERINFO
 A linked list containing player information. More...
struct  GS_PROPERTY
 A linked list containing miscellaneous server information. More...
struct  GS_SERVERINFO
 Server status information returned from GSQueryServer(). More...
struct  GS_SERVER
 A linked list of servers returned from GSQueryMaster(). More...

Typedefs

typedef GS_PLAYERINFO GS_PLAYERINFO
 Typedefs for non-C++ compilers.
typedef GS_PROPERTY GS_PROPERTY
 Typedefs for non-C++ compilers.
typedef GS_SERVERINFO GS_SERVERINFO
 Typedefs for non-C++ compilers.
typedef GS_SERVER GS_SERVER
 Typedefs for non-C++ compilers.

Enumerations

enum  GS_BOOLEAN { GS_FALSE = 0, GS_TRUE }
 Boolean values. More...
enum  GS_INITFLAGS { GS_INIT_NONE = 0, GS_INIT_WINSOCK = 1 }
 Initialization flags. More...
enum  GS_CLEANUPFLAGS { GS_CLEANUP_NONE = 0, GS_CLEANUP_WINSOCK = 1 }
 Cleanup flags. More...
enum  GS_OPTION { GS_OPTION_TIMEOUT = 0, GS_OPTION_COLORFILTER }
 Option types. More...
enum  GS_TYPE {
  GS_TYPE_QUAKEWORLD = 0, GS_TYPE_QUAKE2, GS_TYPE_QUAKE3, GS_TYPE_DOOM3,
  GS_TYPE_HALFLIFE, GS_TYPE_UNREAL2, GS_TYPE_GAMESPY2, GS_TYPE_BFV,
  GS_TYPE_PAINKILLER, GS_TYPE_UT2003, GS_TYPE_UT2004, GS_TYPE_UNREAL2XMP,
  GS_TYPE_SOF2, GS_TYPE_RTCW, GS_TYPE_WOLFET, GS_TYPE_CS,
  GS_TYPE_CSCZ, GS_TYPE_CALLOFDUTY, GS_TYPE_SWJKJA, GS_TYPE_MOHAA,
  GS_TYPE_MOHBT, GS_TYPE_MOHSH, GS_TYPE_DOD, GS_TYPE_SOF,
  GS_TYPE_GAMESPY, GS_TYPE_UT, GS_TYPE_SWJK2, GS_TYPE_DESCENT3,
  GS_TYPE_AMERICASARMY, GS_TYPE_BF1942, GS_TYPE_HALO, GS_TYPE_POSTAL2,
  GS_TYPE_STVEF, GS_TYPE_STVEF2, GS_TYPE_DEUSEX, GS_TYPE_IL2S,
  GS_TYPE_IL2SFB, GS_TYPE_SOURCE, GS_TYPE_HALFLIFE2, GS_TYPE_CSS,
  GS_TYPE_ASE, GS_TYPE_MTA, GS_TYPE_MTAVC, GS_TYPE_HERETIC2,
  GS_TYPE_IGI2, GS_TYPE_GORE, GS_TYPE_VIETCONG, GS_TYPE_NWN,
  GS_TYPE_SERIOUSSAM, GS_TYPE_SERIOUSSAM2, GS_TYPE_AOE2, GS_TYPE_AOE2TC,
  GS_TYPE_AVP2, GS_TYPE_CHASER, GS_TYPE_CHROME, GS_TYPE_NOLF,
  GS_TYPE_NOLF2, GS_TYPE_SHOGO, GS_TYPE_SOLDAT, GS_TYPE_CODENAMEEAGLE,
  GS_TYPE_DEVASTATION, GS_TYPE_GIANTSCK, GS_TYPE_GLOBALOPS, GS_TYPE_NERFAB,
  GS_TYPE_PURGEJIHAD, GS_TYPE_RSC, GS_TYPE_RALLYMASTERS, GS_TYPE_CCRENEGADE,
  GS_TYPE_RUNE, GS_TYPE_SIN, GS_TYPE_TACTICALOPS, GS_TYPE_UCOMBAT,
  GS_TYPE_UNREAL, GS_TYPE_WHEELOFTIME, GS_TYPE_XPANDRALLY, GS_TYPE_DDPT,
  GS_TYPE_DTR2, GS_TYPE_DRAKAN, GS_TYPE_F12002, GS_TYPE_GUNMAN,
  GS_TYPE_IRONSTORM, GS_TYPE_JBNF, GS_TYPE_KINGPIN, GS_TYPE_NFSHP2,
  GS_TYPE_OPFLASHPOINT, GS_TYPE_REDLINE, GS_TYPE_TERMINUS, GS_TYPE_TUROK2,
  GS_TYPE_TRON20, GS_TYPE_TRIBES, GS_TYPE_TRIBES2, GS_TYPE_THPS3,
  GS_TYPE_THPS4, GS_TYPE_V8SCC, GS_TYPE_TEAMFACTOR, GS_TYPE_RAINBOWSIX,
  GS_TYPE_RAINBOWSIXRS, GS_TYPE_NITRO, GS_TYPE_FARCRY, GS_TYPE_RISEOFNATIONS,
  GS_TYPE_CONTRACTJACK, GS_TYPE_HOMEWORLD2, GS_TYPE_DAIKATANA, GS_TYPE_SAVAGE,
  GS_TYPE_GHOSTRECON, GS_TYPE_BREED, GS_TYPE_MOHPA, GS_TYPE_OPFRESISTANCE,
  GS_TYPE_SOAF, GS_TYPE_STBC, GS_TYPE_CODUO, GS_TYPE_SWBF,
  GS_TYPE_TRIBES3
}
 Game server types. More...
enum  GS_MASTER {
  GS_MASTER_DOOM3 = 0, GS_MASTER_QUAKE3, GS_MASTER_QUAKE2, GS_MASTER_RTCW,
  GS_MASTER_WOLFET, GS_MASTER_SWJK2, GS_MASTER_HALFLIFE, GS_MASTER_CS,
  GS_MASTER_CSCZ, GS_MASTER_CSS, GS_MASTER_DOD, GS_MASTER_SOF2,
  GS_MASTER_SWJKJA, GS_MASTER_STVEF, GS_MASTER_STVEF2
}
 Master server types. More...
enum  GS_MASTER_FILTER {
  GS_MASTER_FILTER_NONE = 0, GS_MASTER_FILTER_FULL = 1, GS_MASTER_FILTER_NOTFULL = 2, GS_MASTER_FILTER_EMPTY = 4,
  GS_MASTER_FILTER_NOTEMPTY = 8, GS_MASTER_FILTER_PASSWORD = 16, GS_MASTER_FILTER_NOPASSWORD = 32
}
 Master server filters. More...
enum  GS_ERROR {
  GS_OK = 0, GS_ERROR_WINSOCK, GS_ERROR_UNKNOWNTYPE, GS_ERROR_UNKNOWNHOST,
  GS_ERROR_CONNECT, GS_ERROR_TIMEOUT, GS_ERROR_CORRUPT, GS_ERROR_UNKNOWNPORT,
  GS_ERROR_NOTIMPLEMENTED, GS_ERROR_INVALIDPARAMETER
}
 Error types. More...

Functions

unsigned char GSInit (unsigned char flags)
 Initializes GameStat.
unsigned char GSCleanup (unsigned char flags)
 Cleans up GameStat.
unsigned short GSVersion (void)
 Retrieves the current library version.
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.
GS_SERVERINFOGSQueryServer (unsigned short type, const char *host, unsigned short port)
 Queries a server for it's status information.
void GSFreeServerInfo (GS_SERVERINFO *info)
 Frees the status information returned by GSQueryServer().
char * GSStripColor (unsigned short type, char *out, const char *in)
 Strips any color or formatting from a string.
GS_SERVERGSQueryMaster (unsigned short type, const char *host, unsigned short port, unsigned short filter)
 Queries a master server for game servers.
void GSFreeServers (GS_SERVER *servers)
 Frees the server list returned by GSQueryMaster().
unsigned short GSLastError (void)
 Retrieves information on the last error, if any.
const char * GSErrorString (unsigned short err)
 Translates an error code into a human-readable string.
const char * GSLastErrorString (void)
 Retrieves information on the last error, if any.


Detailed Description

Defines all the public GameStat functions.


Enumeration Type Documentation

enum GS_BOOLEAN
 

Boolean values.

Enumeration values:
GS_FALSE  False.
GS_TRUE  True.


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