3 #include <common/util.qh>
4 #include <common/weapons/_all.qh>
7 #include <common/util.qh>
8 #include <common/monsters/_mod.qh>
12 #define WARN_COND false
14 bool autocvar_g_mapinfo_ignore_warnings;
15 #define WARN_COND (!autocvar_g_mapinfo_ignore_warnings && MapInfo_Map_bspname == mi_shortname)
18 // generic string stuff
20 int _MapInfo_Cache_Active;
21 int _MapInfo_Cache_DB_NameToIndex;
22 int _MapInfo_Cache_Buf_IndexToMapData;
24 void MapInfo_Cache_Destroy()
26 if(!_MapInfo_Cache_Active)
29 db_close(_MapInfo_Cache_DB_NameToIndex);
30 buf_del(_MapInfo_Cache_Buf_IndexToMapData);
31 _MapInfo_Cache_Active = 0;
34 void MapInfo_Cache_Create()
36 MapInfo_Cache_Destroy();
37 _MapInfo_Cache_DB_NameToIndex = db_create();
38 _MapInfo_Cache_Buf_IndexToMapData = buf_create();
39 _MapInfo_Cache_Active = 1;
42 void MapInfo_Cache_Invalidate()
44 if(!_MapInfo_Cache_Active)
47 MapInfo_Cache_Create();
50 void MapInfo_Cache_Store()
54 if(!_MapInfo_Cache_Active)
57 s = db_get(_MapInfo_Cache_DB_NameToIndex, MapInfo_Map_bspname);
60 i = buf_getsize(_MapInfo_Cache_Buf_IndexToMapData);
61 db_put(_MapInfo_Cache_DB_NameToIndex, MapInfo_Map_bspname, ftos(i));
66 // now store all the stuff
67 bufstr_set(_MapInfo_Cache_Buf_IndexToMapData, i, MapInfo_Map_bspname);
68 bufstr_set(_MapInfo_Cache_Buf_IndexToMapData, ++i, MapInfo_Map_title);
69 bufstr_set(_MapInfo_Cache_Buf_IndexToMapData, ++i, MapInfo_Map_titlestring);
70 bufstr_set(_MapInfo_Cache_Buf_IndexToMapData, ++i, MapInfo_Map_description);
71 bufstr_set(_MapInfo_Cache_Buf_IndexToMapData, ++i, MapInfo_Map_author);
72 bufstr_set(_MapInfo_Cache_Buf_IndexToMapData, ++i, ftos(MapInfo_Map_supportedGametypes));
73 bufstr_set(_MapInfo_Cache_Buf_IndexToMapData, ++i, ftos(MapInfo_Map_supportedFeatures));
74 bufstr_set(_MapInfo_Cache_Buf_IndexToMapData, ++i, ftos(MapInfo_Map_flags));
77 float MapInfo_Cache_Retrieve(string map)
81 if(!_MapInfo_Cache_Active)
84 s = db_get(_MapInfo_Cache_DB_NameToIndex, map);
89 // now retrieve all the stuff
90 MapInfo_Map_bspname = bufstr_get(_MapInfo_Cache_Buf_IndexToMapData, i);
91 MapInfo_Map_title = bufstr_get(_MapInfo_Cache_Buf_IndexToMapData, ++i);
92 MapInfo_Map_titlestring = bufstr_get(_MapInfo_Cache_Buf_IndexToMapData, ++i);
93 MapInfo_Map_description = bufstr_get(_MapInfo_Cache_Buf_IndexToMapData, ++i);
94 MapInfo_Map_author = bufstr_get(_MapInfo_Cache_Buf_IndexToMapData, ++i);
95 MapInfo_Map_supportedGametypes = stof(bufstr_get(_MapInfo_Cache_Buf_IndexToMapData, ++i));
96 MapInfo_Map_supportedFeatures = stof(bufstr_get(_MapInfo_Cache_Buf_IndexToMapData, ++i));
97 MapInfo_Map_flags = stof(bufstr_get(_MapInfo_Cache_Buf_IndexToMapData, ++i));
102 // GLOB HANDLING (for all BSP files)
103 float _MapInfo_globopen;
104 float _MapInfo_globcount;
105 float _MapInfo_globhandle;
106 string _MapInfo_GlobItem(float i)
109 if(!_MapInfo_globopen)
111 s = search_getfilename(_MapInfo_globhandle, i);
112 return substring(s, 5, strlen(s) - 9); // without maps/ and .bsp
115 void MapInfo_Enumerate()
117 if(_MapInfo_globopen)
119 search_end(_MapInfo_globhandle);
120 _MapInfo_globopen = 0;
122 MapInfo_Cache_Invalidate();
123 _MapInfo_globhandle = search_begin("maps/*.bsp", true, true);
124 if(_MapInfo_globhandle >= 0)
126 _MapInfo_globcount = search_getsize(_MapInfo_globhandle);
127 _MapInfo_globopen = 1;
130 _MapInfo_globcount = 0;
133 // filter the info by game type mask (updates MapInfo_count)
135 float _MapInfo_filtered;
136 float _MapInfo_filtered_allocated;
137 float MapInfo_FilterList_Lookup(float i)
139 return stof(bufstr_get(_MapInfo_filtered, i));
142 void _MapInfo_FilterList_swap(float i, float j, entity pass)
145 h = bufstr_get(_MapInfo_filtered, i);
146 bufstr_set(_MapInfo_filtered, i, bufstr_get(_MapInfo_filtered, j));
147 bufstr_set(_MapInfo_filtered, j, h);
150 float _MapInfo_FilterList_cmp(float i, float j, entity pass)
153 a = _MapInfo_GlobItem(stof(bufstr_get(_MapInfo_filtered, i)));
154 b = _MapInfo_GlobItem(stof(bufstr_get(_MapInfo_filtered, j)));
155 return strcasecmp(a, b);
158 float MapInfo_FilterGametype(Gametype pGametype, int pFeatures, int pFlagsRequired, int pFlagsForbidden, bool pAbortOnGenerate)
160 return _MapInfo_FilterGametype(pGametype.m_flags, pFeatures, pFlagsRequired, pFlagsForbidden, pAbortOnGenerate);
162 float _MapInfo_FilterGametype(int pGametype, int pFeatures, int pFlagsRequired, int pFlagsForbidden, bool pAbortOnGenerate)
165 if (!_MapInfo_filtered_allocated)
167 _MapInfo_filtered_allocated = 1;
168 _MapInfo_filtered = buf_create();
171 for(i = 0, j = -1; i < _MapInfo_globcount; ++i)
173 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.
176 LOG_TRACE("Autogenerated a .mapinfo, doing the rest later.");
177 MapInfo_progress = i / _MapInfo_globcount;
180 if((MapInfo_Map_supportedGametypes & pGametype) != 0)
181 if((MapInfo_Map_supportedFeatures & pFeatures) == pFeatures)
182 if((MapInfo_Map_flags & pFlagsForbidden) == 0)
183 if((MapInfo_Map_flags & pFlagsRequired) == pFlagsRequired)
184 bufstr_set(_MapInfo_filtered, ++j, ftos(i));
186 MapInfo_count = j + 1;
187 MapInfo_ClearTemps();
189 // sometimes the glob isn't sorted nicely, so fix it here...
190 heapsort(MapInfo_count, _MapInfo_FilterList_swap, _MapInfo_FilterList_cmp, NULL);
194 void MapInfo_FilterString(string sf)
196 // this function further filters _MapInfo_filtered, which is prepared by MapInfo_FilterGametype by string
200 for(i = 0, j = -1; i < MapInfo_count; ++i)
202 if (MapInfo_Get_ByID(i))
204 // prepare for keyword filter
205 if (MapInfo_Map_title && strstrofs(MapInfo_Map_title, "<TITLE>", 0) == -1)
206 title = MapInfo_Map_title;
208 title = MapInfo_Map_bspname;
210 if((strstrofs(strtolower(title), strtolower(sf), 0)) >= 0)
211 bufstr_set(_MapInfo_filtered, ++j, bufstr_get(_MapInfo_filtered, i));
214 MapInfo_count = j + 1;
215 MapInfo_ClearTemps();
217 // sometimes the glob isn't sorted nicely, so fix it here...
218 heapsort(MapInfo_count, _MapInfo_FilterList_swap, _MapInfo_FilterList_cmp, NULL);
221 void MapInfo_Filter_Free()
223 if(_MapInfo_filtered_allocated)
225 buf_del(_MapInfo_filtered);
226 _MapInfo_filtered_allocated = 0;
230 // load info about the i-th map into the MapInfo_Map_* globals
231 string MapInfo_BSPName_ByID(float i)
233 return _MapInfo_GlobItem(MapInfo_FilterList_Lookup(i));
236 string unquote(string s)
239 for(float i = 0; i < l; ++i)
241 string ch = substring(s, i, 1);
242 if((ch != " ") && (ch != "\""))
244 for(float j = l - i - 1; j > 0; --j)
246 ch = substring(s, i+j, 1);
247 if(ch != " ") if(ch != "\"")
248 return substring(s, i, j+1);
250 return substring(s, i, 1);
256 bool MapInfo_Get_ByID(int i)
258 return MapInfo_Get_ByName(MapInfo_BSPName_ByID(i), 0, NULL) ? true : false;
261 string _MapInfo_Map_worldspawn_music;
263 float _MapInfo_Generate(string pFilename) // 0: failure, 1: ok ent, 2: ok bsp
272 float diameter, spawnpoints;
275 vector mapMins, mapMaxs;
278 fn = strcat("maps/", pFilename, ".ent");
279 fh = fopen(fn, FILE_READ);
283 fn = strcat("maps/", pFilename, ".bsp");
284 fh = fopen(fn, FILE_READ);
288 LOG_INFO("Analyzing ", fn, " to generate initial mapinfo");
291 MapInfo_Map_flags = 0;
292 MapInfo_Map_supportedGametypes = 0;
295 _MapInfo_Map_worldspawn_music = "";
301 if (!((s = fgets(fh))))
303 if(inWorldspawn == 1)
304 if(startsWith(s, "}"))
310 if(k == "classname" && v == "worldspawn")
312 else if(k == "author")
313 MapInfo_Map_author = v;
314 else if(k == "_description")
315 MapInfo_Map_description = v;
316 else if(k == "music")
317 _MapInfo_Map_worldspawn_music = v;
318 else if(k == "noise")
319 _MapInfo_Map_worldspawn_music = v;
320 else if(k == "message")
322 i = strstrofs(v, " by ", 0);
323 if(MapInfo_Map_author == "<AUTHOR>" && i >= 0)
325 MapInfo_Map_title = substring(v, 0, i);
326 MapInfo_Map_author = substring(v, i + 4, strlen(v) - (i + 4));
329 MapInfo_Map_title = v;
336 o = stov(strcat("'", v, "'"));
337 mapMins.x = min(mapMins.x, o.x);
338 mapMins.y = min(mapMins.y, o.y);
339 mapMins.z = min(mapMins.z, o.z);
340 mapMaxs.x = max(mapMaxs.x, o.x);
341 mapMaxs.y = max(mapMaxs.y, o.y);
342 mapMaxs.z = max(mapMaxs.z, o.z);
344 else if(k == "race_place")
349 else if(k == "classname")
351 if(v == "info_player_team1")
353 else if(v == "info_player_team2")
355 else if(v == "info_player_start")
357 else if(v == "info_player_deathmatch")
359 else if(v == "weapon_nex")
361 else if(v == "weapon_railgun")
363 else if(startsWith(v, "weapon_"))
364 MapInfo_Map_supportedFeatures |= MAPINFO_FEATURE_WEAPONS;
365 else if(startsWith(v, "turret_"))
366 MapInfo_Map_supportedFeatures |= MAPINFO_FEATURE_TURRETS;
367 else if(startsWith(v, "vehicle_"))
368 MapInfo_Map_supportedFeatures |= MAPINFO_FEATURE_VEHICLES;
369 else if(startsWith(v, "monster_"))
370 MapInfo_Map_supportedFeatures |= MAPINFO_FEATURE_MONSTERS;
371 else if(v == "target_music" || v == "trigger_music")
372 _MapInfo_Map_worldspawn_music = string_null; // don't use regular BGM
374 FOREACH(Gametypes, true, it.m_generate_mapinfo(it, v));
380 LOG_WARN(fn, " ended still in worldspawn, BUG");
383 diameter = vlen(mapMaxs - mapMins);
385 int twoBaseModes = 0;
386 FOREACH(Gametypes, it.m_isTwoBaseMode(), twoBaseModes |= it.m_flags);
387 if(twoBaseModes && (twoBaseModes &= MapInfo_Map_supportedGametypes))
389 // we have a symmetrical map, don't add the modes without bases
393 FOREACH(Gametypes, it.m_isAlwaysSupported(it, spawnpoints, diameter), MapInfo_Map_supportedGametypes |= it.m_flags);
396 if(MapInfo_Map_supportedGametypes & MAPINFO_TYPE_RACE.m_flags)
399 MapInfo_Map_supportedGametypes &= ~MAPINFO_TYPE_RACE.m_flags;
400 MapInfo_Map_supportedGametypes |= MAPINFO_TYPE_CTS.m_flags;
403 LOG_TRACE("-> diameter ", ftos(diameter));
404 LOG_TRACE("; spawnpoints ", ftos(spawnpoints));
405 LOG_TRACE("; modes ", ftos(MapInfo_Map_supportedGametypes));
412 void _MapInfo_Map_Reset()
414 MapInfo_Map_title = "<TITLE>";
415 MapInfo_Map_titlestring = "<TITLE>";
416 MapInfo_Map_description = "<DESCRIPTION>";
417 MapInfo_Map_author = "<AUTHOR>";
418 MapInfo_Map_supportedGametypes = 0;
419 MapInfo_Map_supportedFeatures = 0;
420 MapInfo_Map_flags = 0;
421 MapInfo_Map_clientstuff = "";
422 MapInfo_Map_fog = "";
423 MapInfo_Map_mins = '0 0 0';
424 MapInfo_Map_maxs = '0 0 0';
427 string _MapInfo_GetDefault(Gametype t)
429 return t.m_legacydefaults;
432 void _MapInfo_Map_ApplyGametype(string s, Gametype pWantedType, Gametype pThisType, int load_default)
435 MapInfo_Map_supportedGametypes |= pThisType.m_flags;
436 if(!(pThisType.m_flags & pWantedType.m_flags))
440 _MapInfo_Map_ApplyGametype(_MapInfo_GetDefault(pThisType), pWantedType, pThisType, false);
442 if(!pWantedType.frags) // these modes don't use fraglimit
444 cvar_set("fraglimit", "0");
450 cvar_set("fraglimit", sa);
456 cvar_set("timelimit", sa);
459 if(pWantedType.m_setTeams)
463 pWantedType.m_setTeams(sa);
467 // rc = timelimit timelimit_qualification laps laps_teamplay
468 if(pWantedType == MAPINFO_TYPE_RACE)
470 cvar_set("fraglimit", "0"); // special case!
472 sa = car(s); if(sa == "") sa = cvar_string("timelimit");
473 cvar_set("g_race_qualifying_timelimit", sa);
478 if(cvar("g_race_teams") < 2)
479 cvar_set("fraglimit", sa);
484 if(cvar("g_race_teams") >= 2)
485 cvar_set("fraglimit", sa);
489 if(!pWantedType.frags) // these modes don't use fraglimit
491 cvar_set("leadlimit", "0");
497 cvar_set("leadlimit", sa);
502 string _MapInfo_GetDefaultEx(Gametype t)
504 return t ? t.model2 : "";
507 float _MapInfo_GetTeamPlayBool(Gametype t)
509 return t ? t.team : false;
512 void _MapInfo_Map_ApplyGametypeEx(string s, Gametype pWantedType, Gametype pThisType)
514 MapInfo_Map_supportedGametypes |= pThisType.m_flags;
515 if (!(pThisType.m_flags & pWantedType.m_flags))
518 // reset all the cvars to their defaults
520 cvar_set("timelimit", cvar_defstring("timelimit"));
521 cvar_set("leadlimit", cvar_defstring("leadlimit"));
522 cvar_set("fraglimit", cvar_defstring("fraglimit"));
523 FOREACH(Gametypes, true, it.m_parse_mapinfo(string_null, string_null));
525 string fraglimit_normal = string_null;
526 string fraglimit_teams = string_null;
528 for (s = strcat(_MapInfo_GetDefaultEx(pWantedType), " ", s); s != ""; s = cdr(s)) {
530 if (sa == "") continue;
531 int p = strstrofs(sa, "=", 0);
534 LOG_WARNF("Invalid gametype setting in mapinfo for gametype %s: %s", MapInfo_Type_ToString(pWantedType), sa);
537 string k = substring(sa, 0, p);
538 string v = substring(sa, p + 1, -1);
543 cvar_set("timelimit", v);
548 cvar_set("leadlimit", v);
557 fraglimit_normal = v;
560 case "teampointlimit":
572 FOREACH(Gametypes, true, handled |= it.m_parse_mapinfo(k, v));
573 if (!handled && WARN_COND)
574 LOG_WARNF("Invalid gametype setting in mapinfo for gametype %s: %s", MapInfo_Type_ToString(pWantedType), sa);
577 if (pWantedType == MAPINFO_TYPE_RACE && cvar("g_race_teams") >= 2)
580 cvar_set("fraglimit", fraglimit_teams);
585 cvar_set("fraglimit", fraglimit_normal);
589 Gametype MapInfo_Type_FromString(string gtype, bool dowarn)
591 string replacement = "";
594 case "nexball": replacement = "nb"; break;
595 case "freezetag": replacement = "ft"; break;
596 case "keepaway": replacement = "ka"; break;
597 case "invasion": replacement = "inv"; break;
598 case "assault": replacement = "as"; break;
599 case "race": replacement = "rc"; break;
601 if (replacement != "")
603 if (dowarn && WARN_COND)
604 LOG_WARNF("MapInfo_Type_FromString (probably %s): using deprecated name '%s'. Should use '%s'.", MapInfo_Map_bspname, gtype, replacement);
607 FOREACH(Gametypes, it.mdl == gtype, return it);
611 string MapInfo_Type_Description(Gametype t)
613 return t ? t.gametype_description : "";
616 string MapInfo_Type_ToString(Gametype t)
618 return t ? t.mdl : "";
621 string MapInfo_Type_ToText(Gametype t)
623 /* xgettext:no-c-format */
624 return t ? t.message : _("@!#%'n Tuba Throwing");
627 void _MapInfo_Parse_Settemp(string pFilename, string acl, float type, string s, float recurse)
631 t = car(s); s = cdr(s);
633 // limited support of "" and comments
634 // remove trailing and leading " of t
635 if(substring(t, 0, 1) == "\"")
637 if(substring(t, -1, 1) == "\"")
638 t = substring(t, 1, -2);
641 // remove leading " of s
642 if(substring(s, 0, 1) == "\"")
644 s = substring(s, 1, -1);
646 // remove trailing " of s, and all that follows (cvar description)
647 o = strstrofs(s, "\"", 0);
649 s = substring(s, 0, o);
651 // remove // comments
652 o = strstrofs(s, "//", 0);
654 s = substring(s, 0, o);
656 // remove trailing spaces
657 while(substring(s, -1, 1) == " ")
658 s = substring(s, 0, -2);
664 fh = fopen(s, FILE_READ);
668 LOG_WARN("Map ", pFilename, " references not existing config file ", s);
672 while((s = fgets(fh)))
674 // catch different sorts of comments
675 if(s == "") // empty lines
677 if(substring(s, 0, 1) == "#") // UNIX style
679 if(substring(s, 0, 2) == "//") // C++ style
681 if(substring(s, 0, 1) == "_") // q3map style
684 if(substring(s, 0, 4) == "set ")
685 s = substring(s, 4, -1);
686 if(substring(s, 0, 5) == "seta ")
687 s = substring(s, 5, -1);
689 _MapInfo_Parse_Settemp(pFilename, acl, type, s, recurse - 1);
695 LOG_WARN("Map ", pFilename, " uses too many levels of inclusion");
698 || !cvar_value_issafe(t)
699 || !cvar_value_issafe(s)
700 || matchacl(MAPINFO_SETTEMP_ACL_SYSTEM, t) <= 0)
703 LOG_WARN("Map ", pFilename, " contains a potentially harmful setting, ignored");
705 else if(matchacl(acl, t) <= 0)
708 LOG_WARN("Map ", pFilename, " contains a denied setting, ignored");
712 if(type == 0) // server set
714 LOG_TRACE("Applying temporary setting ", t, " := ", s);
716 if(cvar("g_campaign"))
717 cvar_set(t, s); // this is a wrapper and is always temporary anyway; no need to backup old values then
724 LOG_TRACE("Applying temporary client setting ", t, " := ", s);
725 MapInfo_Map_clientstuff = strcat(
726 MapInfo_Map_clientstuff, "cl_cmd settemp \"", t, "\" \"", s, "\"\n"
732 float MapInfo_isRedundant(string fn, string t)
734 // normalize file name
735 fn = strreplace("_", "", fn);
736 fn = strreplace("-", "", fn);
738 // normalize visible title
739 t = strreplace(":", "", t);
740 t = strreplace(" ", "", t);
741 t = strreplace("_", "", t);
742 t = strreplace("-", "", t);
743 t = strreplace("'", "", t);
744 t = strdecolorize(t);
746 // we allow the visible title to have punctuation the file name does
747 // not, but not vice versa
748 if(!strcasecmp(fn, t))
754 // load info about a map by name into the MapInfo_Map_* globals
755 float MapInfo_Get_ByName_NoFallbacks(string pFilename, int pAllowGenerate, Gametype pGametypeToSet)
764 acl = MAPINFO_SETTEMP_ACL_USER;
766 if(strstrofs(pFilename, "/", 0) >= 0)
768 LOG_WARN("Invalid character in map name, ignored");
772 if(pGametypeToSet == NULL)
773 if(MapInfo_Cache_Retrieve(pFilename))
778 MapInfo_Map_bspname = pFilename;
780 // default all generic fields so they have "good" values in case something fails
781 fn = strcat("maps/", pFilename, ".mapinfo");
782 fh = fopen(fn, FILE_READ);
785 fn = strcat("maps/autogenerated/", pFilename, ".mapinfo");
786 fh = fopen(fn, FILE_READ);
791 _MapInfo_Map_Reset();
792 r = _MapInfo_Generate(pFilename);
795 fh = fopen(fn, FILE_WRITE);
796 fputs(fh, strcat("title ", MapInfo_Map_title, "\n"));
797 fputs(fh, strcat("description ", MapInfo_Map_description, "\n"));
798 fputs(fh, strcat("author ", MapInfo_Map_author, "\n"));
799 if(_MapInfo_Map_worldspawn_music != "")
802 substring(_MapInfo_Map_worldspawn_music, strlen(_MapInfo_Map_worldspawn_music) - 4, 4) == ".wav"
804 substring(_MapInfo_Map_worldspawn_music, strlen(_MapInfo_Map_worldspawn_music) - 4, 4) == ".ogg"
806 fputs(fh, strcat("cdtrack ", substring(_MapInfo_Map_worldspawn_music, 0, strlen(_MapInfo_Map_worldspawn_music) - 4), "\n"));
808 fputs(fh, strcat("cdtrack ", _MapInfo_Map_worldspawn_music, "\n"));
812 n = tokenize_console(cvar_string("g_cdtracks_remaplist"));
813 s = strcat(" ", cvar_string("g_cdtracks_dontusebydefault"), " ");
816 i = floor(random() * n);
817 if(strstrofs(s, strcat(" ", argv(i), " "), 0) < 0)
820 fputs(fh, strcat("cdtrack ", ftos(i + 1), "\n"));
822 if(MapInfo_Map_supportedFeatures & MAPINFO_FEATURE_WEAPONS)
823 fputs(fh, "has weapons\n");
825 fputs(fh, "// uncomment this if you added weapon pickups: has weapons\n");
826 if(MapInfo_Map_supportedFeatures & MAPINFO_FEATURE_TURRETS)
827 fputs(fh, "has turrets\n");
829 fputs(fh, "// uncomment this if you added turrets: has turrets\n");
830 if(MapInfo_Map_supportedFeatures & MAPINFO_FEATURE_VEHICLES)
831 fputs(fh, "has vehicles\n");
833 fputs(fh, "// uncomment this if you added vehicles: has vehicles\n");
834 if(MapInfo_Map_flags & MAPINFO_FLAG_FRUSTRATING)
835 fputs(fh, "frustrating\n");
837 FOREACH(Gametypes, MapInfo_Map_supportedGametypes & it.m_flags, {
838 fputs(fh, sprintf("gametype %s // defaults: %s\n", MapInfo_Type_ToString(it), _MapInfo_GetDefaultEx(it)));
841 fputs(fh, "// optional: fog density red green blue alpha mindist maxdist\n");
842 fputs(fh, "// optional: settemp_for_type (all|gametypename) cvarname value\n");
843 fputs(fh, "// optional: clientsettemp_for_type (all|gametypename) cvarname value\n");
844 fputs(fh, "// optional: size mins_x mins_y mins_z maxs_x maxs_y maxs_z\n");
845 fputs(fh, "// optional: hidden\n");
850 fh = fopen(fn, FILE_READ);
852 error("... but I just wrote it!");
856 LOG_WARN("autogenerated mapinfo file ", fn, " has been loaded; please edit that file and move it to maps/", pFilename, ".mapinfo");
859 _MapInfo_Map_Reset();
862 if (!((s = fgets(fh))))
865 // catch different sorts of comments
866 if(s == "") // empty lines
868 if(substring(s, 0, 1) == "#") // UNIX style
870 if(substring(s, 0, 2) == "//") // C++ style
872 if(substring(s, 0, 1) == "_") // q3map style
875 p = strstrofs(s, "//", 0);
877 s = substring(s, 0, p);
879 t = car(s); s = cdr(s);
881 MapInfo_Map_title = s;
882 else if(t == "description")
883 MapInfo_Map_description = s;
884 else if(t == "author")
885 MapInfo_Map_author = s;
888 t = car(s); // s = cdr(s);
889 if (t == "weapons") MapInfo_Map_supportedFeatures |= MAPINFO_FEATURE_WEAPONS;
890 else if(t == "turrets") MapInfo_Map_supportedFeatures |= MAPINFO_FEATURE_TURRETS;
891 else if(t == "vehicles") MapInfo_Map_supportedFeatures |= MAPINFO_FEATURE_VEHICLES;
892 else if(t == "monsters") MapInfo_Map_supportedFeatures |= MAPINFO_FEATURE_MONSTERS;
893 else if(t == "new_toys") MapInfo_Map_supportedFeatures |= MAPINFO_FEATURE_WEAPONS;
895 LOG_WARN("Map ", pFilename, " supports unknown feature ", t, ", ignored");
897 else if(t == "hidden")
899 MapInfo_Map_flags |= MAPINFO_FLAG_HIDDEN;
901 else if(t == "forbidden")
903 MapInfo_Map_flags |= MAPINFO_FLAG_FORBIDDEN;
905 else if(t == "frustrating")
907 MapInfo_Map_flags |= MAPINFO_FLAG_FRUSTRATING;
909 else if(t == "noautomaplist")
911 MapInfo_Map_flags |= MAPINFO_FLAG_NOAUTOMAPLIST;
913 else if(t == "gameversion_min")
915 if (cvar("gameversion") < stof(s))
916 MapInfo_Map_flags |= MAPINFO_FLAG_NOAUTOMAPLIST;
920 t = car(s); s = cdr(s);
921 Gametype f = MapInfo_Type_FromString(t, true);
923 //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'.");
925 _MapInfo_Map_ApplyGametype (s, pGametypeToSet, f, true);
927 LOG_DEBUG("Map ", pFilename, " supports unknown game type ", t, ", ignored");
929 else if(t == "gametype")
931 t = car(s); s = cdr(s);
932 Gametype f = MapInfo_Type_FromString(t, true);
934 _MapInfo_Map_ApplyGametypeEx (s, pGametypeToSet, f);
936 LOG_DEBUG("Map ", pFilename, " supports unknown game type ", t, ", ignored");
941 t = car(s); s = cdr(s); a = stof(t);
942 t = car(s); s = cdr(s); b = stof(t);
943 t = car(s); s = cdr(s); c = stof(t);
944 t = car(s); s = cdr(s); d = stof(t);
945 t = car(s); s = cdr(s); e = stof(t);
949 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");
953 t = car(s); s = cdr(s); f = stof(t);
957 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");
961 if(a >= d || b >= e || c >= f)
964 LOG_WARN("Map ", pFilename, " contains an incorrect size line, mins have to be < maxs");
968 MapInfo_Map_mins.x = a;
969 MapInfo_Map_mins.y = b;
970 MapInfo_Map_mins.z = c;
971 MapInfo_Map_maxs.x = d;
972 MapInfo_Map_maxs.y = e;
973 MapInfo_Map_maxs.z = f;
978 else if(t == "settemp_for_type")
980 t = car(s); s = cdr(s);
981 bool all = t == "all";
983 if(all || (f = MapInfo_Type_FromString(t, true)))
985 if((all ? MAPINFO_TYPE_ALL : f.m_flags) & pGametypeToSet.m_flags)
987 _MapInfo_Parse_Settemp(pFilename, acl, 0, s, 1);
992 LOG_DEBUG("Map ", pFilename, " has a setting for unknown game type ", t, ", ignored");
995 else if(t == "clientsettemp_for_type")
997 t = car(s); s = cdr(s);
998 bool all = t == "all";
1000 if(all || (f = MapInfo_Type_FromString(t, true)))
1002 if((all ? MAPINFO_TYPE_ALL : f.m_flags) & pGametypeToSet.m_flags)
1004 _MapInfo_Parse_Settemp(pFilename, acl, 1, s, 1);
1009 LOG_DEBUG("Map ", pFilename, " has a client setting for unknown game type ", t, ", ignored");
1014 if (!cvar_value_issafe(s))
1017 LOG_WARN("Map ", pFilename, " contains a potentially harmful fog setting, ignored");
1020 MapInfo_Map_fog = s;
1022 else if(t == "cdtrack")
1024 t = car(s); s = cdr(s);
1025 // We do this only if pGametypeToSet even though this
1026 // content is theoretically game type independent,
1027 // because MapInfo_Map_clientstuff contains otherwise
1028 // game type dependent stuff. That way this value stays
1029 // empty when not setting a game type to not set any
1030 // false expectations.
1033 if (!cvar_value_issafe(t))
1036 LOG_WARN("Map ", pFilename, " contains a potentially harmful cdtrack, ignored");
1039 MapInfo_Map_clientstuff = strcat(
1040 MapInfo_Map_clientstuff, "cd loop \"", t, "\"\n"
1045 LOG_WARN("Map ", pFilename, " provides unknown info item ", t, ", ignored");
1049 if(MapInfo_Map_title == "<TITLE>")
1050 MapInfo_Map_titlestring = MapInfo_Map_bspname;
1051 else if(MapInfo_isRedundant(MapInfo_Map_bspname, MapInfo_Map_title))
1052 MapInfo_Map_titlestring = MapInfo_Map_title;
1054 MapInfo_Map_titlestring = sprintf("%s: %s", MapInfo_Map_bspname, MapInfo_Map_title);
1056 MapInfo_Cache_Store();
1057 if(MapInfo_Map_supportedGametypes != 0)
1060 LOG_WARN("Map ", pFilename, " supports no game types, ignored");
1063 int MapInfo_Get_ByName(string pFilename, float pAllowGenerate, Gametype pGametypeToSet)
1065 int r = MapInfo_Get_ByName_NoFallbacks(pFilename, pAllowGenerate, pGametypeToSet);
1067 FOREACH(Gametypes, it.m_isForcedSupported(it), _MapInfo_Map_ApplyGametypeEx("", pGametypeToSet, it));
1071 if(!(MapInfo_Map_supportedGametypes & pGametypeToSet.m_flags))
1073 error("Can't select the requested game type. This should never happen as the caller should prevent it!\n");
1074 //_MapInfo_Map_ApplyGametypeEx("", pGametypeToSet, MAPINFO_TYPE_DEATHMATCH);
1082 float MapInfo_FindName(string s)
1084 // if there is exactly one map of prefix s, return it
1085 // if not, return the null string
1086 // note that DP sorts glob results... so I can use a binary search
1090 // invariants: r is behind s, l-1 is equal or before
1093 m = floor((l + r) / 2);
1094 MapInfo_FindName_match = _MapInfo_GlobItem(MapInfo_FilterList_Lookup(m));
1095 cmp = strcasecmp(MapInfo_FindName_match, s);
1097 return m; // found and good
1099 l = m + 1; // l-1 is before s
1103 MapInfo_FindName_match = _MapInfo_GlobItem(MapInfo_FilterList_Lookup(l));
1104 MapInfo_FindName_firstResult = l;
1105 // r == l, so: l is behind s, l-1 is before
1106 // SO: if there is any, l is the one with the right prefix
1107 // and l+1 may be one too
1108 if(l == MapInfo_count)
1110 MapInfo_FindName_match = string_null;
1111 MapInfo_FindName_firstResult = -1;
1112 return -1; // no MapInfo_FindName_match, behind last item
1114 if(!startsWithNocase(MapInfo_FindName_match, s))
1116 MapInfo_FindName_match = string_null;
1117 MapInfo_FindName_firstResult = -1;
1118 return -1; // wrong prefix
1120 if(l == MapInfo_count - 1)
1121 return l; // last one, nothing can follow => unique
1122 if(startsWithNocase(_MapInfo_GlobItem(MapInfo_FilterList_Lookup(l + 1)), s))
1124 MapInfo_FindName_match = string_null;
1125 return -1; // ambigous MapInfo_FindName_match
1130 string MapInfo_FixName(string s)
1132 MapInfo_FindName(s);
1133 return MapInfo_FindName_match;
1136 int MapInfo_CurrentFeatures()
1139 // TODO: find a better way to check if weapons are required on the map
1140 if(!(cvar("g_instagib") || cvar("g_overkill") || cvar("g_nix") || cvar("g_weaponarena") || !cvar("g_pickup_items") || !cvar("g_melee_only")
1141 || cvar("g_race") || cvar("g_cts") || cvar("g_nexball") || cvar("g_ca") || cvar("g_freezetag") || cvar("g_lms")))
1142 req |= MAPINFO_FEATURE_WEAPONS;
1146 Gametype MapInfo_CurrentGametype()
1148 Gametype prev = MapInfo_Type_FromString(cvar_string("gamecfg"), false);
1149 FOREACH(Gametypes, cvar(it.netname) && it != prev, return it);
1150 return prev ? prev : MAPINFO_TYPE_DEATHMATCH;
1153 float _MapInfo_CheckMap(string s, bool gametype_only) // returns 0 if the map can't be played with the current settings, 1 otherwise
1155 if(!MapInfo_Get_ByName(s, 1, NULL))
1157 if((MapInfo_Map_supportedGametypes & MapInfo_CurrentGametype().m_flags) == 0)
1161 if((MapInfo_Map_supportedFeatures & MapInfo_CurrentFeatures()) != MapInfo_CurrentFeatures())
1166 float MapInfo_CheckMap(string s) // returns 0 if the map can't be played with the current settings, 1 otherwise
1169 r = _MapInfo_CheckMap(s, false);
1170 MapInfo_ClearTemps();
1174 void MapInfo_SwitchGameType(Gametype t)
1176 FOREACH(Gametypes, true, cvar_set(it.netname, (it == t) ? "1" : "0"));
1179 void MapInfo_LoadMap(string s, float reinit)
1181 MapInfo_Map_supportedGametypes = 0;
1182 // we shouldn't need this, as LoadMapSettings already fixes the gametype
1183 //if(!MapInfo_CheckMap(s))
1185 // print("EMERGENCY: can't play the selected map in the given game mode. Falling back to DM.\n");
1186 // MapInfo_SwitchGameType(MAPINFO_TYPE_DEATHMATCH.m_flags);
1189 LOG_INFO("Switching to map ", s);
1191 cvar_settemp_restore();
1193 localcmd(strcat("\nmap ", s, "\n"));
1195 localcmd(strcat("\nchangelevel ", s, "\n"));
1198 string MapInfo_ListAllowedMaps(Gametype type, float pRequiredFlags, float pForbiddenFlags)
1202 // to make absolutely sure:
1203 MapInfo_Enumerate();
1204 MapInfo_FilterGametype(type, MapInfo_CurrentFeatures(), pRequiredFlags, pForbiddenFlags, 0);
1207 for(float i = 0; i < MapInfo_count; ++i)
1208 out = strcat(out, " ", _MapInfo_GlobItem(MapInfo_FilterList_Lookup(i)));
1209 return substring(out, 1, strlen(out) - 1);
1212 string MapInfo_ListAllAllowedMaps(float pRequiredFlags, float pForbiddenFlags)
1216 // to make absolutely sure:
1217 MapInfo_Enumerate();
1218 _MapInfo_FilterGametype(MAPINFO_TYPE_ALL, 0, pRequiredFlags, pForbiddenFlags, 0);
1221 for(float i = 0; i < MapInfo_count; ++i)
1222 out = strcat(out, " ", _MapInfo_GlobItem(MapInfo_FilterList_Lookup(i)));
1224 MapInfo_FilterGametype(MapInfo_CurrentGametype(), MapInfo_CurrentFeatures(), pRequiredFlags, pForbiddenFlags, 0);
1226 return substring(out, 1, strlen(out) - 1);
1229 void MapInfo_LoadMapSettings_SaveGameType(Gametype t)
1231 MapInfo_SwitchGameType(t);
1232 cvar_set("gamecfg", t.mdl);
1233 MapInfo_LoadedGametype = t;
1236 void MapInfo_LoadMapSettings(string s) // to be called from worldspawn
1238 Gametype t = MapInfo_CurrentGametype();
1239 MapInfo_LoadMapSettings_SaveGameType(t);
1241 if(!_MapInfo_CheckMap(s, true)) // with underscore, it keeps temps
1243 if(cvar("g_mapinfo_allow_unsupported_modes_and_let_stuff_break"))
1245 LOG_SEVERE("can't play the selected map in the given game mode. Working with only the override settings.");
1246 _MapInfo_Map_ApplyGametypeEx("", t, t);
1247 return; // do not call Get_ByName!
1250 if(MapInfo_Map_supportedGametypes == 0)
1252 RandomSelection_Init();
1253 FOREACH(Gametypes, it.m_priority == 2,
1255 MapInfo_Map_supportedGametypes |= it.m_flags;
1256 RandomSelection_AddEnt(it, 1, 1);
1258 if(RandomSelection_chosen_ent)
1259 t = RandomSelection_chosen_ent;
1260 LOG_SEVEREF("Mapinfo system is not functional at all. Falling back to a preferred mode (%s).", t.mdl);
1261 MapInfo_LoadMapSettings_SaveGameType(t);
1262 _MapInfo_Map_ApplyGametypeEx("", t, t);
1263 return; // do not call Get_ByName!
1267 // find the lowest bit in the supported gametypes
1268 // unnecessary now that we select one at random
1270 while(!(MapInfo_Map_supportedGametypes & 1))
1273 MapInfo_Map_supportedGametypes = floor(MapInfo_Map_supportedGametypes >> 1);
1276 RandomSelection_Init();
1277 Gametype t_prev = t;
1278 FOREACH(Gametypes, MapInfo_Map_supportedGametypes & it.m_flags,
1280 RandomSelection_AddEnt(it, 1, it.m_priority);
1282 if(RandomSelection_chosen_ent)
1283 t = RandomSelection_chosen_ent;
1285 // t is now a supported mode!
1286 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);
1287 MapInfo_LoadMapSettings_SaveGameType(t);
1289 if(!_MapInfo_CheckMap(s, false)) { // with underscore, it keeps temps
1290 LOG_WARNF("the selected map lacks features required by current settings; playing anyway.");
1292 MapInfo_Get_ByName(s, 1, t);
1295 void MapInfo_ClearTemps()
1297 MapInfo_Map_bspname = string_null;
1298 MapInfo_Map_title = string_null;
1299 MapInfo_Map_titlestring = string_null;
1300 MapInfo_Map_description = string_null;
1301 MapInfo_Map_author = string_null;
1302 MapInfo_Map_clientstuff = string_null;
1303 MapInfo_Map_supportedGametypes = 0;
1304 MapInfo_Map_supportedFeatures = 0;
1307 void MapInfo_Shutdown()
1309 MapInfo_ClearTemps();
1310 MapInfo_Filter_Free();
1311 MapInfo_Cache_Destroy();
1312 if(_MapInfo_globopen)
1314 search_end(_MapInfo_globhandle);
1315 _MapInfo_globhandle = -1;
1316 _MapInfo_globopen = false;
1320 int MapInfo_ForbiddenFlags()
1322 int f = MAPINFO_FLAG_FORBIDDEN;
1325 if (!cvar("g_maplist_allow_hidden"))
1327 f |= MAPINFO_FLAG_HIDDEN;
1329 if (!cvar("g_maplist_allow_frustrating"))
1330 f |= MAPINFO_FLAG_FRUSTRATING;
1335 int MapInfo_RequiredFlags()
1339 if(cvar("g_maplist_allow_frustrating") > 1)
1340 f |= MAPINFO_FLAG_FRUSTRATING;