gamestat.h

Go to the documentation of this file.

/*
   Copyright (c) 2004 Cory Nelson

   Permission is hereby granted, free of charge, to any person obtaining
   a copy of this software and associated documentation files (the
   "Software"), to deal in the Software without restriction, including
   without limitation the rights to use, copy, modify, merge, publish,
   distribute, sublicense, and/or sell copies of the Software, and to
   permit persons to whom the Software is furnished to do so, subject to
   the following conditions:

   The above copyright notice and this permission notice shall be included
   in all copies or substantial portions of the Software.

   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
   IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
   CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
   TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
   SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/

#ifndef __GAMESTAT_H__
#define __GAMESTAT_H__

enum GS_BOOLEAN {
   GS_FALSE=0,             
   GS_TRUE                 
};

#ifndef __cplusplus

typedef struct GS_PLAYERINFO GS_PLAYERINFO;
typedef struct GS_PROPERTY GS_PROPERTY;
typedef struct GS_SERVERINFO GS_SERVERINFO;
typedef struct GS_SERVER GS_SERVER;
#endif

#ifdef __cplusplus
extern "C" {
#endif


enum GS_INITFLAGS {
   GS_INIT_NONE=0,         
   GS_INIT_WINSOCK=1       
};

enum GS_CLEANUPFLAGS {
   GS_CLEANUP_NONE=0,      
   GS_CLEANUP_WINSOCK=1    
};


unsigned char GSInit(unsigned char flags);


unsigned char GSCleanup(unsigned char flags);


unsigned short GSVersion(void);



enum GS_OPTION {
   GS_OPTION_TIMEOUT=0,    
   GS_OPTION_COLORFILTER   
};


void GSSetOptBool(unsigned short option, unsigned char value);


void GSSetOptInt(unsigned short option, int value);


unsigned char GSGetOptBool(unsigned short option);


int GSGetOptInt(unsigned short option);



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         
};

struct GS_PLAYERINFO {
   char *name;             
   int score;              
   int ping;               
   int time;               

   GS_PLAYERINFO *next;    
};

struct GS_PROPERTY {
   char *key;              
   char *value;            

   GS_PROPERTY *next;      
};

struct GS_SERVERINFO {
   char *host;                
   char *mod;                 
   char *map;                 

   int numplayers;            
   int maxplayers;            
   int timelimit;             
   int scorelimit;            

   GS_PROPERTY *properties;   
   GS_PLAYERINFO *players;    

   // added in 1.1
   int passworded;            
   int ping;                  
};


GS_SERVERINFO *GSQueryServer(unsigned short type, const char *host, unsigned short port);


void GSFreeServerInfo(GS_SERVERINFO *info);


char *GSStripColor(unsigned short type, char *out, const char *in);



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        
};

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   
};

struct GS_SERVER {
   char *host;             
   unsigned short port;    

   GS_SERVER *next;        
};


GS_SERVER *GSQueryMaster(unsigned short type, const char *host, unsigned short port, unsigned short filter);


void GSFreeServers(GS_SERVER *servers);



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     
};


unsigned short GSLastError(void);


const char *GSErrorString(unsigned short err);


const char *GSLastErrorString(void);


#ifdef __cplusplus
}
#endif

#endif

---