4 bool autocvar_developer_mapper;
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
11 CLASS(Gametype, Object)
12 ATTRIB(Gametype, m_id, int, 0)
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)
28 ATTRIB(Gametype, m_mutators, string, string_null)
29 ATTRIB(Gametype, m_parse_mapinfo, bool(string k, string v), func_null)
31 METHOD(Gametype, describe, string(entity this)) { return this.gametype_description; }
33 METHOD(Gametype, display, void(entity this, void(string name, string icon) returns)) {
34 returns(this.message, strcat("gametype_", this.mdl));
37 CONSTRUCTOR(Gametype, string hname, string sname, string g_name, bool gteamplay, string mutators, string defaults, string gdescription)
40 this.netname = g_name;
43 this.team = gteamplay;
44 this.m_mutators = mutators;
45 this.model2 = defaults;
46 this.gametype_description = gdescription;
50 REGISTRY(Gametypes, BITS(4))
51 #define Gametypes_from(i) _Gametypes_from(i, NULL)
52 REGISTER_REGISTRY(Gametypes)
53 REGISTRY_CHECK(Gametypes)
55 #define REGISTER_GAMETYPE(hname, sname, g_name, NAME, gteamplay, mutators, defaults, gdescription) \
56 int MAPINFO_TYPE_##NAME; \
57 bool NAME##_mapinfo(string k, string v) { return = false; } \
58 REGISTER(Gametypes, MAPINFO_TYPE, g_name, m_id, \
59 NEW(Gametype, hname, #sname, #g_name, gteamplay, #sname " " mutators, defaults, gdescription) \
61 /* same as `1 << m_id` */ \
62 MAPINFO_TYPE_##NAME = MAPINFO_TYPE_ALL + 1; MAPINFO_TYPE_ALL |= MAPINFO_TYPE_##NAME; \
63 this.items = MAPINFO_TYPE_##NAME; \
64 this.m_parse_mapinfo = NAME##_mapinfo; \
66 [[accumulate]] bool NAME##_mapinfo(string k, string v)
68 #define IS_GAMETYPE(NAME) \
69 (MapInfo_LoadedGametype == MAPINFO_TYPE_##NAME)
71 REGISTER_GAMETYPE(_("Deathmatch"),dm,g_dm,DEATHMATCH,false,"","timelimit=20 pointlimit=30 leadlimit=0",_("Score as many frags as you can"));
73 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"));
75 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"))
78 cvar_set("g_race_qualifying_timelimit", cvar_defstring("g_race_qualifying_timelimit"));
82 case "qualifying_timelimit":
83 cvar_set("g_race_qualifying_timelimit", v);
87 #define g_race IS_GAMETYPE(RACE)
89 REGISTER_GAMETYPE(_("Race CTS"),cts,g_cts,CTS,false,"cloaked","timelimit=20",_("Race for fastest time."));
90 #define g_cts IS_GAMETYPE(CTS)
92 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"))
95 cvar_set("g_tdm_teams", cvar_defstring("g_tdm_teams"));
100 cvar_set("g_tdm_teams", v);
104 #define g_tdm IS_GAMETYPE(TEAM_DEATHMATCH)
106 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"));
107 #define g_ctf IS_GAMETYPE(CTF)
109 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"))
112 cvar_set("g_ca_teams", cvar_defstring("g_ca_teams"));
117 cvar_set("g_ca_teams", v);
121 #define g_ca IS_GAMETYPE(CA)
123 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"))
126 cvar_set("g_domination_default_teams", cvar_defstring("g_domination_default_teams"));
131 cvar_set("g_domination_default_teams", v);
136 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"))
139 cvar_set("g_keyhunt_teams", cvar_defstring("g_keyhunt_teams"));
144 cvar_set("g_keyhunt_teams", v);
149 REGISTER_GAMETYPE(_("Assault"),as,g_assault,ASSAULT,true,"","timelimit=20",_("Destroy obstacles to find and destroy the enemy power core before time runs out"));
150 #define g_assault IS_GAMETYPE(ASSAULT)
152 REGISTER_GAMETYPE(_("Onslaught"),ons,g_onslaught,ONSLAUGHT,true,"","pointlimit=1 timelimit=20",_("Capture control points to reach and destroy the enemy generator"));
154 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"));
155 #define g_nexball IS_GAMETYPE(NEXBALL)
157 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"))
160 cvar_set("g_freezetag_teams", cvar_defstring("g_freezetag_teams"));
165 cvar_set("g_freezetag_teams", v);
169 #define g_freezetag IS_GAMETYPE(FREEZETAG)
171 REGISTER_GAMETYPE(_("Keepaway"),ka,g_keepaway,KEEPAWAY,true,"","timelimit=20 pointlimit=30",_("Hold the ball to get points for kills"));
173 REGISTER_GAMETYPE(_("Invasion"),inv,g_invasion,INVASION,false,"","pointlimit=50 teams=0",_("Survive against waves of monsters"))
177 cvar_set("g_invasion_teams", v);
182 const int MAPINFO_FEATURE_WEAPONS = 1; // not defined for instagib-only maps
183 const int MAPINFO_FEATURE_VEHICLES = 2;
184 const int MAPINFO_FEATURE_TURRETS = 4;
185 const int MAPINFO_FEATURE_MONSTERS = 8;
187 const int MAPINFO_FLAG_HIDDEN = 1; // not in lsmaps/menu/vcall/etc., can just be changed to manually
188 const int MAPINFO_FLAG_FORBIDDEN = 2; // don't even allow the map by a cvar setting that allows hidden maps
189 const int MAPINFO_FLAG_FRUSTRATING = 4; // this map is near impossible to play, enable at your own risk
190 const int MAPINFO_FLAG_NOAUTOMAPLIST = 8; // do not include when automatically building maplist (counts as hidden for maplist building purposes)
194 // info about a map that MapInfo loads
195 string MapInfo_Map_bspname;
196 string MapInfo_Map_title;
197 string MapInfo_Map_titlestring; // either bspname: title or just title, depending on whether bspname is redundant
198 string MapInfo_Map_description;
199 string MapInfo_Map_author;
200 string MapInfo_Map_clientstuff; // not in cache, only for map load
201 string MapInfo_Map_fog; // not in cache, only for map load
202 int MapInfo_Map_supportedGametypes;
203 int MapInfo_Map_supportedFeatures;
204 int MapInfo_Map_flags;
205 vector MapInfo_Map_mins; // these are '0 0 0' if not supported!
206 vector MapInfo_Map_maxs; // these are '0 0 0' if not specified!
208 // load MapInfo_count; generate mapinfo for maps that miss them, and clear the
209 // cache; you need to call MapInfo_FilterGametype afterwards!
210 void MapInfo_Enumerate();
212 // filter the info by game type mask (updates MapInfo_count)
213 float MapInfo_progress;
214 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)
215 void MapInfo_FilterString(string sf); // filter _MapInfo_filtered (created by MapInfo_FilterGametype) with keyword
216 int MapInfo_CurrentFeatures(); // retrieves currently required features from cvars
217 int MapInfo_CurrentGametype(); // retrieves current gametype from cvars
218 int MapInfo_ForbiddenFlags(); // retrieves current flags from cvars
219 int MapInfo_RequiredFlags(); // retrieves current flags from cvars
221 // load info about the i-th map into the MapInfo_Map_* globals
222 float MapInfo_Get_ByID(float i); // 1 on success, 0 on failure
223 string MapInfo_BSPName_ByID(float i);
225 // load info about a map by name into the MapInfo_Map_* globals
226 float MapInfo_Get_ByName(string s, float allowGenerate, float gametypeToSet); // 1 on success, 0 on failure, 2 if it autogenerated a mapinfo file
228 // look for a map by a prefix, returns the actual map name on success, string_null on failure or ambigous match
229 string MapInfo_FindName_match; // the name of the map that was found
230 float MapInfo_FindName_firstResult; // -1 if none were found, index of first one if not unique but found (FindName then returns -1)
231 float MapInfo_FindName(string s);
232 string MapInfo_FixName(string s);
235 float MapInfo_CheckMap(string s); // returns 0 if the map can't be played with the current settings
236 void MapInfo_LoadMap(string s, float reinit);
238 // list all maps for the current game type
239 string MapInfo_ListAllowedMaps(float type, float pFlagsRequired, float pFlagsForbidden);
240 // list all allowed maps (for any game type)
241 string MapInfo_ListAllAllowedMaps(float pFlagsRequired, float pFlagsForbidden);
243 // gets a gametype from a string
244 string _MapInfo_GetDefaultEx(float t);
245 float _MapInfo_GetTeamPlayBool(float t);
246 Gametype MapInfo_Type(int t);
247 float MapInfo_Type_FromString(string t);
248 string MapInfo_Type_Description(float t);
249 string MapInfo_Type_ToString(float t);
250 string MapInfo_Type_ToText(float t);
251 void MapInfo_SwitchGameType(int t);
253 // to be called from worldspawn to set up cvars
254 void MapInfo_LoadMapSettings(string s);
255 float MapInfo_LoadedGametype; // game type that was active during map load
257 void MapInfo_Cache_Destroy(); // disable caching
258 void MapInfo_Cache_Create(); // enable caching
259 void MapInfo_Cache_Invalidate(); // delete cache if any, but keep enabled
261 void MapInfo_ClearTemps(); // call this when done with mapinfo for this frame
263 void MapInfo_Shutdown(); // call this in the shutdown handler
265 #define MAPINFO_SETTEMP_ACL_USER cvar_string("g_mapinfo_settemp_acl")
266 #define MAPINFO_SETTEMP_ACL_SYSTEM "-g_mapinfo_* -rcon_* -_* -g_ban* +*"