qcsrc/common/mapinfo.qh

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