qcsrc/common/mapinfo.qh

   1 #pragma once
   2
   3 #include "util.qh"
   4
   5 // info about a map that MapInfo loads
   6 string MapInfo_Map_bspname;
   7 string MapInfo_Map_title;
   8 string MapInfo_Map_titlestring; // either bspname: title or just title, depending on whether bspname is redundant
   9 string MapInfo_Map_description;
  10 string MapInfo_Map_author;
  11 string MapInfo_Map_clientstuff; // not in cache, only for map load
  12 string MapInfo_Map_fog; // not in cache, only for map load
  13 int MapInfo_Map_supportedGametypes;
  14 int MapInfo_Map_supportedFeatures;
  15 int MapInfo_Map_flags;
  16 vector MapInfo_Map_mins; // these are '0 0 0' if not supported!
  17 vector MapInfo_Map_maxs; // these are '0 0 0' if not specified!
  18
  19 const int GAMETYPE_FLAG_TEAMPLAY        = BIT(0); // teamplay based
  20 const int GAMETYPE_FLAG_USEPOINTS       = BIT(1); // gametype has point-based scoring
  21 const int GAMETYPE_FLAG_PREFERRED       = BIT(2); // preferred (when available) in random selections
  22 const int GAMETYPE_FLAG_PRIORITY        = BIT(3); // priority selection when preferred gametype isn't available in random selections
  23 const int GAMETYPE_FLAG_HIDELIMITS      = BIT(4); // don't display a score limit needed for winning the match in the scoreboard
  24 const int GAMETYPE_FLAG_WEAPONARENA     = BIT(5); // gametype has a forced weapon arena, weapon arena mutators should disable themselves when this is set
  25
  26 int MAPINFO_TYPE_ALL;
  27 .int m_flags;
  28
  29 CLASS(Gametype, Object)
  30     ATTRIB(Gametype, m_id, int, 0);
  31     /** game type ID */
  32     ATTRIB(Gametype, items, int, 0);
  33     /** game type name as in cvar (with g_ prefix) */
  34     ATTRIB(Gametype, netname, string);
  35     /** game type short name */
  36     ATTRIB(Gametype, mdl, string);
  37     /** human readable name */
  38     ATTRIB(Gametype, message, string);
  39     /** does this gametype support teamplay? */
  40     ATTRIB(Gametype, team, bool, false);
  41     /** does this gametype use a point limit? */
  42     ATTRIB(Gametype, frags, bool, true);
  43     /** should this gametype display a score limit in the scoreboard? */
  44     ATTRIB(Gametype, m_hidelimits, bool, false);
  45     /** does this gametype enforce its own weapon arena? */
  46     ATTRIB(Gametype, m_weaponarena, bool, false);
  47     /** game type defaults */
  48     ATTRIB(Gametype, model2, string);
  49     /** game type description */
  50     ATTRIB(Gametype, gametype_description, string);
  51     /** game type priority in random selections */
  52     ATTRIB(Gametype, m_priority, int, 0);
  53 #ifdef CSQC
  54     ATTRIB(Gametype, m_modicons, void(vector pos, vector mySize));
  55     ATTRIB(Gametype, m_modicons_reset, void());
  56     ATTRIB(Gametype, m_modicons_export, void(int fh));
  57 #endif
  58
  59     /** DO NOT USE, this is compatibility for legacy maps! */
  60     ATTRIB(Gametype, m_legacydefaults, string, "");
  61
  62     ATTRIB(Gametype, m_mutators, string);
  63     METHOD(Gametype, m_parse_mapinfo, bool(string k, string v))
  64     {
  65         return false;
  66     }
  67     METHOD(Gametype, m_generate_mapinfo, void(Gametype this, string v))
  68     {
  69         TC(Gametype, this);
  70     }
  71     METHOD(Gametype, m_isTwoBaseMode, bool())
  72     {
  73         return false;
  74     }
  75     METHOD(Gametype, m_isAlwaysSupported, bool(Gametype this, int spawnpoints, float diameter))
  76     {
  77         return false;
  78     }
  79     METHOD(Gametype, m_isForcedSupported, bool(Gametype this))
  80     {
  81         return false;
  82     }
  83     METHOD(Gametype, m_configuremenu, void(Gametype this, entity menu, void(entity me, string pLabel, float pMin, float pMax, float pStep, string pCvar, string tCvar, string pTooltip) returns))
  84     {
  85         TC(Gametype, this);
  86         returns(menu, _("Frag limit:"),      5,  100,  5, "fraglimit_override",        string_null,                    _("The amount of frags needed before the match will end"));
  87     }
  88
  89     METHOD(Gametype, describe, string(Gametype this))
  90     {
  91         TC(Gametype, this);
  92         return this.gametype_description;
  93     }
  94
  95     METHOD(Gametype, display, void(Gametype this, void(string name, string icon) returns))
  96     {
  97         TC(Gametype, this);
  98         returns(this.message, strcat("gametype_", this.mdl));
  99     }
 100
 101     METHOD(Gametype, gametype_init, void(Gametype this, string hname, string sname, string g_name, int gflags, string mutators, string defaults, string gdescription))
 102     {
 103         this.netname = g_name;
 104         this.mdl = sname;
 105         this.message = hname;
 106         this.team = (gflags & GAMETYPE_FLAG_TEAMPLAY);
 107         this.m_mutators = cons(sname, mutators);
 108         this.model2 = defaults;
 109         this.gametype_description = gdescription;
 110         this.frags = (gflags & GAMETYPE_FLAG_USEPOINTS);
 111         this.m_priority = ((gflags & GAMETYPE_FLAG_PREFERRED) ? 2 : ((gflags & GAMETYPE_FLAG_PRIORITY) ? 1 : 0));
 112         this.m_hidelimits = (gflags & GAMETYPE_FLAG_HIDELIMITS);
 113         this.m_weaponarena = (gflags & GAMETYPE_FLAG_WEAPONARENA);
 114
 115         // same as `1 << m_id`
 116         MAPINFO_TYPE_ALL |= this.items = this.m_flags = (MAPINFO_TYPE_ALL + 1);
 117     }
 118 ENDCLASS(Gametype)
 119
 120 REGISTRY(Gametypes, 32)
 121 REGISTER_REGISTRY(Gametypes)
 122 REGISTRY_SORT(Gametypes);
 123 REGISTRY_CHECK(Gametypes)
 124
 125 REGISTRY_DEFINE_GET(Gametypes, NULL)
 126 STATIC_INIT(Gametypes_renumber) { FOREACH(Gametypes, true, it.m_id = i); }
 127 #define REGISTER_GAMETYPE(NAME, inst) REGISTER(Gametypes, MAPINFO_TYPE, NAME, m_id, inst)
 128
 129 #define IS_GAMETYPE(NAME) (MapInfo_LoadedGametype == MAPINFO_TYPE_##NAME)
 130
 131 const int MAPINFO_FEATURE_WEAPONS       = 1; // not defined for instagib-only maps
 132 const int MAPINFO_FEATURE_VEHICLES      = 2;
 133 const int MAPINFO_FEATURE_TURRETS       = 4;
 134 const int MAPINFO_FEATURE_MONSTERS      = 8;
 135
 136 const int MAPINFO_FLAG_HIDDEN           = 1; // not in lsmaps/menu/vcall/etc., can just be changed to manually
 137 const int MAPINFO_FLAG_FORBIDDEN        = 2; // don't even allow the map by a cvar setting that allows hidden maps
 138 const int MAPINFO_FLAG_FRUSTRATING      = 4; // this map is near impossible to play, enable at your own risk
 139 const int MAPINFO_FLAG_NOAUTOMAPLIST    = 8; // do not include when automatically building maplist (counts as hidden for maplist building purposes)
 140
 141 float MapInfo_count;
 142
 143 // load MapInfo_count; generate mapinfo for maps that miss them, and clear the
 144 // cache; you need to call MapInfo_FilterGametype afterwards!
 145 void MapInfo_Enumerate();
 146
 147 // filter the info by game type mask (updates MapInfo_count)
 148 float MapInfo_progress;
 149 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)
 150 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)
 151 void MapInfo_FilterString(string sf); // filter _MapInfo_filtered (created by MapInfo_FilterGametype) with keyword
 152 int MapInfo_CurrentFeatures(); // retrieves currently required features from cvars
 153 Gametype MapInfo_CurrentGametype(); // retrieves current gametype from cvars
 154 int MapInfo_ForbiddenFlags(); // retrieves current flags from cvars
 155 int MapInfo_RequiredFlags(); // retrieves current flags from cvars
 156
 157 // load info about the i-th map into the MapInfo_Map_* globals
 158 bool MapInfo_Get_ByID(int i); // 1 on success, 0 on failure
 159 string MapInfo_BSPName_ByID(float i);
 160
 161 // load info about a map by name into the MapInfo_Map_* globals
 162 int MapInfo_Get_ByName(string s, float allowGenerate, Gametype gametypeToSet); // 1 on success, 0 on failure, 2 if it autogenerated a mapinfo file
 163
 164 // look for a map by a prefix, returns the actual map name on success, string_null on failure or ambigous match
 165 string MapInfo_FindName_match; // the name of the map that was found
 166 float MapInfo_FindName_firstResult; // -1 if none were found, index of first one if not unique but found (FindName then returns -1)
 167 float MapInfo_FindName(string s);
 168 string MapInfo_FixName(string s);
 169
 170 // play a map
 171 float MapInfo_CheckMap(string s); // returns 0 if the map can't be played with the current settings
 172 void MapInfo_LoadMap(string s, float reinit);
 173
 174 // list all maps for the current game type
 175 string MapInfo_ListAllowedMaps(Gametype type, float pFlagsRequired, float pFlagsForbidden);
 176 // list all allowed maps (for any game type)
 177 string MapInfo_ListAllAllowedMaps(float pFlagsRequired, float pFlagsForbidden);
 178
 179 // gets a gametype from a string
 180 string _MapInfo_GetDefaultEx(Gametype t);
 181 float _MapInfo_GetTeamPlayBool(Gametype t);
 182 Gametype MapInfo_Type_FromString(string t, bool dowarn);
 183 string MapInfo_Type_Description(Gametype t);
 184 string MapInfo_Type_ToString(Gametype t);
 185 string MapInfo_Type_ToText(Gametype t);
 186 void MapInfo_SwitchGameType(Gametype t);
 187
 188 // to be called from worldspawn to set up cvars
 189 void MapInfo_LoadMapSettings(string s);
 190 Gametype MapInfo_LoadedGametype; // game type that was active during map load
 191
 192 void MapInfo_Cache_Destroy(); // disable caching
 193 void MapInfo_Cache_Create(); // enable caching
 194 void MapInfo_Cache_Invalidate(); // delete cache if any, but keep enabled
 195
 196 void _MapInfo_Parse_Settemp(string pFilename, string acl, float type, string s, float recurse);
 197
 198 void MapInfo_ClearTemps(); // call this when done with mapinfo for this frame
 199
 200 void MapInfo_Shutdown(); // call this in the shutdown handler
 201
 202 #define MAPINFO_SETTEMP_ACL_USER cvar_string("g_mapinfo_settemp_acl")
 203 #define MAPINFO_SETTEMP_ACL_SYSTEM "-g_mapinfo_* -rcon_* -_* -g_ban* +*"