3 #include "../client/defs.qh"
5 #include <common/weapons/_all.qh>
9 #include <common/monsters/_mod.qh>
13 #define WARN_COND false
15 bool autocvar_g_mapinfo_ignore_warnings;
16 #define WARN_COND (!autocvar_g_mapinfo_ignore_warnings && MapInfo_Map_bspname == mi_shortname)
19 // generic string stuff
21 int _MapInfo_Cache_Active;
22 int _MapInfo_Cache_DB_NameToIndex;
23 int _MapInfo_Cache_Buf_IndexToMapData;
25 void MapInfo_Cache_Destroy()
27 if(!_MapInfo_Cache_Active)
30 db_close(_MapInfo_Cache_DB_NameToIndex);
31 buf_del(_MapInfo_Cache_Buf_IndexToMapData);
32 _MapInfo_Cache_Active = 0;
35 void MapInfo_Cache_Create()
37 MapInfo_Cache_Destroy();
38 _MapInfo_Cache_DB_NameToIndex = db_create();
39 _MapInfo_Cache_Buf_IndexToMapData = buf_create();
40 _MapInfo_Cache_Active = 1;
43 void MapInfo_Cache_Invalidate()
45 if(!_MapInfo_Cache_Active)
48 MapInfo_Cache_Create();
51 void MapInfo_Cache_Store()
55 if(!_MapInfo_Cache_Active)
58 s = db_get(_MapInfo_Cache_DB_NameToIndex, MapInfo_Map_bspname);
61 i = buf_getsize(_MapInfo_Cache_Buf_IndexToMapData);
62 db_put(_MapInfo_Cache_DB_NameToIndex, MapInfo_Map_bspname, ftos(i));
67 // now store all the stuff
68 bufstr_set(_MapInfo_Cache_Buf_IndexToMapData, i, MapInfo_Map_bspname);
69 bufstr_set(_MapInfo_Cache_Buf_IndexToMapData, ++i, MapInfo_Map_title);
70 bufstr_set(_MapInfo_Cache_Buf_IndexToMapData, ++i, MapInfo_Map_titlestring);
71 bufstr_set(_MapInfo_Cache_Buf_IndexToMapData, ++i, MapInfo_Map_description);
72 bufstr_set(_MapInfo_Cache_Buf_IndexToMapData, ++i, MapInfo_Map_author);
73 bufstr_set(_MapInfo_Cache_Buf_IndexToMapData, ++i, ftos(MapInfo_Map_supportedGametypes));
74 bufstr_set(_MapInfo_Cache_Buf_IndexToMapData, ++i, ftos(MapInfo_Map_supportedFeatures));
75 bufstr_set(_MapInfo_Cache_Buf_IndexToMapData, ++i, ftos(MapInfo_Map_flags));
78 float MapInfo_Cache_Retrieve(string map)
82 if(!_MapInfo_Cache_Active)
85 s = db_get(_MapInfo_Cache_DB_NameToIndex, map);
90 // now retrieve all the stuff
91 MapInfo_Map_bspname = bufstr_get(_MapInfo_Cache_Buf_IndexToMapData, i);
92 MapInfo_Map_title = bufstr_get(_MapInfo_Cache_Buf_IndexToMapData, ++i);
93 MapInfo_Map_titlestring = bufstr_get(_MapInfo_Cache_Buf_IndexToMapData, ++i);
94 MapInfo_Map_description = bufstr_get(_MapInfo_Cache_Buf_IndexToMapData, ++i);
95 MapInfo_Map_author = bufstr_get(_MapInfo_Cache_Buf_IndexToMapData, ++i);
96 MapInfo_Map_supportedGametypes = stof(bufstr_get(_MapInfo_Cache_Buf_IndexToMapData, ++i));
97 MapInfo_Map_supportedFeatures = stof(bufstr_get(_MapInfo_Cache_Buf_IndexToMapData, ++i));
98 MapInfo_Map_flags = stof(bufstr_get(_MapInfo_Cache_Buf_IndexToMapData, ++i));
103 // GLOB HANDLING (for all BSP files)
104 float _MapInfo_globopen;
105 float _MapInfo_globcount;
106 float _MapInfo_globhandle;
107 string _MapInfo_GlobItem(float i)
110 if(!_MapInfo_globopen)
112 s = search_getfilename(_MapInfo_globhandle, i);
113 return substring(s, 5, strlen(s) - 9); // without maps/ and .bsp
116 void MapInfo_Enumerate()
118 if(_MapInfo_globopen)
120 search_end(_MapInfo_globhandle);
121 _MapInfo_globopen = 0;
123 MapInfo_Cache_Invalidate();
124 _MapInfo_globhandle = search_begin("maps/*.bsp", true, true);
125 if(_MapInfo_globhandle >= 0)
127 _MapInfo_globcount = search_getsize(_MapInfo_globhandle);
128 _MapInfo_globopen = 1;
131 _MapInfo_globcount = 0;
134 // filter the info by game type mask (updates MapInfo_count)
136 float _MapInfo_filtered;
137 float _MapInfo_filtered_allocated;
138 float MapInfo_FilterList_Lookup(float i)
140 return stof(bufstr_get(_MapInfo_filtered, i));
143 void _MapInfo_FilterList_swap(float i, float j, entity pass)
146 h = bufstr_get(_MapInfo_filtered, i);
147 bufstr_set(_MapInfo_filtered, i, bufstr_get(_MapInfo_filtered, j));
148 bufstr_set(_MapInfo_filtered, j, h);
151 float _MapInfo_FilterList_cmp(float i, float j, entity pass)
154 a = _MapInfo_GlobItem(stof(bufstr_get(_MapInfo_filtered, i)));
155 b = _MapInfo_GlobItem(stof(bufstr_get(_MapInfo_filtered, j)));
156 return strcasecmp(a, b);
159 float MapInfo_FilterGametype(Gametype pGametype, int pFeatures, int pFlagsRequired, int pFlagsForbidden, bool pAbortOnGenerate)
161 return _MapInfo_FilterGametype(pGametype.m_flags, pFeatures, pFlagsRequired, pFlagsForbidden, pAbortOnGenerate);
163 float _MapInfo_FilterGametype(int pGametype, int pFeatures, int pFlagsRequired, int pFlagsForbidden, bool pAbortOnGenerate)
166 if (!_MapInfo_filtered_allocated)
168 _MapInfo_filtered_allocated = 1;
169 _MapInfo_filtered = buf_create();
172 for(i = 0, j = -1; i < _MapInfo_globcount; ++i)
174 if(MapInfo_Get_ByName(_MapInfo_GlobItem(i), 1, NULL) == 2) // if we generated one... BAIL OUT and let the caller continue in the next frame.
177 LOG_TRACE("Autogenerated a .mapinfo, doing the rest later.");
178 MapInfo_progress = i / _MapInfo_globcount;
181 if((MapInfo_Map_supportedGametypes & pGametype) != 0)
182 if((MapInfo_Map_supportedFeatures & pFeatures) == pFeatures)
183 if((MapInfo_Map_flags & pFlagsForbidden) == 0)
184 if((MapInfo_Map_flags & pFlagsRequired) == pFlagsRequired)
185 bufstr_set(_MapInfo_filtered, ++j, ftos(i));
187 MapInfo_count = j + 1;
188 MapInfo_ClearTemps();
190 // sometimes the glob isn't sorted nicely, so fix it here...
191 heapsort(MapInfo_count, _MapInfo_FilterList_swap, _MapInfo_FilterList_cmp, NULL);
195 void MapInfo_FilterString(string sf)
197 // this function further filters _MapInfo_filtered, which is prepared by MapInfo_FilterGametype by string
201 for(i = 0, j = -1; i < MapInfo_count; ++i)
203 if (MapInfo_Get_ByID(i))
205 // prepare for keyword filter
206 if (MapInfo_Map_title && strstrofs(MapInfo_Map_title, "<TITLE>", 0) == -1)
207 title = MapInfo_Map_title;
209 title = MapInfo_Map_bspname;
211 if((strstrofs(strtolower(title), strtolower(sf), 0)) >= 0)
212 bufstr_set(_MapInfo_filtered, ++j, bufstr_get(_MapInfo_filtered, i));
215 MapInfo_count = j + 1;
216 MapInfo_ClearTemps();
218 // sometimes the glob isn't sorted nicely, so fix it here...
219 heapsort(MapInfo_count, _MapInfo_FilterList_swap, _MapInfo_FilterList_cmp, NULL);
222 void MapInfo_Filter_Free()
224 if(_MapInfo_filtered_allocated)
226 buf_del(_MapInfo_filtered);
227 _MapInfo_filtered_allocated = 0;
231 // load info about the i-th map into the MapInfo_Map_* globals
232 string MapInfo_BSPName_ByID(float i)
234 return _MapInfo_GlobItem(MapInfo_FilterList_Lookup(i));
237 string unquote(string s)
240 for(float i = 0; i < l; ++i)
242 string ch = substring(s, i, 1);
243 if((ch != " ") && (ch != "\""))
245 for(float j = l - i - 1; j > 0; --j)
247 ch = substring(s, i+j, 1);
248 if(ch != " ") if(ch != "\"")
249 return substring(s, i, j+1);
251 return substring(s, i, 1);
257 float MapInfo_Get_ByID(float i)
259 if(MapInfo_Get_ByName(MapInfo_BSPName_ByID(i), 0, NULL))
264 string _MapInfo_Map_worldspawn_music;
266 float _MapInfo_Generate(string pFilename) // 0: failure, 1: ok ent, 2: ok bsp
275 float diameter, spawnpoints;
278 vector mapMins, mapMaxs;
281 fn = strcat("maps/", pFilename, ".ent");
282 fh = fopen(fn, FILE_READ);
286 fn = strcat("maps/", pFilename, ".bsp");
287 fh = fopen(fn, FILE_READ);
291 LOG_INFO("Analyzing ", fn, " to generate initial mapinfo");
294 MapInfo_Map_flags = 0;
295 MapInfo_Map_supportedGametypes = 0;
298 _MapInfo_Map_worldspawn_music = "";
304 if (!((s = fgets(fh))))
306 if(inWorldspawn == 1)
307 if(startsWith(s, "}"))
313 if(k == "classname" && v == "worldspawn")
315 else if(k == "author")
316 MapInfo_Map_author = v;
317 else if(k == "_description")
318 MapInfo_Map_description = v;
319 else if(k == "music")
320 _MapInfo_Map_worldspawn_music = v;
321 else if(k == "noise")
322 _MapInfo_Map_worldspawn_music = v;
323 else if(k == "message")
325 i = strstrofs(v, " by ", 0);
326 if(MapInfo_Map_author == "<AUTHOR>" && i >= 0)
328 MapInfo_Map_title = substring(v, 0, i);
329 MapInfo_Map_author = substring(v, i + 4, strlen(v) - (i + 4));
332 MapInfo_Map_title = v;
339 o = stov(strcat("'", v, "'"));
340 mapMins.x = min(mapMins.x, o.x);
341 mapMins.y = min(mapMins.y, o.y);
342 mapMins.z = min(mapMins.z, o.z);
343 mapMaxs.x = max(mapMaxs.x, o.x);
344 mapMaxs.y = max(mapMaxs.y, o.y);
345 mapMaxs.z = max(mapMaxs.z, o.z);
347 else if(k == "race_place")
352 else if(k == "classname")
354 if(v == "info_player_team1")
356 else if(v == "info_player_team2")
358 else if(v == "info_player_start")
360 else if(v == "info_player_deathmatch")
362 else if(v == "weapon_nex")
364 else if(v == "weapon_railgun")
366 else if(startsWith(v, "weapon_"))
367 MapInfo_Map_supportedFeatures |= MAPINFO_FEATURE_WEAPONS;
368 else if(startsWith(v, "turret_"))
369 MapInfo_Map_supportedFeatures |= MAPINFO_FEATURE_TURRETS;
370 else if(startsWith(v, "vehicle_"))
371 MapInfo_Map_supportedFeatures |= MAPINFO_FEATURE_VEHICLES;
372 else if(startsWith(v, "monster_"))
373 MapInfo_Map_supportedFeatures |= MAPINFO_FEATURE_MONSTERS;
374 else if(v == "target_music" || v == "trigger_music")
375 _MapInfo_Map_worldspawn_music = string_null; // don't use regular BGM
377 FOREACH(Gametypes, true, it.m_generate_mapinfo(it, v));
383 LOG_WARN(fn, " ended still in worldspawn, BUG");
386 diameter = vlen(mapMaxs - mapMins);
388 int twoBaseModes = 0;
389 FOREACH(Gametypes, it.m_isTwoBaseMode(), twoBaseModes |= it.m_flags);
390 if(twoBaseModes && (twoBaseModes &= MapInfo_Map_supportedGametypes))
392 // we have a symmetrical map, don't add the modes without bases
396 FOREACH(Gametypes, it.m_isAlwaysSupported(it, spawnpoints, diameter), MapInfo_Map_supportedGametypes |= it.m_flags);
399 if(MapInfo_Map_supportedGametypes & MAPINFO_TYPE_RACE.m_flags)
402 MapInfo_Map_supportedGametypes &= ~MAPINFO_TYPE_RACE.m_flags;
403 MapInfo_Map_supportedGametypes |= MAPINFO_TYPE_CTS.m_flags;
406 LOG_TRACE("-> diameter ", ftos(diameter));
407 LOG_TRACE("; spawnpoints ", ftos(spawnpoints));
408 LOG_TRACE("; modes ", ftos(MapInfo_Map_supportedGametypes));
415 void _MapInfo_Map_Reset()
417 MapInfo_Map_title = "<TITLE>";
418 MapInfo_Map_titlestring = "<TITLE>";
419 MapInfo_Map_description = "<DESCRIPTION>";
420 MapInfo_Map_author = "<AUTHOR>";
421 MapInfo_Map_supportedGametypes = 0;
422 MapInfo_Map_supportedFeatures = 0;
423 MapInfo_Map_flags = 0;
424 MapInfo_Map_clientstuff = "";
425 MapInfo_Map_fog = "";
426 MapInfo_Map_mins = '0 0 0';
427 MapInfo_Map_maxs = '0 0 0';
430 string _MapInfo_GetDefault(Gametype t)
432 return t.m_legacydefaults;
435 void _MapInfo_Map_ApplyGametype(string s, Gametype pWantedType, Gametype pThisType, int load_default)
438 MapInfo_Map_supportedGametypes |= pThisType.m_flags;
439 if(!(pThisType.m_flags & pWantedType.m_flags))
443 _MapInfo_Map_ApplyGametype(_MapInfo_GetDefault(pThisType), pWantedType, pThisType, false);
445 if(!pWantedType.frags) // these modes don't use fraglimit
447 cvar_set("fraglimit", "0");
453 cvar_set("fraglimit", sa);
459 cvar_set("timelimit", sa);
462 if(pWantedType.m_setTeams)
466 pWantedType.m_setTeams(sa);
470 // rc = timelimit timelimit_qualification laps laps_teamplay
471 if(pWantedType == MAPINFO_TYPE_RACE)
473 cvar_set("fraglimit", "0"); // special case!
475 sa = car(s); if(sa == "") sa = cvar_string("timelimit");
476 cvar_set("g_race_qualifying_timelimit", sa);
481 if(cvar("g_race_teams") < 2)
482 cvar_set("fraglimit", sa);
487 if(cvar("g_race_teams") >= 2)
488 cvar_set("fraglimit", sa);
492 if(!pWantedType.frags) // these modes don't use fraglimit
494 cvar_set("leadlimit", "0");
500 cvar_set("leadlimit", sa);
505 string _MapInfo_GetDefaultEx(Gametype t)
507 return t ? t.model2 : "";
510 float _MapInfo_GetTeamPlayBool(Gametype t)
512 return t ? t.team : false;
515 void _MapInfo_Map_ApplyGametypeEx(string s, Gametype pWantedType, Gametype pThisType)
517 MapInfo_Map_supportedGametypes |= pThisType.m_flags;
518 if (!(pThisType.m_flags & pWantedType.m_flags))
521 // reset all the cvars to their defaults
523 cvar_set("timelimit", cvar_defstring("timelimit"));
524 cvar_set("leadlimit", cvar_defstring("leadlimit"));
525 cvar_set("fraglimit", cvar_defstring("fraglimit"));
526 FOREACH(Gametypes, true, it.m_parse_mapinfo(string_null, string_null));
528 string fraglimit_normal = string_null;
529 string fraglimit_teams = string_null;
531 for (s = strcat(_MapInfo_GetDefaultEx(pWantedType), " ", s); s != ""; s = cdr(s)) {
533 if (sa == "") continue;
534 int p = strstrofs(sa, "=", 0);
537 LOG_WARNF("Invalid gametype setting in mapinfo for gametype %s: %s", MapInfo_Type_ToString(pWantedType), sa);
540 string k = substring(sa, 0, p);
541 string v = substring(sa, p + 1, -1);
546 cvar_set("timelimit", v);
551 cvar_set("leadlimit", v);
560 fraglimit_normal = v;
563 case "teampointlimit":
575 FOREACH(Gametypes, true, handled |= it.m_parse_mapinfo(k, v));
576 if (!handled && WARN_COND)
577 LOG_WARNF("Invalid gametype setting in mapinfo for gametype %s: %s", MapInfo_Type_ToString(pWantedType), sa);
580 if (pWantedType == MAPINFO_TYPE_RACE && cvar("g_race_teams") >= 2)
583 cvar_set("fraglimit", fraglimit_teams);
588 cvar_set("fraglimit", fraglimit_normal);
592 Gametype MapInfo_Type_FromString(string gtype)
594 string replacement = "";
597 case "nexball": replacement = "nb"; break;
598 case "freezetag": replacement = "ft"; break;
599 case "keepaway": replacement = "ka"; break;
600 case "invasion": replacement = "inv"; break;
601 case "assault": replacement = "as"; break;
602 case "race": replacement = "rc"; break;
604 if (replacement != "" && WARN_COND)
606 LOG_WARNF("MapInfo_Type_FromString (probably %s): using deprecated name '%s'. Should use '%s'.", MapInfo_Map_bspname, gtype, replacement);
609 FOREACH(Gametypes, it.mdl == gtype, return it);
613 string MapInfo_Type_Description(Gametype t)
615 return t ? t.gametype_description : "";
618 string MapInfo_Type_ToString(Gametype t)
620 return t ? t.mdl : "";
623 string MapInfo_Type_ToText(Gametype t)
625 /* xgettext:no-c-format */
626 return t ? t.message : _("@!#%'n Tuba Throwing");
629 void _MapInfo_Parse_Settemp(string pFilename, string acl, float type, string s, float recurse)
633 t = car(s); s = cdr(s);
635 // limited support of "" and comments
636 // remove trailing and leading " of t
637 if(substring(t, 0, 1) == "\"")
639 if(substring(t, -1, 1) == "\"")
640 t = substring(t, 1, -2);
643 // remove leading " of s
644 if(substring(s, 0, 1) == "\"")
646 s = substring(s, 1, -1);
648 // remove trailing " of s, and all that follows (cvar description)
649 o = strstrofs(s, "\"", 0);
651 s = substring(s, 0, o);
653 // remove // comments
654 o = strstrofs(s, "//", 0);
656 s = substring(s, 0, o);
658 // remove trailing spaces
659 while(substring(s, -1, 1) == " ")
660 s = substring(s, 0, -2);
666 fh = fopen(s, FILE_READ);
670 LOG_WARN("Map ", pFilename, " references not existing config file ", s);
674 while((s = fgets(fh)))
676 // catch different sorts of comments
677 if(s == "") // empty lines
679 if(substring(s, 0, 1) == "#") // UNIX style
681 if(substring(s, 0, 2) == "//") // C++ style
683 if(substring(s, 0, 1) == "_") // q3map style
686 if(substring(s, 0, 4) == "set ")
687 s = substring(s, 4, -1);
688 if(substring(s, 0, 5) == "seta ")
689 s = substring(s, 5, -1);
691 _MapInfo_Parse_Settemp(pFilename, acl, type, s, recurse - 1);
697 LOG_WARN("Map ", pFilename, " uses too many levels of inclusion");
700 || !cvar_value_issafe(t)
701 || !cvar_value_issafe(s)
702 || matchacl(MAPINFO_SETTEMP_ACL_SYSTEM, t) <= 0)
705 LOG_WARN("Map ", pFilename, " contains a potentially harmful setting, ignored");
707 else if(matchacl(acl, t) <= 0)
710 LOG_WARN("Map ", pFilename, " contains a denied setting, ignored");
714 if(type == 0) // server set
716 LOG_TRACE("Applying temporary setting ", t, " := ", s);
718 if(cvar("g_campaign"))
719 cvar_set(t, s); // this is a wrapper and is always temporary anyway; no need to backup old values then
726 LOG_TRACE("Applying temporary client setting ", t, " := ", s);
727 MapInfo_Map_clientstuff = strcat(
728 MapInfo_Map_clientstuff, "cl_cmd settemp \"", t, "\" \"", s, "\"\n"
734 float MapInfo_isRedundant(string fn, string t)
736 // normalize file name
737 fn = strreplace("_", "", fn);
738 fn = strreplace("-", "", fn);
740 // normalize visible title
741 t = strreplace(":", "", t);
742 t = strreplace(" ", "", t);
743 t = strreplace("_", "", t);
744 t = strreplace("-", "", t);
745 t = strreplace("'", "", t);
746 t = strdecolorize(t);
748 // we allow the visible title to have punctuation the file name does
749 // not, but not vice versa
750 if(!strcasecmp(fn, t))
756 // load info about a map by name into the MapInfo_Map_* globals
757 float MapInfo_Get_ByName_NoFallbacks(string pFilename, int pAllowGenerate, Gametype pGametypeToSet)
766 acl = MAPINFO_SETTEMP_ACL_USER;
768 if(strstrofs(pFilename, "/", 0) >= 0)
770 LOG_WARN("Invalid character in map name, ignored");
774 if(pGametypeToSet == NULL)
775 if(MapInfo_Cache_Retrieve(pFilename))
780 MapInfo_Map_bspname = pFilename;
782 // default all generic fields so they have "good" values in case something fails
783 fn = strcat("maps/", pFilename, ".mapinfo");
784 fh = fopen(fn, FILE_READ);
787 fn = strcat("maps/autogenerated/", pFilename, ".mapinfo");
788 fh = fopen(fn, FILE_READ);
793 _MapInfo_Map_Reset();
794 r = _MapInfo_Generate(pFilename);
797 fh = fopen(fn, FILE_WRITE);
798 fputs(fh, strcat("title ", MapInfo_Map_title, "\n"));
799 fputs(fh, strcat("description ", MapInfo_Map_description, "\n"));
800 fputs(fh, strcat("author ", MapInfo_Map_author, "\n"));
801 if(_MapInfo_Map_worldspawn_music != "")
804 substring(_MapInfo_Map_worldspawn_music, strlen(_MapInfo_Map_worldspawn_music) - 4, 4) == ".wav"
806 substring(_MapInfo_Map_worldspawn_music, strlen(_MapInfo_Map_worldspawn_music) - 4, 4) == ".ogg"
808 fputs(fh, strcat("cdtrack ", substring(_MapInfo_Map_worldspawn_music, 0, strlen(_MapInfo_Map_worldspawn_music) - 4), "\n"));
810 fputs(fh, strcat("cdtrack ", _MapInfo_Map_worldspawn_music, "\n"));
814 n = tokenize_console(cvar_string("g_cdtracks_remaplist"));
815 s = strcat(" ", cvar_string("g_cdtracks_dontusebydefault"), " ");
818 i = floor(random() * n);
819 if(strstrofs(s, strcat(" ", argv(i), " "), 0) < 0)
822 fputs(fh, strcat("cdtrack ", ftos(i + 1), "\n"));
824 if(MapInfo_Map_supportedFeatures & MAPINFO_FEATURE_WEAPONS)
825 fputs(fh, "has weapons\n");
827 fputs(fh, "// uncomment this if you added weapon pickups: has weapons\n");
828 if(MapInfo_Map_supportedFeatures & MAPINFO_FEATURE_TURRETS)
829 fputs(fh, "has turrets\n");
831 fputs(fh, "// uncomment this if you added turrets: has turrets\n");
832 if(MapInfo_Map_supportedFeatures & MAPINFO_FEATURE_VEHICLES)
833 fputs(fh, "has vehicles\n");
835 fputs(fh, "// uncomment this if you added vehicles: has vehicles\n");
836 if(MapInfo_Map_flags & MAPINFO_FLAG_FRUSTRATING)
837 fputs(fh, "frustrating\n");
839 FOREACH(Gametypes, MapInfo_Map_supportedGametypes & it.m_flags, {
840 fputs(fh, sprintf("gametype %s // defaults: %s\n", MapInfo_Type_ToString(it), _MapInfo_GetDefaultEx(it)));
843 fputs(fh, "// optional: fog density red green blue alpha mindist maxdist\n");
844 fputs(fh, "// optional: settemp_for_type (all|gametypename) cvarname value\n");
845 fputs(fh, "// optional: clientsettemp_for_type (all|gametypename) cvarname value\n");
846 fputs(fh, "// optional: size mins_x mins_y mins_z maxs_x maxs_y maxs_z\n");
847 fputs(fh, "// optional: hidden\n");
852 fh = fopen(fn, FILE_READ);
854 error("... but I just wrote it!");
858 LOG_WARN("autogenerated mapinfo file ", fn, " has been loaded; please edit that file and move it to maps/", pFilename, ".mapinfo");
861 _MapInfo_Map_Reset();
864 if (!((s = fgets(fh))))
867 // catch different sorts of comments
868 if(s == "") // empty lines
870 if(substring(s, 0, 1) == "#") // UNIX style
872 if(substring(s, 0, 2) == "//") // C++ style
874 if(substring(s, 0, 1) == "_") // q3map style
877 p = strstrofs(s, "//", 0);
879 s = substring(s, 0, p);
881 t = car(s); s = cdr(s);
883 MapInfo_Map_title = s;
884 else if(t == "description")
885 MapInfo_Map_description = s;
886 else if(t == "author")
887 MapInfo_Map_author = s;
890 t = car(s); // s = cdr(s);
891 if (t == "weapons") MapInfo_Map_supportedFeatures |= MAPINFO_FEATURE_WEAPONS;
892 else if(t == "turrets") MapInfo_Map_supportedFeatures |= MAPINFO_FEATURE_TURRETS;
893 else if(t == "vehicles") MapInfo_Map_supportedFeatures |= MAPINFO_FEATURE_VEHICLES;
894 else if(t == "monsters") MapInfo_Map_supportedFeatures |= MAPINFO_FEATURE_MONSTERS;
895 else if(t == "new_toys") MapInfo_Map_supportedFeatures |= MAPINFO_FEATURE_WEAPONS;
897 LOG_WARN("Map ", pFilename, " supports unknown feature ", t, ", ignored");
899 else if(t == "hidden")
901 MapInfo_Map_flags |= MAPINFO_FLAG_HIDDEN;
903 else if(t == "forbidden")
905 MapInfo_Map_flags |= MAPINFO_FLAG_FORBIDDEN;
907 else if(t == "frustrating")
909 MapInfo_Map_flags |= MAPINFO_FLAG_FRUSTRATING;
911 else if(t == "noautomaplist")
913 MapInfo_Map_flags |= MAPINFO_FLAG_NOAUTOMAPLIST;
915 else if(t == "gameversion_min")
917 if (cvar("gameversion") < stof(s))
918 MapInfo_Map_flags |= MAPINFO_FLAG_NOAUTOMAPLIST;
922 t = car(s); s = cdr(s);
923 Gametype f = MapInfo_Type_FromString(t);
925 //LOG_WARN("Map ", pFilename, " contains the legacy 'type' keyword which is deprecated and will be removed in the future. Please migrate the mapinfo file to 'gametype'.");
927 _MapInfo_Map_ApplyGametype (s, pGametypeToSet, f, true);
929 LOG_DEBUG("Map ", pFilename, " supports unknown game type ", t, ", ignored");
931 else if(t == "gametype")
933 t = car(s); s = cdr(s);
934 Gametype f = MapInfo_Type_FromString(t);
936 _MapInfo_Map_ApplyGametypeEx (s, pGametypeToSet, f);
938 LOG_DEBUG("Map ", pFilename, " supports unknown game type ", t, ", ignored");
943 t = car(s); s = cdr(s); a = stof(t);
944 t = car(s); s = cdr(s); b = stof(t);
945 t = car(s); s = cdr(s); c = stof(t);
946 t = car(s); s = cdr(s); d = stof(t);
947 t = car(s); s = cdr(s); e = stof(t);
951 LOG_WARN("Map ", pFilename, " contains an incorrect size line (not enough params), syntax: size mins_x mins_y mins_z maxs_x maxs_y maxs_z");
955 t = car(s); s = cdr(s); f = stof(t);
959 LOG_WARN("Map ", pFilename, " contains an incorrect size line (too many params), syntax: size mins_x mins_y mins_z maxs_x maxs_y maxs_z");
963 if(a >= d || b >= e || c >= f)
966 LOG_WARN("Map ", pFilename, " contains an incorrect size line, mins have to be < maxs");
970 MapInfo_Map_mins.x = a;
971 MapInfo_Map_mins.y = b;
972 MapInfo_Map_mins.z = c;
973 MapInfo_Map_maxs.x = d;
974 MapInfo_Map_maxs.y = e;
975 MapInfo_Map_maxs.z = f;
980 else if(t == "settemp_for_type")
982 t = car(s); s = cdr(s);
983 bool all = t == "all";
985 if(all || (f = MapInfo_Type_FromString(t)))
987 if((all ? MAPINFO_TYPE_ALL : f.m_flags) & pGametypeToSet.m_flags)
989 _MapInfo_Parse_Settemp(pFilename, acl, 0, s, 1);
994 LOG_DEBUG("Map ", pFilename, " has a setting for unknown game type ", t, ", ignored");
997 else if(t == "clientsettemp_for_type")
999 t = car(s); s = cdr(s);
1000 bool all = t == "all";
1002 if(all || (f = MapInfo_Type_FromString(t)))
1004 if((all ? MAPINFO_TYPE_ALL : f.m_flags) & pGametypeToSet.m_flags)
1006 _MapInfo_Parse_Settemp(pFilename, acl, 1, s, 1);
1011 LOG_DEBUG("Map ", pFilename, " has a client setting for unknown game type ", t, ", ignored");
1016 if (!cvar_value_issafe(s))
1019 LOG_WARN("Map ", pFilename, " contains a potentially harmful fog setting, ignored");
1022 MapInfo_Map_fog = s;
1024 else if(t == "cdtrack")
1026 t = car(s); s = cdr(s);
1027 // We do this only if pGametypeToSet even though this
1028 // content is theoretically game type independent,
1029 // because MapInfo_Map_clientstuff contains otherwise
1030 // game type dependent stuff. That way this value stays
1031 // empty when not setting a game type to not set any
1032 // false expectations.
1035 if (!cvar_value_issafe(t))
1038 LOG_WARN("Map ", pFilename, " contains a potentially harmful cdtrack, ignored");
1041 MapInfo_Map_clientstuff = strcat(
1042 MapInfo_Map_clientstuff, "cd loop \"", t, "\"\n"
1047 LOG_WARN("Map ", pFilename, " provides unknown info item ", t, ", ignored");
1051 if(MapInfo_Map_title == "<TITLE>")
1052 MapInfo_Map_titlestring = MapInfo_Map_bspname;
1053 else if(MapInfo_isRedundant(MapInfo_Map_bspname, MapInfo_Map_title))
1054 MapInfo_Map_titlestring = MapInfo_Map_title;
1056 MapInfo_Map_titlestring = sprintf("%s: %s", MapInfo_Map_bspname, MapInfo_Map_title);
1058 MapInfo_Cache_Store();
1059 if(MapInfo_Map_supportedGametypes != 0)
1062 LOG_WARN("Map ", pFilename, " supports no game types, ignored");
1065 int MapInfo_Get_ByName(string pFilename, float pAllowGenerate, Gametype pGametypeToSet)
1067 int r = MapInfo_Get_ByName_NoFallbacks(pFilename, pAllowGenerate, pGametypeToSet);
1069 FOREACH(Gametypes, it.m_isForcedSupported(it), _MapInfo_Map_ApplyGametypeEx("", pGametypeToSet, it));
1073 if(!(MapInfo_Map_supportedGametypes & pGametypeToSet.m_flags))
1075 error("Can't select the requested game type. This should never happen as the caller should prevent it!\n");
1076 //_MapInfo_Map_ApplyGametypeEx("", pGametypeToSet, MAPINFO_TYPE_DEATHMATCH);
1084 float MapInfo_FindName(string s)
1086 // if there is exactly one map of prefix s, return it
1087 // if not, return the null string
1088 // note that DP sorts glob results... so I can use a binary search
1092 // invariants: r is behind s, l-1 is equal or before
1095 m = floor((l + r) / 2);
1096 MapInfo_FindName_match = _MapInfo_GlobItem(MapInfo_FilterList_Lookup(m));
1097 cmp = strcasecmp(MapInfo_FindName_match, s);
1099 return m; // found and good
1101 l = m + 1; // l-1 is before s
1105 MapInfo_FindName_match = _MapInfo_GlobItem(MapInfo_FilterList_Lookup(l));
1106 MapInfo_FindName_firstResult = l;
1107 // r == l, so: l is behind s, l-1 is before
1108 // SO: if there is any, l is the one with the right prefix
1109 // and l+1 may be one too
1110 if(l == MapInfo_count)
1112 MapInfo_FindName_match = string_null;
1113 MapInfo_FindName_firstResult = -1;
1114 return -1; // no MapInfo_FindName_match, behind last item
1116 if(!startsWithNocase(MapInfo_FindName_match, s))
1118 MapInfo_FindName_match = string_null;
1119 MapInfo_FindName_firstResult = -1;
1120 return -1; // wrong prefix
1122 if(l == MapInfo_count - 1)
1123 return l; // last one, nothing can follow => unique
1124 if(startsWithNocase(_MapInfo_GlobItem(MapInfo_FilterList_Lookup(l + 1)), s))
1126 MapInfo_FindName_match = string_null;
1127 return -1; // ambigous MapInfo_FindName_match
1132 string MapInfo_FixName(string s)
1134 MapInfo_FindName(s);
1135 return MapInfo_FindName_match;
1138 int MapInfo_CurrentFeatures()
1141 // TODO: find a better way to check if weapons are required on the map
1142 if(!(cvar("g_instagib") || cvar("g_overkill") || cvar("g_nix") || cvar("g_weaponarena") || !cvar("g_pickup_items")
1143 || cvar("g_race") || cvar("g_cts") || cvar("g_nexball") || cvar("g_ca") || cvar("g_freezetag") || cvar("g_lms")))
1144 req |= MAPINFO_FEATURE_WEAPONS;
1148 Gametype MapInfo_CurrentGametype()
1150 Gametype prev = REGISTRY_GET(Gametypes, cvar("gamecfg"));
1151 FOREACH(Gametypes, cvar(it.netname) && it != prev, return it);
1152 return prev ? prev : MAPINFO_TYPE_DEATHMATCH;
1155 float _MapInfo_CheckMap(string s, bool gametype_only) // returns 0 if the map can't be played with the current settings, 1 otherwise
1157 if(!MapInfo_Get_ByName(s, 1, NULL))
1159 if((MapInfo_Map_supportedGametypes & MapInfo_CurrentGametype().m_flags) == 0)
1163 if((MapInfo_Map_supportedFeatures & MapInfo_CurrentFeatures()) != MapInfo_CurrentFeatures())
1168 float MapInfo_CheckMap(string s) // returns 0 if the map can't be played with the current settings, 1 otherwise
1171 r = _MapInfo_CheckMap(s, false);
1172 MapInfo_ClearTemps();
1176 void MapInfo_SwitchGameType(Gametype t)
1178 FOREACH(Gametypes, true, cvar_set(it.netname, (it == t) ? "1" : "0"));
1181 void MapInfo_LoadMap(string s, float reinit)
1183 MapInfo_Map_supportedGametypes = 0;
1184 // we shouldn't need this, as LoadMapSettings already fixes the gametype
1185 //if(!MapInfo_CheckMap(s))
1187 // print("EMERGENCY: can't play the selected map in the given game mode. Falling back to DM.\n");
1188 // MapInfo_SwitchGameType(MAPINFO_TYPE_DEATHMATCH.m_flags);
1191 LOG_INFO("Switching to map ", s);
1193 cvar_settemp_restore();
1195 localcmd(strcat("\nmap ", s, "\n"));
1197 localcmd(strcat("\nchangelevel ", s, "\n"));
1200 string MapInfo_ListAllowedMaps(Gametype type, float pRequiredFlags, float pForbiddenFlags)
1204 // to make absolutely sure:
1205 MapInfo_Enumerate();
1206 MapInfo_FilterGametype(type, MapInfo_CurrentFeatures(), pRequiredFlags, pForbiddenFlags, 0);
1209 for(float i = 0; i < MapInfo_count; ++i)
1210 out = strcat(out, " ", _MapInfo_GlobItem(MapInfo_FilterList_Lookup(i)));
1211 return substring(out, 1, strlen(out) - 1);
1214 string MapInfo_ListAllAllowedMaps(float pRequiredFlags, float pForbiddenFlags)
1218 // to make absolutely sure:
1219 MapInfo_Enumerate();
1220 _MapInfo_FilterGametype(MAPINFO_TYPE_ALL, 0, pRequiredFlags, pForbiddenFlags, 0);
1223 for(float i = 0; i < MapInfo_count; ++i)
1224 out = strcat(out, " ", _MapInfo_GlobItem(MapInfo_FilterList_Lookup(i)));
1226 MapInfo_FilterGametype(MapInfo_CurrentGametype(), MapInfo_CurrentFeatures(), pRequiredFlags, pForbiddenFlags, 0);
1228 return substring(out, 1, strlen(out) - 1);
1231 void MapInfo_LoadMapSettings_SaveGameType(Gametype t)
1233 MapInfo_SwitchGameType(t);
1234 cvar_set("gamecfg", ftos(t.m_id));
1235 MapInfo_LoadedGametype = t;
1238 void MapInfo_LoadMapSettings(string s) // to be called from worldspawn
1240 Gametype t = MapInfo_CurrentGametype();
1241 MapInfo_LoadMapSettings_SaveGameType(t);
1243 if(!_MapInfo_CheckMap(s, true)) // with underscore, it keeps temps
1245 if(cvar("g_mapinfo_allow_unsupported_modes_and_let_stuff_break"))
1247 LOG_SEVERE("can't play the selected map in the given game mode. Working with only the override settings.");
1248 _MapInfo_Map_ApplyGametypeEx("", t, t);
1249 return; // do not call Get_ByName!
1252 if(MapInfo_Map_supportedGametypes == 0)
1254 LOG_SEVERE("Mapinfo system is not functional at all. Assuming deathmatch.");
1255 MapInfo_Map_supportedGametypes = MAPINFO_TYPE_DEATHMATCH.m_flags;
1256 MapInfo_LoadMapSettings_SaveGameType(MAPINFO_TYPE_DEATHMATCH);
1257 _MapInfo_Map_ApplyGametypeEx("", MAPINFO_TYPE_DEATHMATCH, MAPINFO_TYPE_DEATHMATCH);
1258 return; // do not call Get_ByName!
1262 // find the lowest bit in the supported gametypes
1263 // unnecessary now that we select one at random
1265 while(!(MapInfo_Map_supportedGametypes & 1))
1268 MapInfo_Map_supportedGametypes = floor(MapInfo_Map_supportedGametypes >> 1);
1271 RandomSelection_Init();
1272 Gametype t_prev = t;
1273 FOREACH(Gametypes, MapInfo_Map_supportedGametypes & it.m_flags,
1275 RandomSelection_AddEnt(it, 1, it.m_priority);
1277 if(RandomSelection_chosen_ent)
1278 t = RandomSelection_chosen_ent;
1280 // t is now a supported mode!
1281 LOG_WARNF("can't play the selected map in the given game mode (%s). Falling back to a supported mode (%s).", t_prev.mdl, t.mdl);
1282 MapInfo_LoadMapSettings_SaveGameType(t);
1284 if(!_MapInfo_CheckMap(s, false)) { // with underscore, it keeps temps
1285 LOG_WARNF("the selected map lacks features required by current settings; playing anyway.");
1287 MapInfo_Get_ByName(s, 1, t);
1290 void MapInfo_ClearTemps()
1292 MapInfo_Map_bspname = string_null;
1293 MapInfo_Map_title = string_null;
1294 MapInfo_Map_titlestring = string_null;
1295 MapInfo_Map_description = string_null;
1296 MapInfo_Map_author = string_null;
1297 MapInfo_Map_clientstuff = string_null;
1298 MapInfo_Map_supportedGametypes = 0;
1299 MapInfo_Map_supportedFeatures = 0;
1302 void MapInfo_Shutdown()
1304 MapInfo_ClearTemps();
1305 MapInfo_Filter_Free();
1306 MapInfo_Cache_Destroy();
1307 if(_MapInfo_globopen)
1309 search_end(_MapInfo_globhandle);
1310 _MapInfo_globhandle = -1;
1311 _MapInfo_globopen = false;
1315 int MapInfo_ForbiddenFlags()
1317 int f = MAPINFO_FLAG_FORBIDDEN;
1320 if (!cvar("g_maplist_allow_hidden"))
1322 f |= MAPINFO_FLAG_HIDDEN;
1324 if (!cvar("g_maplist_allow_frustrating"))
1325 f |= MAPINFO_FLAG_FRUSTRATING;
1330 int MapInfo_RequiredFlags()
1334 if(cvar("g_maplist_allow_frustrating") > 1)
1335 f |= MAPINFO_FLAG_FRUSTRATING;