qcsrc/common/mapinfo.qh

   1 #ifndef MAPINFO_H
   2 #define MAPINFO_H
   3
   4 #include "util.qh"
   5
   6 CLASS(Gametype, Object)
   7     ATTRIB(Gametype, m_id, int, 0)
   8     /** game type ID */
   9     ATTRIB(Gametype, items, int, 0)
  10     /** game type name as in cvar (with g_ prefix) */
  11     ATTRIB(Gametype, netname, string, string_null)
  12     /** game type short name */
  13     ATTRIB(Gametype, mdl, string, string_null)
  14     /** human readable name */
  15     ATTRIB(Gametype, message, string, string_null)
  16     /** does this gametype support teamplay? */
  17     ATTRIB(Gametype, team, bool, false)
  18     /** game type defaults */
  19     ATTRIB(Gametype, model2, string, string_null)
  20     /** game type description */
  21     ATTRIB(Gametype, gametype_description, string, string_null)
  22
  23     ATTRIB(Gametype, m_mutators, string, string_null)
  24     ATTRIB(Gametype, m_parse_mapinfo, bool(string k, string v), func_null)
  25
  26     METHOD(Gametype, describe, string(entity this)) { return this.gametype_description; }
  27
  28     METHOD(Gametype, display, void(entity this, void(string name, string icon) returns)) {
  29         returns(this.message, strcat("gametype_", this.mdl));
  30     }
  31
  32     CONSTRUCTOR(Gametype, string hname, string sname, string g_name, bool gteamplay, string mutators, string defaults, string gdescription)
  33     {
  34         CONSTRUCT(Gametype);
  35         this.netname = g_name;
  36         this.mdl = sname;
  37         this.message = hname;
  38         this.team = gteamplay;
  39         this.m_mutators = mutators;
  40         this.model2 = defaults;
  41         this.gametype_description = gdescription;
  42     }
  43 ENDCLASS(Gametype)
  44
  45 REGISTRY(Gametypes, BITS(4))
  46 #define Gametypes_from(i) _Gametypes_from(i, NULL)
  47 REGISTER_REGISTRY(RegisterGametypes)
  48 REGISTRY_CHECK(Gametypes)
  49 int MAPINFO_TYPE_ALL;
  50 #define REGISTER_GAMETYPE(hname, sname, g_name, NAME, gteamplay, mutators, defaults, gdescription)          \
  51     int MAPINFO_TYPE_##NAME;                                                                                \
  52     bool NAME##_mapinfo(string k, string v) { return = false; }                                             \
  53     REGISTER(RegisterGametypes, MAPINFO_TYPE, Gametypes, g_name, m_id,                                      \
  54         NEW(Gametype, hname, #sname, #g_name, gteamplay, #sname " " mutators, defaults, gdescription)       \
  55     ) {                                                                                                     \
  56         /* same as `1 << m_id` */                                                                           \
  57         MAPINFO_TYPE_##NAME = MAPINFO_TYPE_ALL + 1; MAPINFO_TYPE_ALL |= MAPINFO_TYPE_##NAME;                \
  58         this.items = MAPINFO_TYPE_##NAME;                                                                   \
  59         this.m_parse_mapinfo = NAME##_mapinfo;                                                              \
  60     }                                                                                                       \
  61     [[accumulate]] bool NAME##_mapinfo(string k, string v)
  62
  63 #define IS_GAMETYPE(NAME) \
  64     (MapInfo_LoadedGametype == MAPINFO_TYPE_##NAME)
  65
  66 REGISTER_GAMETYPE(_("Deathmatch"),dm,g_dm,DEATHMATCH,false,"","timelimit=20 pointlimit=30 leadlimit=0",_("Score as many frags as you can"));
  67
  68 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"));
  69
  70 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"))
  71 {
  72     if (!k) {
  73         cvar_set("g_race_qualifying_timelimit", cvar_defstring("g_race_qualifying_timelimit"));
  74         return true;
  75     }
  76     switch (k) {
  77         case "qualifying_timelimit":
  78             cvar_set("g_race_qualifying_timelimit", v);
  79             return true;
  80     }
  81 }
  82 #define g_race IS_GAMETYPE(RACE)
  83
  84 REGISTER_GAMETYPE(_("Race CTS"),cts,g_cts,CTS,false,"cloaked","timelimit=20",_("Race for fastest time."));
  85 #define g_cts IS_GAMETYPE(CTS)
  86
  87 REGISTER_GAMETYPE(_("Team Deathmatch"),tdm,g_tdm,TEAM_DEATHMATCH,true,"","timelimit=20 pointlimit=50 teams=2 leadlimit=0",_("Help your team score the most frags against the enemy team"))
  88 {
  89     if (!k) {
  90         cvar_set("g_tdm_teams", cvar_defstring("g_tdm_teams"));
  91         return true;
  92     }
  93     switch (k) {
  94         case "teams":
  95             cvar_set("g_tdm_teams", v);
  96             return true;
  97     }
  98 }
  99 #define g_tdm IS_GAMETYPE(TEAM_DEATHMATCH)
 100
 101 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, defend your base from the other team"));
 102 #define g_ctf IS_GAMETYPE(CTF)
 103
 104 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"))
 105 {
 106     if (!k) {
 107         cvar_set("g_ca_teams", cvar_defstring("g_ca_teams"));
 108         return true;
 109     }
 110     switch (k) {
 111         case "teams":
 112             cvar_set("g_ca_teams", v);
 113             return true;
 114     }
 115 }
 116 #define g_ca IS_GAMETYPE(CA)
 117
 118 REGISTER_GAMETYPE(_("Domination"),dom,g_domination,DOMINATION,true,"","timelimit=20 pointlimit=200 teams=2 leadlimit=0",_("Capture and defend all the control points to win"))
 119 {
 120     if (!k) {
 121         cvar_set("g_domination_default_teams", cvar_defstring("g_domination_default_teams"));
 122         return true;
 123     }
 124     switch (k) {
 125         case "teams":
 126             cvar_set("g_domination_default_teams", v);
 127             return true;
 128     }
 129 }
 130
 131 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"))
 132 {
 133     if (!k) {
 134         cvar_set("g_keyhunt_teams", cvar_defstring("g_keyhunt_teams"));
 135         return true;
 136     }
 137     switch (k) {
 138         case "teams":
 139             cvar_set("g_keyhunt_teams", v);
 140             return true;
 141     }
 142 }
 143
 144 REGISTER_GAMETYPE(_("Assault"),as,g_assault,ASSAULT,true,"","timelimit=20",_("Destroy obstacles to find and destroy the enemy power core before time runs out"));
 145 #define g_assault IS_GAMETYPE(ASSAULT)
 146
 147 REGISTER_GAMETYPE(_("Onslaught"),ons,g_onslaught,ONSLAUGHT,true,"","pointlimit=1 timelimit=20",_("Capture control points to reach and destroy the enemy generator"));
 148
 149 REGISTER_GAMETYPE(_("Nexball"),nb,g_nexball,NEXBALL,true,"","timelimit=20 pointlimit=5 leadlimit=0",_("Shoot and kick the ball into the enemies goal, keep your goal clean"));
 150 #define g_nexball IS_GAMETYPE(NEXBALL)
 151
 152 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, freeze the most enemies to win"))
 153 {
 154     if (!k) {
 155         cvar_set("g_freezetag_teams", cvar_defstring("g_freezetag_teams"));
 156         return true;
 157     }
 158     switch (k) {
 159         case "teams":
 160             cvar_set("g_freezetag_teams", v);
 161             return true;
 162     }
 163 }
 164 #define g_freezetag IS_GAMETYPE(FREEZETAG)
 165
 166 REGISTER_GAMETYPE(_("Keepaway"),ka,g_keepaway,KEEPAWAY,true,"","timelimit=20 pointlimit=30",_("Hold the ball to get points for kills"));
 167
 168 REGISTER_GAMETYPE(_("Invasion"),inv,g_invasion,INVASION,false,"","pointlimit=50 teams=0",_("Survive against waves of monsters"))
 169 {
 170     switch (k) {
 171         case "teams":
 172             cvar_set("g_invasion_teams", v);
 173             return true;
 174     }
 175 }
 176
 177 const int MAPINFO_FEATURE_WEAPONS       = 1; // not defined for instagib-only maps
 178 const int MAPINFO_FEATURE_VEHICLES      = 2;
 179 const int MAPINFO_FEATURE_TURRETS       = 4;
 180 const int MAPINFO_FEATURE_MONSTERS      = 8;
 181
 182 const int MAPINFO_FLAG_HIDDEN           = 1; // not in lsmaps/menu/vcall/etc., can just be changed to manually
 183 const int MAPINFO_FLAG_FORBIDDEN        = 2; // don't even allow the map by a cvar setting that allows hidden maps
 184 const int MAPINFO_FLAG_FRUSTRATING      = 4; // this map is near impossible to play, enable at your own risk
 185 const int MAPINFO_FLAG_NOAUTOMAPLIST    = 8; // do not include when automatically building maplist (counts as hidden for maplist building purposes)
 186
 187 float MapInfo_count;
 188
 189 // info about a map that MapInfo loads
 190 string MapInfo_Map_bspname;
 191 string MapInfo_Map_title;
 192 string MapInfo_Map_titlestring; // either bspname: title or just title, depending on whether bspname is redundant
 193 string MapInfo_Map_description;
 194 string MapInfo_Map_author;
 195 string MapInfo_Map_clientstuff; // not in cache, only for map load
 196 string MapInfo_Map_fog; // not in cache, only for map load
 197 int MapInfo_Map_supportedGametypes;
 198 int MapInfo_Map_supportedFeatures;
 199 int MapInfo_Map_flags;
 200 vector MapInfo_Map_mins; // these are '0 0 0' if not supported!
 201 vector MapInfo_Map_maxs; // these are '0 0 0' if not specified!
 202
 203 // load MapInfo_count; generate mapinfo for maps that miss them, and clear the
 204 // cache; you need to call MapInfo_FilterGametype afterwards!
 205 void MapInfo_Enumerate();
 206
 207 // filter the info by game type mask (updates MapInfo_count)
 208 float MapInfo_progress;
 209 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)
 210 void MapInfo_FilterString(string sf); // filter _MapInfo_filtered (created by MapInfo_FilterGametype) with keyword
 211 int MapInfo_CurrentFeatures(); // retrieves currently required features from cvars
 212 int MapInfo_CurrentGametype(); // retrieves current gametype from cvars
 213 int MapInfo_ForbiddenFlags(); // retrieves current flags from cvars
 214 int MapInfo_RequiredFlags(); // retrieves current flags from cvars
 215
 216 // load info about the i-th map into the MapInfo_Map_* globals
 217 float MapInfo_Get_ByID(float i); // 1 on success, 0 on failure
 218 string MapInfo_BSPName_ByID(float i);
 219
 220 // load info about a map by name into the MapInfo_Map_* globals
 221 float MapInfo_Get_ByName(string s, float allowGenerate, float gametypeToSet); // 1 on success, 0 on failure, 2 if it autogenerated a mapinfo file
 222
 223 // look for a map by a prefix, returns the actual map name on success, string_null on failure or ambigous match
 224 string MapInfo_FindName_match; // the name of the map that was found
 225 float MapInfo_FindName_firstResult; // -1 if none were found, index of first one if not unique but found (FindName then returns -1)
 226 float MapInfo_FindName(string s);
 227 string MapInfo_FixName(string s);
 228
 229 // play a map
 230 float MapInfo_CheckMap(string s); // returns 0 if the map can't be played with the current settings
 231 void MapInfo_LoadMap(string s, float reinit);
 232
 233 // list all maps for the current game type
 234 string MapInfo_ListAllowedMaps(float type, float pFlagsRequired, float pFlagsForbidden);
 235 // list all allowed maps (for any game type)
 236 string MapInfo_ListAllAllowedMaps(float pFlagsRequired, float pFlagsForbidden);
 237
 238 // gets a gametype from a string
 239 string _MapInfo_GetDefaultEx(float t);
 240 float _MapInfo_GetTeamPlayBool(float t);
 241 Gametype MapInfo_Type(int t);
 242 float MapInfo_Type_FromString(string t);
 243 string MapInfo_Type_Description(float t);
 244 string MapInfo_Type_ToString(float t);
 245 string MapInfo_Type_ToText(float t);
 246 void MapInfo_SwitchGameType(int t);
 247
 248 // to be called from worldspawn to set up cvars
 249 void MapInfo_LoadMapSettings(string s);
 250 float MapInfo_LoadedGametype; // game type that was active during map load
 251
 252 void MapInfo_Cache_Destroy(); // disable caching
 253 void MapInfo_Cache_Create(); // enable caching
 254 void MapInfo_Cache_Invalidate(); // delete cache if any, but keep enabled
 255
 256 void MapInfo_ClearTemps(); // call this when done with mapinfo for this frame
 257
 258 void MapInfo_Shutdown(); // call this in the shutdown handler
 259
 260 #define MAPINFO_SETTEMP_ACL_USER cvar_string("g_mapinfo_settemp_acl")
 261 #define MAPINFO_SETTEMP_ACL_SYSTEM "-g_mapinfo_* -rcon_* -_* -g_ban* +*"
 262 #endif