qcsrc/common/mapinfo.qh

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