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