qcsrc/common/mapinfo.qh

   1 #ifndef MAPINFO_H
   2 #define MAPINFO_H
   3
   4 int MAPINFO_TYPE_ALL;
   5 entity MapInfo_Type_first;
   6 entity MapInfo_Type_last;
   7 .entity enemy; // internal next pointer
   8
   9 .int items; // game type ID
  10 .string netname; // game type name as in cvar (with g_ prefix)
  11 .string mdl; // game type short name
  12 .string message; // human readable name
  13 .float team; // does this gametype support teamplay?
  14 .string model2; // game type defaults
  15 .string gametype_description; // game type description
  16
  17 #define REGISTER_GAMETYPE(hname,sname,g_name,NAME,gteamplay,defaults,gdescription) \
  18         int MAPINFO_TYPE_##NAME; \
  19         entity MapInfo_Type##g_name; \
  20         void RegisterGametypes_##g_name() \
  21         { \
  22                 MAPINFO_TYPE_##NAME = MAPINFO_TYPE_ALL + 1; \
  23                 MAPINFO_TYPE_ALL |= MAPINFO_TYPE_##NAME; \
  24                 MapInfo_Type##g_name = spawn(); \
  25                 MapInfo_Type##g_name.items = MAPINFO_TYPE_##NAME; \
  26                 MapInfo_Type##g_name.netname = #g_name; \
  27                 MapInfo_Type##g_name.mdl = #sname; \
  28                 MapInfo_Type##g_name.message = hname; \
  29                 MapInfo_Type##g_name.team = gteamplay; \
  30                 MapInfo_Type##g_name.model2 = defaults; \
  31                 MapInfo_Type##g_name.gametype_description = gdescription; \
  32                 if(!MapInfo_Type_first) \
  33                         MapInfo_Type_first = MapInfo_Type##g_name; \
  34                 if(MapInfo_Type_last) \
  35                         MapInfo_Type_last.enemy = MapInfo_Type##g_name; \
  36                 MapInfo_Type_last = MapInfo_Type##g_name; \
  37         } \
  38         ACCUMULATE_FUNCTION(RegisterGametypes, RegisterGametypes_##g_name)
  39
  40 #define IS_GAMETYPE(NAME) \
  41         (MapInfo_LoadedGametype == MAPINFO_TYPE_##NAME)
  42
  43 REGISTER_GAMETYPE(_("Deathmatch"),dm,g_dm,DEATHMATCH,false,"timelimit=20 pointlimit=30 leadlimit=0",_("Kill all enemies"));
  44 #define g_dm IS_GAMETYPE(DEATHMATCH)
  45
  46 REGISTER_GAMETYPE(_("Last Man Standing"),lms,g_lms,LMS,false,"timelimit=20 lives=9 leadlimit=0",_("Survive and kill until the enemies have no lives left"));
  47 #define g_lms IS_GAMETYPE(LMS)
  48
  49 REGISTER_GAMETYPE(_("Race"),rc,g_race,RACE,false,"timelimit=20 qualifying_timelimit=5 laplimit=7 teamlaplimit=15 leadlimit=0",_("Race against other players to the finish line"));
  50 #define g_race IS_GAMETYPE(RACE)
  51
  52 REGISTER_GAMETYPE(_("Race CTS"),cts,g_cts,CTS,false,"timelimit=20 skill=-1",_("Race for fastest time"));
  53 #define g_cts IS_GAMETYPE(CTS)
  54
  55 REGISTER_GAMETYPE(_("Team Deathmatch"),tdm,g_tdm,TEAM_DEATHMATCH,true,"timelimit=20 pointlimit=50 teams=2 leadlimit=0",_("Kill all enemy teammates"));
  56 #define g_tdm IS_GAMETYPE(TEAM_DEATHMATCH)
  57
  58 REGISTER_GAMETYPE(_("Capture the Flag"),ctf,g_ctf,CTF,true,"timelimit=20 caplimit=10 leadlimit=6",_("Find and bring the enemy flag to your base to capture it"));
  59 #define g_ctf IS_GAMETYPE(CTF)
  60
  61 REGISTER_GAMETYPE(_("Clan Arena"),ca,g_ca,CA,true,"timelimit=20 pointlimit=10 teams=2 leadlimit=0",_("Kill all enemy teammates to win the round"));
  62 #define g_ca IS_GAMETYPE(CA)
  63
  64 REGISTER_GAMETYPE(_("Domination"),dom,g_domination,DOMINATION,true,"timelimit=20 pointlimit=200 teams=2 leadlimit=0",_("Capture all the control points to win"));
  65 #define g_domination IS_GAMETYPE(DOMINATION)
  66
  67 REGISTER_GAMETYPE(_("Key Hunt"),kh,g_keyhunt,KEYHUNT,true,"timelimit=20 pointlimit=1000 teams=3 leadlimit=0",_("Gather all the keys to win the round"));
  68 #define g_keyhunt IS_GAMETYPE(KEYHUNT)
  69
  70 REGISTER_GAMETYPE(_("Assault"),as,g_assault,ASSAULT,true,"timelimit=20",_("Destroy obstacles to find and destroy the enemy power core before time runs out"));
  71 #define g_assault IS_GAMETYPE(ASSAULT)
  72
  73 REGISTER_GAMETYPE(_("Onslaught"),ons,g_onslaught,ONSLAUGHT,true,"timelimit=20",_("Capture control points to reach and destroy the enemy generator"));
  74 #define g_onslaught IS_GAMETYPE(ONSLAUGHT)
  75
  76 REGISTER_GAMETYPE(_("Nexball"),nb,g_nexball,NEXBALL,true,"timelimit=20 pointlimit=5 leadlimit=0",_("XonSports"));
  77 #define g_nexball IS_GAMETYPE(NEXBALL)
  78
  79 REGISTER_GAMETYPE(_("Freeze Tag"),ft,g_freezetag,FREEZETAG,true,"timelimit=20 pointlimit=10 teams=2 leadlimit=0",_("Kill enemies to freeze them, stand next to teammates to revive them"));
  80 #define g_freezetag IS_GAMETYPE(FREEZETAG)
  81
  82 REGISTER_GAMETYPE(_("Keepaway"),ka,g_keepaway,KEEPAWAY,true,"timelimit=20 pointlimit=30",_("Hold the ball to get points for kills"));
  83 #define g_keepaway IS_GAMETYPE(KEEPAWAY)
  84
  85 REGISTER_GAMETYPE(_("Invasion"),inv,g_invasion,INVASION,false,"pointlimit=50 teams=0",_("Survive against waves of monsters"));
  86 #define g_invasion IS_GAMETYPE(INVASION)
  87
  88 const int MAPINFO_FEATURE_WEAPONS       = 1; // not defined for instagib-only maps
  89 const int MAPINFO_FEATURE_VEHICLES      = 2;
  90 const int MAPINFO_FEATURE_TURRETS       = 4;
  91 const int MAPINFO_FEATURE_MONSTERS      = 8;
  92
  93 const int MAPINFO_FLAG_HIDDEN           = 1; // not in lsmaps/menu/vcall/etc., can just be changed to manually
  94 const int MAPINFO_FLAG_FORBIDDEN        = 2; // don't even allow the map by a cvar setting that allows hidden maps
  95 const int MAPINFO_FLAG_FRUSTRATING      = 4; // this map is near impossible to play, enable at your own risk
  96 const int MAPINFO_FLAG_NOAUTOMAPLIST    = 8; // do not include when automatically building maplist (counts as hidden for maplist building purposes)
  97
  98 float MapInfo_count;
  99
 100 // info about a map that MapInfo loads
 101 string MapInfo_Map_bspname;
 102 string MapInfo_Map_title;
 103 string MapInfo_Map_titlestring; // either bspname: title or just title, depending on whether bspname is redundant
 104 string MapInfo_Map_description;
 105 string MapInfo_Map_author;
 106 string MapInfo_Map_clientstuff; // not in cache, only for map load
 107 string MapInfo_Map_fog; // not in cache, only for map load
 108 int MapInfo_Map_supportedGametypes;
 109 int MapInfo_Map_supportedFeatures;
 110 int MapInfo_Map_flags;
 111 vector MapInfo_Map_mins; // these are '0 0 0' if not supported!
 112 vector MapInfo_Map_maxs; // these are '0 0 0' if not specified!
 113
 114 // load MapInfo_count; generate mapinfo for maps that miss them, and clear the
 115 // cache; you need to call MapInfo_FilterGametype afterwards!
 116 void MapInfo_Enumerate();
 117
 118 // filter the info by game type mask (updates MapInfo_count)
 119 float MapInfo_progress;
 120 float MapInfo_FilterGametype(float gametype, float features, float pFlagsRequired, float pFlagsForbidden, float pAbortOnGenerate); // 1 on success, 0 on temporary failure (call it again next frame then; use MapInfo_progress as progress indicator)
 121 int MapInfo_CurrentFeatures(); // retrieves currently required features from cvars
 122 int MapInfo_CurrentGametype(); // retrieves current gametype from cvars
 123 int MapInfo_ForbiddenFlags(); // retrieves current flags from cvars
 124 int MapInfo_RequiredFlags(); // retrieves current flags from cvars
 125
 126 // load info about the i-th map into the MapInfo_Map_* globals
 127 float MapInfo_Get_ByID(float i); // 1 on success, 0 on failure
 128 string MapInfo_BSPName_ByID(float i);
 129
 130 // load info about a map by name into the MapInfo_Map_* globals
 131 float MapInfo_Get_ByName(string s, float allowGenerate, float gametypeToSet); // 1 on success, 0 on failure, 2 if it autogenerated a mapinfo file
 132
 133 // look for a map by a prefix, returns the actual map name on success, string_null on failure or ambigous match
 134 string MapInfo_FindName_match; // the name of the map that was found
 135 float MapInfo_FindName_firstResult; // -1 if none were found, index of first one if not unique but found (FindName then returns -1)
 136 float MapInfo_FindName(string s);
 137 string MapInfo_FixName(string s);
 138
 139 // play a map
 140 float MapInfo_CheckMap(string s); // returns 0 if the map can't be played with the current settings
 141 void MapInfo_LoadMap(string s, float reinit);
 142
 143 // list all maps for the current game type
 144 string MapInfo_ListAllowedMaps(float type, float pFlagsRequired, float pFlagsForbidden);
 145 // list all allowed maps (for any game type)
 146 string MapInfo_ListAllAllowedMaps(float pFlagsRequired, float pFlagsForbidden);
 147
 148 // gets a gametype from a string
 149 string _MapInfo_GetDefaultEx(float t);
 150 float _MapInfo_GetTeamPlayBool(float t);
 151 float MapInfo_Type_FromString(string t);
 152 string MapInfo_Type_Description(float t);
 153 string MapInfo_Type_ToString(float t);
 154 string MapInfo_Type_ToText(float t);
 155 void MapInfo_SwitchGameType(float t);
 156
 157 // to be called from worldspawn to set up cvars
 158 void MapInfo_LoadMapSettings(string s);
 159 float MapInfo_LoadedGametype; // game type that was active during map load
 160
 161 void MapInfo_Cache_Destroy(); // disable caching
 162 void MapInfo_Cache_Create(); // enable caching
 163 void MapInfo_Cache_Invalidate(); // delete cache if any, but keep enabled
 164
 165 void MapInfo_ClearTemps(); // call this when done with mapinfo for this frame
 166
 167 void MapInfo_Shutdown(); // call this in the shutdown handler
 168
 169 #define MAPINFO_SETTEMP_ACL_USER cvar_string("g_mapinfo_settemp_acl")
 170 #define MAPINFO_SETTEMP_ACL_SYSTEM "-g_mapinfo_* -rcon_* -_* -g_ban* +*"
 171 #endif