3 #include <common/util.qh>
4 #include <common/weapons/_all.qh>
7 #include <common/util.qh>
8 #include <common/monsters/_mod.qh>
11 bool autocvar_g_mapinfo_arena_compat = true;
12 bool autocvar_g_mapinfo_arena_generate = false;
15 #define WARN_COND false
17 bool autocvar_g_mapinfo_ignore_warnings;
18 #define WARN_COND (!autocvar_g_mapinfo_ignore_warnings && MapInfo_Map_bspname == mi_shortname)
21 // generic string stuff
23 int _MapInfo_Cache_Active;
24 int _MapInfo_Cache_DB_NameToIndex;
25 int _MapInfo_Cache_Buf_IndexToMapData;
27 void MapInfo_Cache_Destroy()
29 if(!_MapInfo_Cache_Active)
32 db_close(_MapInfo_Cache_DB_NameToIndex);
33 buf_del(_MapInfo_Cache_Buf_IndexToMapData);
34 _MapInfo_Cache_Active = 0;
37 void MapInfo_Cache_Create()
39 MapInfo_Cache_Destroy();
40 _MapInfo_Cache_DB_NameToIndex = db_create();
41 _MapInfo_Cache_Buf_IndexToMapData = buf_create();
42 _MapInfo_Cache_Active = 1;
45 void MapInfo_Cache_Invalidate()
47 if(!_MapInfo_Cache_Active)
50 MapInfo_Cache_Create();
53 void MapInfo_Cache_Store()
57 if(!_MapInfo_Cache_Active)
60 s = db_get(_MapInfo_Cache_DB_NameToIndex, MapInfo_Map_bspname);
63 i = buf_getsize(_MapInfo_Cache_Buf_IndexToMapData);
64 db_put(_MapInfo_Cache_DB_NameToIndex, MapInfo_Map_bspname, ftos(i));
69 // now store all the stuff
70 bufstr_set(_MapInfo_Cache_Buf_IndexToMapData, i, MapInfo_Map_bspname);
71 bufstr_set(_MapInfo_Cache_Buf_IndexToMapData, ++i, MapInfo_Map_title);
72 bufstr_set(_MapInfo_Cache_Buf_IndexToMapData, ++i, MapInfo_Map_titlestring);
73 bufstr_set(_MapInfo_Cache_Buf_IndexToMapData, ++i, MapInfo_Map_description);
74 bufstr_set(_MapInfo_Cache_Buf_IndexToMapData, ++i, MapInfo_Map_author);
75 bufstr_set(_MapInfo_Cache_Buf_IndexToMapData, ++i, ftos(MapInfo_Map_supportedGametypes));
76 bufstr_set(_MapInfo_Cache_Buf_IndexToMapData, ++i, ftos(MapInfo_Map_supportedFeatures));
77 bufstr_set(_MapInfo_Cache_Buf_IndexToMapData, ++i, ftos(MapInfo_Map_flags));
80 float MapInfo_Cache_Retrieve(string map)
84 if(!_MapInfo_Cache_Active)
87 s = db_get(_MapInfo_Cache_DB_NameToIndex, map);
92 // now retrieve all the stuff
93 MapInfo_Map_bspname = bufstr_get(_MapInfo_Cache_Buf_IndexToMapData, i);
94 MapInfo_Map_title = bufstr_get(_MapInfo_Cache_Buf_IndexToMapData, ++i);
95 MapInfo_Map_titlestring = bufstr_get(_MapInfo_Cache_Buf_IndexToMapData, ++i);
96 MapInfo_Map_description = bufstr_get(_MapInfo_Cache_Buf_IndexToMapData, ++i);
97 MapInfo_Map_author = bufstr_get(_MapInfo_Cache_Buf_IndexToMapData, ++i);
98 MapInfo_Map_supportedGametypes = stof(bufstr_get(_MapInfo_Cache_Buf_IndexToMapData, ++i));
99 MapInfo_Map_supportedFeatures = stof(bufstr_get(_MapInfo_Cache_Buf_IndexToMapData, ++i));
100 MapInfo_Map_flags = stof(bufstr_get(_MapInfo_Cache_Buf_IndexToMapData, ++i));
105 // GLOB HANDLING (for all BSP files)
106 float _MapInfo_globopen;
107 float _MapInfo_globcount;
108 float _MapInfo_globhandle;
109 string _MapInfo_GlobItem(float i)
112 if(!_MapInfo_globopen)
114 s = search_getfilename(_MapInfo_globhandle, i);
115 return substring(s, 5, strlen(s) - 9); // without maps/ and .bsp
118 void MapInfo_Enumerate()
120 if(_MapInfo_globopen)
122 search_end(_MapInfo_globhandle);
123 _MapInfo_globopen = 0;
125 MapInfo_Cache_Invalidate();
126 _MapInfo_globhandle = search_begin("maps/*.bsp", true, true);
127 if(_MapInfo_globhandle >= 0)
129 _MapInfo_globcount = search_getsize(_MapInfo_globhandle);
130 _MapInfo_globopen = 1;
133 _MapInfo_globcount = 0;
136 // filter the info by game type mask (updates MapInfo_count)
138 float _MapInfo_filtered;
139 float _MapInfo_filtered_allocated;
140 float MapInfo_FilterList_Lookup(float i)
142 return stof(bufstr_get(_MapInfo_filtered, i));
145 void _MapInfo_FilterList_swap(float i, float j, entity pass)
148 h = bufstr_get(_MapInfo_filtered, i);
149 bufstr_set(_MapInfo_filtered, i, bufstr_get(_MapInfo_filtered, j));
150 bufstr_set(_MapInfo_filtered, j, h);
153 float _MapInfo_FilterList_cmp(float i, float j, entity pass)
156 a = _MapInfo_GlobItem(stof(bufstr_get(_MapInfo_filtered, i)));
157 b = _MapInfo_GlobItem(stof(bufstr_get(_MapInfo_filtered, j)));
158 return strcasecmp(a, b);
161 float MapInfo_FilterGametype(Gametype pGametype, int pFeatures, int pFlagsRequired, int pFlagsForbidden, bool pAbortOnGenerate)
163 return _MapInfo_FilterGametype(pGametype.m_flags, pFeatures, pFlagsRequired, pFlagsForbidden, pAbortOnGenerate);
165 float _MapInfo_FilterGametype(int pGametype, int pFeatures, int pFlagsRequired, int pFlagsForbidden, bool pAbortOnGenerate)
168 if (!_MapInfo_filtered_allocated)
170 _MapInfo_filtered_allocated = 1;
171 _MapInfo_filtered = buf_create();
174 for(i = 0, j = -1; i < _MapInfo_globcount; ++i)
176 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.
179 LOG_TRACE("Autogenerated a .mapinfo, doing the rest later.");
180 MapInfo_progress = i / _MapInfo_globcount;
183 if((MapInfo_Map_supportedGametypes & pGametype) != 0)
184 if((MapInfo_Map_supportedFeatures & pFeatures) == pFeatures)
185 if((MapInfo_Map_flags & pFlagsForbidden) == 0)
186 if((MapInfo_Map_flags & pFlagsRequired) == pFlagsRequired)
187 bufstr_set(_MapInfo_filtered, ++j, ftos(i));
189 MapInfo_count = j + 1;
190 MapInfo_ClearTemps();
192 // sometimes the glob isn't sorted nicely, so fix it here...
193 heapsort(MapInfo_count, _MapInfo_FilterList_swap, _MapInfo_FilterList_cmp, NULL);
197 void MapInfo_FilterString(string sf)
199 // this function further filters _MapInfo_filtered, which is prepared by MapInfo_FilterGametype by string
203 for(i = 0, j = -1; i < MapInfo_count; ++i)
205 if (MapInfo_Get_ByID(i))
207 // prepare for keyword filter
208 if (MapInfo_Map_title && strstrofs(MapInfo_Map_title, "<TITLE>", 0) == -1)
209 title = MapInfo_Map_title;
211 title = MapInfo_Map_bspname;
213 if((strstrofs(strtolower(title), strtolower(sf), 0)) >= 0)
214 bufstr_set(_MapInfo_filtered, ++j, bufstr_get(_MapInfo_filtered, i));
217 MapInfo_count = j + 1;
218 MapInfo_ClearTemps();
220 // sometimes the glob isn't sorted nicely, so fix it here...
221 heapsort(MapInfo_count, _MapInfo_FilterList_swap, _MapInfo_FilterList_cmp, NULL);
224 void MapInfo_Filter_Free()
226 if(_MapInfo_filtered_allocated)
228 buf_del(_MapInfo_filtered);
229 _MapInfo_filtered_allocated = 0;
233 // load info about the i-th map into the MapInfo_Map_* globals
234 string MapInfo_BSPName_ByID(float i)
236 return _MapInfo_GlobItem(MapInfo_FilterList_Lookup(i));
239 string unquote(string s)
242 for(float i = 0; i < l; ++i)
244 string ch = substring(s, i, 1);
245 if((ch != " ") && (ch != "\""))
247 for(float j = l - i - 1; j > 0; --j)
249 ch = substring(s, i+j, 1);
250 if(ch != " ") if(ch != "\"")
251 return substring(s, i, j+1);
253 return substring(s, i, 1);
259 float MapInfo_Get_ByID(float i)
261 if(MapInfo_Get_ByName(MapInfo_BSPName_ByID(i), 0, NULL))
266 string _MapInfo_Map_worldspawn_music;
268 float _MapInfo_Generate(string pFilename) // 0: failure, 1: ok ent, 2: ok bsp
277 float diameter, spawnpoints;
280 vector mapMins, mapMaxs;
283 fn = strcat("maps/", pFilename, ".ent");
284 fh = fopen(fn, FILE_READ);
288 fn = strcat("maps/", pFilename, ".bsp");
289 fh = fopen(fn, FILE_READ);
293 LOG_INFO("Analyzing ", fn, " to generate initial mapinfo");
296 MapInfo_Map_flags = 0;
297 MapInfo_Map_supportedGametypes = 0;
300 _MapInfo_Map_worldspawn_music = "";
304 if(autocvar_g_mapinfo_arena_generate)
306 // try for .arena or .defi files, as they may have more accurate information
308 string arena_fn = _MapInfo_FindArenaFile(pFilename, ".arena");
309 int arena_fh = fopen(arena_fn, FILE_READ);
313 arena_fn = _MapInfo_FindArenaFile(pFilename, ".defi");
314 arena_fh = fopen(arena_fn, FILE_READ);
318 _MapInfo_ParseArena(arena_fn, arena_fh, pFilename, NULL, isdefi, true);
325 if (!((s = fgets(fh))))
327 if(inWorldspawn == 1)
328 if(startsWith(s, "}"))
334 if(k == "classname" && v == "worldspawn")
336 else if(k == "author")
337 MapInfo_Map_author = v;
338 else if(k == "_description")
339 MapInfo_Map_description = v;
340 else if(k == "music")
341 _MapInfo_Map_worldspawn_music = v;
342 else if(k == "noise")
343 _MapInfo_Map_worldspawn_music = v;
344 else if(k == "message")
346 i = strstrofs(v, " by ", 0);
347 if(MapInfo_Map_author == "<AUTHOR>" && i >= 0)
349 MapInfo_Map_title = substring(v, 0, i);
350 MapInfo_Map_author = substring(v, i + 4, strlen(v) - (i + 4));
353 MapInfo_Map_title = v;
360 o = stov(strcat("'", v, "'"));
361 mapMins.x = min(mapMins.x, o.x);
362 mapMins.y = min(mapMins.y, o.y);
363 mapMins.z = min(mapMins.z, o.z);
364 mapMaxs.x = max(mapMaxs.x, o.x);
365 mapMaxs.y = max(mapMaxs.y, o.y);
366 mapMaxs.z = max(mapMaxs.z, o.z);
368 else if(k == "race_place")
373 else if(k == "classname")
375 if(v == "info_player_team1")
377 else if(v == "info_player_team2")
379 else if(v == "info_player_start")
381 else if(v == "info_player_deathmatch")
383 else if(v == "weapon_nex")
385 else if(v == "weapon_railgun")
387 else if(startsWith(v, "weapon_"))
388 MapInfo_Map_supportedFeatures |= MAPINFO_FEATURE_WEAPONS;
389 else if(startsWith(v, "turret_"))
390 MapInfo_Map_supportedFeatures |= MAPINFO_FEATURE_TURRETS;
391 else if(startsWith(v, "vehicle_"))
392 MapInfo_Map_supportedFeatures |= MAPINFO_FEATURE_VEHICLES;
393 else if(startsWith(v, "monster_"))
394 MapInfo_Map_supportedFeatures |= MAPINFO_FEATURE_MONSTERS;
395 else if(v == "target_music" || v == "trigger_music")
396 _MapInfo_Map_worldspawn_music = string_null; // don't use regular BGM
398 FOREACH(Gametypes, true, it.m_generate_mapinfo(it, v));
404 LOG_WARN(fn, " ended still in worldspawn, BUG");
407 diameter = vlen(mapMaxs - mapMins);
409 int twoBaseModes = 0;
410 FOREACH(Gametypes, it.m_isTwoBaseMode(), twoBaseModes |= it.m_flags);
411 if(twoBaseModes && (twoBaseModes &= MapInfo_Map_supportedGametypes))
413 // we have a symmetrical map, don't add the modes without bases
417 FOREACH(Gametypes, it.m_isAlwaysSupported(it, spawnpoints, diameter), MapInfo_Map_supportedGametypes |= it.m_flags);
420 if(MapInfo_Map_supportedGametypes & MAPINFO_TYPE_RACE.m_flags)
423 MapInfo_Map_supportedGametypes &= ~MAPINFO_TYPE_RACE.m_flags;
424 MapInfo_Map_supportedGametypes |= MAPINFO_TYPE_CTS.m_flags;
427 LOG_TRACE("-> diameter ", ftos(diameter));
428 LOG_TRACE("; spawnpoints ", ftos(spawnpoints));
429 LOG_TRACE("; modes ", ftos(MapInfo_Map_supportedGametypes));
436 void _MapInfo_Map_Reset()
438 MapInfo_Map_title = "<TITLE>";
439 MapInfo_Map_titlestring = "<TITLE>";
440 MapInfo_Map_description = "<DESCRIPTION>";
441 MapInfo_Map_author = "<AUTHOR>";
442 MapInfo_Map_supportedGametypes = 0;
443 MapInfo_Map_supportedFeatures = 0;
444 MapInfo_Map_flags = 0;
445 MapInfo_Map_clientstuff = "";
446 MapInfo_Map_fog = "";
447 MapInfo_Map_mins = '0 0 0';
448 MapInfo_Map_maxs = '0 0 0';
451 string _MapInfo_GetDefault(Gametype t)
453 return t.m_legacydefaults;
456 void _MapInfo_Map_ApplyGametype(string s, Gametype pWantedType, Gametype pThisType, int load_default)
459 MapInfo_Map_supportedGametypes |= pThisType.m_flags;
460 if(!(pThisType.m_flags & pWantedType.m_flags))
464 _MapInfo_Map_ApplyGametype(_MapInfo_GetDefault(pThisType), pWantedType, pThisType, false);
466 if(!pWantedType.frags) // these modes don't use fraglimit
468 cvar_set("fraglimit", "0");
474 cvar_set("fraglimit", sa);
480 cvar_set("timelimit", sa);
483 if(pWantedType.m_setTeams)
487 pWantedType.m_setTeams(sa);
491 // rc = timelimit timelimit_qualification laps laps_teamplay
492 if(pWantedType == MAPINFO_TYPE_RACE)
494 cvar_set("fraglimit", "0"); // special case!
496 sa = car(s); if(sa == "") sa = cvar_string("timelimit");
497 cvar_set("g_race_qualifying_timelimit", sa);
502 if(cvar("g_race_teams") < 2)
503 cvar_set("fraglimit", sa);
508 if(cvar("g_race_teams") >= 2)
509 cvar_set("fraglimit", sa);
513 if(!pWantedType.frags) // these modes don't use fraglimit
515 cvar_set("leadlimit", "0");
521 cvar_set("leadlimit", sa);
526 string _MapInfo_GetDefaultEx(Gametype t)
528 return t ? t.model2 : "";
531 float _MapInfo_GetTeamPlayBool(Gametype t)
533 return t ? t.team : false;
536 void _MapInfo_Map_ApplyGametypeEx(string s, Gametype pWantedType, Gametype pThisType)
538 MapInfo_Map_supportedGametypes |= pThisType.m_flags;
539 if (!(pThisType.m_flags & pWantedType.m_flags))
542 // reset all the cvars to their defaults
544 cvar_set("timelimit", cvar_defstring("timelimit"));
545 cvar_set("leadlimit", cvar_defstring("leadlimit"));
546 cvar_set("fraglimit", cvar_defstring("fraglimit"));
547 FOREACH(Gametypes, true, it.m_parse_mapinfo(string_null, string_null));
549 string fraglimit_normal = string_null;
550 string fraglimit_teams = string_null;
552 for (s = strcat(_MapInfo_GetDefaultEx(pWantedType), " ", s); s != ""; s = cdr(s)) {
554 if (sa == "") continue;
555 int p = strstrofs(sa, "=", 0);
558 LOG_WARNF("Invalid gametype setting in mapinfo for gametype %s: %s", MapInfo_Type_ToString(pWantedType), sa);
561 string k = substring(sa, 0, p);
562 string v = substring(sa, p + 1, -1);
567 cvar_set("timelimit", v);
572 cvar_set("leadlimit", v);
581 fraglimit_normal = v;
584 case "teampointlimit":
596 FOREACH(Gametypes, true, handled |= it.m_parse_mapinfo(k, v));
597 if (!handled && WARN_COND)
598 LOG_WARNF("Invalid gametype setting in mapinfo for gametype %s: %s", MapInfo_Type_ToString(pWantedType), sa);
601 if (pWantedType == MAPINFO_TYPE_RACE && cvar("g_race_teams") >= 2)
604 cvar_set("fraglimit", fraglimit_teams);
609 cvar_set("fraglimit", fraglimit_normal);
613 Gametype MapInfo_Type_FromString(string gtype, bool dowarn, bool is_q3compat)
615 string replacement = "";
619 case "nexball": replacement = "nb"; break;
620 case "freezetag": replacement = "ft"; break;
621 case "keepaway": replacement = "ka"; break;
622 case "invasion": replacement = "inv"; break;
623 case "assault": replacement = "as"; break;
624 case "race": replacement = "rc"; break;
626 case "ffa": replacement = "dm"; do_warn = false; break;
628 case "oneflag": replacement = "ctf"; do_warn = false; break;
629 case "tourney": replacement = "duel"; do_warn = false; break;
630 case "arena": if(is_q3compat) { replacement = "ca"; do_warn = false; } break;
632 if (replacement != "")
634 if (dowarn && WARN_COND)
635 LOG_WARNF("MapInfo_Type_FromString (probably %s): using deprecated name '%s'. Should use '%s'.", MapInfo_Map_bspname, gtype, replacement);
638 FOREACH(Gametypes, it.mdl == gtype, return it);
642 string MapInfo_Type_Description(Gametype t)
644 return t ? t.gametype_description : "";
647 string MapInfo_Type_ToString(Gametype t)
649 return t ? t.mdl : "";
652 string MapInfo_Type_ToText(Gametype t)
654 /* xgettext:no-c-format */
655 return t ? t.message : _("@!#%'n Tuba Throwing");
658 void _MapInfo_Parse_Settemp(string pFilename, string acl, float type, string s, float recurse)
662 t = car(s); s = cdr(s);
664 // limited support of "" and comments
665 // remove trailing and leading " of t
666 if(substring(t, 0, 1) == "\"")
668 if(substring(t, -1, 1) == "\"")
669 t = substring(t, 1, -2);
672 // remove leading " of s
673 if(substring(s, 0, 1) == "\"")
675 s = substring(s, 1, -1);
677 // remove trailing " of s, and all that follows (cvar description)
678 o = strstrofs(s, "\"", 0);
680 s = substring(s, 0, o);
682 // remove // comments
683 o = strstrofs(s, "//", 0);
685 s = substring(s, 0, o);
687 // remove trailing spaces
688 while(substring(s, -1, 1) == " ")
689 s = substring(s, 0, -2);
695 fh = fopen(s, FILE_READ);
699 LOG_WARN("Map ", pFilename, " references not existing config file ", s);
703 while((s = fgets(fh)))
705 // catch different sorts of comments
706 if(s == "") // empty lines
708 if(substring(s, 0, 1) == "#") // UNIX style
710 if(substring(s, 0, 2) == "//") // C++ style
712 if(substring(s, 0, 1) == "_") // q3map style
715 if(substring(s, 0, 4) == "set ")
716 s = substring(s, 4, -1);
717 if(substring(s, 0, 5) == "seta ")
718 s = substring(s, 5, -1);
720 _MapInfo_Parse_Settemp(pFilename, acl, type, s, recurse - 1);
726 LOG_WARN("Map ", pFilename, " uses too many levels of inclusion");
729 || !cvar_value_issafe(t)
730 || !cvar_value_issafe(s)
731 || matchacl(MAPINFO_SETTEMP_ACL_SYSTEM, t) <= 0)
734 LOG_WARN("Map ", pFilename, " contains a potentially harmful setting, ignored");
736 else if(matchacl(acl, t) <= 0)
739 LOG_WARN("Map ", pFilename, " contains a denied setting, ignored");
743 if(type == 0) // server set
745 LOG_TRACE("Applying temporary setting ", t, " := ", s);
747 if(cvar("g_campaign"))
748 cvar_set(t, s); // this is a wrapper and is always temporary anyway; no need to backup old values then
755 LOG_TRACE("Applying temporary client setting ", t, " := ", s);
756 MapInfo_Map_clientstuff = strcat(
757 MapInfo_Map_clientstuff, "cl_cmd settemp \"", t, "\" \"", s, "\"\n"
763 float MapInfo_isRedundant(string fn, string t)
765 // normalize file name
766 fn = strreplace("_", "", fn);
767 fn = strreplace("-", "", fn);
769 // normalize visible title
770 t = strreplace(":", "", t);
771 t = strreplace(" ", "", t);
772 t = strreplace("_", "", t);
773 t = strreplace("-", "", t);
774 t = strreplace("'", "", t);
775 t = strdecolorize(t);
777 // we allow the visible title to have punctuation the file name does
778 // not, but not vice versa
779 if(!strcasecmp(fn, t))
785 bool _MapInfo_ParseArena(string arena_filename, int fh, string pFilename, Gametype pGametypeToSet, bool isdefi, bool isgenerator)
787 // NOTE: .arena files can hold more than 1 map's information!
788 // to handle this, we're going to store gathered information in local variables and save it if we encounter the correct map name
789 bool in_brackets = false; // testing a potential mapinfo section (within brackets)
790 bool dosave = (arena_filename == strcat("scripts/", pFilename, ((isdefi) ? ".defi" : ".arena"))); // if the map is using the fallback, just accept the first found mapinfo (it's probably correct!)
791 string stored_Map_description = "";
792 string stored_Map_title = "";
793 string stored_Map_author = "";
794 int stored_supportedGametypes = 0;
795 int stored_supportedFeatures = 0;
796 int stored_flags = 0;
800 if (!((s = fgets(fh))))
803 // catch different sorts of comments
804 if(s == "") // empty lines
806 if(substring(s, 0, 1) == "#") // UNIX style
808 if(substring(s, 0, 2) == "//") // C++ style
810 if(substring(s, 0, 1) == "_") // q3map style
812 if(strstrofs(s, "{", 0) >= 0)
815 return false; // edge case? already in a bracketed section!
819 else if(!in_brackets)
821 // if we're not inside a bracket, don't process map info
824 if(strstrofs(s, "}", 0) >= 0)
827 return false; // no starting bracket! let the mapinfo generation system handle it
831 MapInfo_Map_description = stored_Map_description;
832 if(stored_Map_title != "")
833 MapInfo_Map_title = stored_Map_title;
834 MapInfo_Map_author = stored_Map_author;
836 MapInfo_Map_supportedGametypes = stored_supportedGametypes;
839 FOREACH(Gametypes, it.m_flags & stored_supportedGametypes,
841 _MapInfo_Map_ApplyGametype ("", pGametypeToSet, it, true);
844 MapInfo_Map_supportedFeatures = stored_supportedFeatures;
845 MapInfo_Map_flags = stored_flags;
846 return true; // no need to continue through the file, we have our map!
850 // discard any gathered locals, we're not using the correct map!
851 stored_Map_description = "";
852 stored_Map_title = "";
853 stored_Map_author = "";
854 stored_supportedGametypes = 0;
855 stored_supportedFeatures = 0;
861 s = strreplace("\t", " ", s);
863 float p = strstrofs(s, "//", 0);
865 s = substring(s, 0, p);
867 // perform an initial trim to ensure the first argument is properly obtained
868 // remove leading spaces
869 while(substring(s, 0, 1) == " ")
870 s = substring(s, 1, -1);
872 t = car(s); s = cdr(s);
873 t = strtolower(t); // apparently some q3 maps use capitalized parameters
875 // remove trailing spaces
876 while(substring(t, -1, 1) == " ")
877 t = substring(t, 0, -2);
879 // remove trailing spaces
880 while(substring(s, -1, 1) == " ")
881 s = substring(s, 0, -2);
882 // remove leading spaces
883 while(substring(s, 0, 1) == " ")
884 s = substring(s, 1, -1);
885 // limited support of ""
886 // remove trailing and leading " of s
887 if(substring(s, 0, 1) == "\"")
889 if(substring(s, -1, 1) == "\"")
890 s = substring(s, 1, -2);
893 stored_Map_title = s;
894 else if(t == "author")
895 stored_Map_author = s;
898 // if there is a valid gametype in this .arena file, include it in the menu
899 stored_supportedFeatures |= MAPINFO_FEATURE_WEAPONS;
900 // type in quake 3 holds all the supported gametypes, so we must loop through all of them
901 string types = strreplace("team", "tdm ft", s); // TODO: handle support here better to include more Xonotic teamplay modes
902 FOREACH_WORD(types, true,
904 Gametype f = MapInfo_Type_FromString(it, false, true);
906 stored_supportedGametypes |= f.m_flags;
909 else if(t == "style" && isdefi)
911 // we have a defrag map on our hands, add CTS!
913 stored_supportedGametypes |= MAPINFO_TYPE_CTS.m_flags;
917 if(strtolower(s) == strtolower(pFilename))
918 dosave = true; // yay, found our map!
920 else if(t == "quote")
921 stored_Map_description = s;
925 // if the map wasn't found in the .arena, fall back to generated .mapinfo
929 #if defined(CSQC) || defined(MENUQC)
930 string(string filename) whichpack = #503;
932 string _MapInfo_FindArenaFile(string pFilename, string extension)
934 string fallback = strcat("scripts/", pFilename, extension);
935 if(!checkextension("DP_QC_FS_SEARCH_PACKFILE"))
937 string base_pack = whichpack(strcat("maps/", pFilename, ".bsp"));
938 if(base_pack == "") // this map isn't packaged!
941 int glob = search_packfile_begin(strcat("scripts/*", extension), true, true, base_pack);
944 int n = search_getsize(glob);
945 for(int j = 0; j < n; ++j)
947 string file = search_getfilename(glob, j);
949 int fh = fopen(file, FILE_READ);
952 for(string s; (s = fgets(fh)); )
954 int offset = strstrofs(s, "map", 0);
957 if(strstrofs(strtolower(s), strcat("\"", strtolower(pFilename), "\""), offset) >= 0) // quake 3 is case insensitive
961 return file; // FOUND IT!
969 return fallback; // if we get here, a valid .arena file could not be found
972 // load info about a map by name into the MapInfo_Map_* globals
973 float MapInfo_Get_ByName_NoFallbacks(string pFilename, int pAllowGenerate, Gametype pGametypeToSet)
982 acl = MAPINFO_SETTEMP_ACL_USER;
984 if(strstrofs(pFilename, "/", 0) >= 0)
986 LOG_WARN("Invalid character in map name, ignored");
990 if(pGametypeToSet == NULL)
991 if(MapInfo_Cache_Retrieve(pFilename))
996 MapInfo_Map_bspname = pFilename;
998 // default all generic fields so they have "good" values in case something fails
999 fn = strcat("maps/", pFilename, ".mapinfo");
1000 fh = fopen(fn, FILE_READ);
1003 if(autocvar_g_mapinfo_arena_compat)
1005 // try for .arena or .defi files if no .mapinfo exists
1006 bool isdefi = false;
1007 fn = _MapInfo_FindArenaFile(pFilename, ".arena");
1008 fh = fopen(fn, FILE_READ);
1012 fn = _MapInfo_FindArenaFile(pFilename, ".defi");
1013 fh = fopen(fn, FILE_READ);
1017 _MapInfo_Map_Reset();
1018 if(_MapInfo_ParseArena(fn, fh, pFilename, pGametypeToSet, isdefi, false))
1019 goto mapinfo_handled; // skip generation
1023 fn = strcat("maps/autogenerated/", pFilename, ".mapinfo");
1024 fh = fopen(fn, FILE_READ);
1029 _MapInfo_Map_Reset();
1030 r = _MapInfo_Generate(pFilename);
1033 fh = fopen(fn, FILE_WRITE);
1034 fputs(fh, strcat("title ", MapInfo_Map_title, "\n"));
1035 fputs(fh, strcat("description ", MapInfo_Map_description, "\n"));
1036 fputs(fh, strcat("author ", MapInfo_Map_author, "\n"));
1037 if(_MapInfo_Map_worldspawn_music != "")
1040 substring(_MapInfo_Map_worldspawn_music, strlen(_MapInfo_Map_worldspawn_music) - 4, 4) == ".wav"
1042 substring(_MapInfo_Map_worldspawn_music, strlen(_MapInfo_Map_worldspawn_music) - 4, 4) == ".ogg"
1044 fputs(fh, strcat("cdtrack ", substring(_MapInfo_Map_worldspawn_music, 0, strlen(_MapInfo_Map_worldspawn_music) - 4), "\n"));
1046 fputs(fh, strcat("cdtrack ", _MapInfo_Map_worldspawn_music, "\n"));
1050 n = tokenize_console(cvar_string("g_cdtracks_remaplist"));
1051 s = strcat(" ", cvar_string("g_cdtracks_dontusebydefault"), " ");
1054 i = floor(random() * n);
1055 if(strstrofs(s, strcat(" ", argv(i), " "), 0) < 0)
1058 fputs(fh, strcat("cdtrack ", ftos(i + 1), "\n"));
1060 if(MapInfo_Map_supportedFeatures & MAPINFO_FEATURE_WEAPONS)
1061 fputs(fh, "has weapons\n");
1063 fputs(fh, "// uncomment this if you added weapon pickups: has weapons\n");
1064 if(MapInfo_Map_supportedFeatures & MAPINFO_FEATURE_TURRETS)
1065 fputs(fh, "has turrets\n");
1067 fputs(fh, "// uncomment this if you added turrets: has turrets\n");
1068 if(MapInfo_Map_supportedFeatures & MAPINFO_FEATURE_VEHICLES)
1069 fputs(fh, "has vehicles\n");
1071 fputs(fh, "// uncomment this if you added vehicles: has vehicles\n");
1072 if(MapInfo_Map_flags & MAPINFO_FLAG_FRUSTRATING)
1073 fputs(fh, "frustrating\n");
1075 FOREACH(Gametypes, MapInfo_Map_supportedGametypes & it.m_flags, {
1076 fputs(fh, sprintf("gametype %s // defaults: %s\n", MapInfo_Type_ToString(it), _MapInfo_GetDefaultEx(it)));
1079 fputs(fh, "// optional: fog density red green blue alpha mindist maxdist\n");
1080 fputs(fh, "// optional: settemp_for_type (all|gametypename) cvarname value\n");
1081 fputs(fh, "// optional: clientsettemp_for_type (all|gametypename) cvarname value\n");
1082 fputs(fh, "// optional: size mins_x mins_y mins_z maxs_x maxs_y maxs_z\n");
1083 fputs(fh, "// optional: hidden\n");
1088 fh = fopen(fn, FILE_READ);
1090 error("... but I just wrote it!");
1094 LOG_WARN("autogenerated mapinfo file ", fn, " has been loaded; please edit that file and move it to maps/", pFilename, ".mapinfo");
1097 _MapInfo_Map_Reset();
1100 if (!((s = fgets(fh))))
1103 // catch different sorts of comments
1104 if(s == "") // empty lines
1106 if(substring(s, 0, 1) == "#") // UNIX style
1108 if(substring(s, 0, 2) == "//") // C++ style
1110 if(substring(s, 0, 1) == "_") // q3map style
1113 float p = strstrofs(s, "//", 0);
1115 s = substring(s, 0, p);
1117 t = car(s); s = cdr(s);
1119 MapInfo_Map_title = s;
1120 else if(t == "description")
1121 MapInfo_Map_description = s;
1122 else if(t == "author")
1123 MapInfo_Map_author = s;
1126 t = car(s); // s = cdr(s);
1127 if (t == "weapons") MapInfo_Map_supportedFeatures |= MAPINFO_FEATURE_WEAPONS;
1128 else if(t == "turrets") MapInfo_Map_supportedFeatures |= MAPINFO_FEATURE_TURRETS;
1129 else if(t == "vehicles") MapInfo_Map_supportedFeatures |= MAPINFO_FEATURE_VEHICLES;
1130 else if(t == "monsters") MapInfo_Map_supportedFeatures |= MAPINFO_FEATURE_MONSTERS;
1131 else if(t == "new_toys") MapInfo_Map_supportedFeatures |= MAPINFO_FEATURE_WEAPONS;
1133 LOG_WARN("Map ", pFilename, " supports unknown feature ", t, ", ignored");
1135 else if(t == "hidden")
1137 MapInfo_Map_flags |= MAPINFO_FLAG_HIDDEN;
1139 else if(t == "forbidden")
1141 MapInfo_Map_flags |= MAPINFO_FLAG_FORBIDDEN;
1143 else if(t == "frustrating")
1145 MapInfo_Map_flags |= MAPINFO_FLAG_FRUSTRATING;
1147 else if(t == "noautomaplist")
1149 MapInfo_Map_flags |= MAPINFO_FLAG_NOAUTOMAPLIST;
1151 else if(t == "gameversion_min")
1153 if (cvar("gameversion") < stof(s))
1154 MapInfo_Map_flags |= MAPINFO_FLAG_NOAUTOMAPLIST;
1156 else if(t == "type")
1158 t = car(s); s = cdr(s);
1159 Gametype f = MapInfo_Type_FromString(t, true, false);
1161 //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'.");
1163 _MapInfo_Map_ApplyGametype (s, pGametypeToSet, f, true);
1165 LOG_DEBUG("Map ", pFilename, " supports unknown game type ", t, ", ignored");
1167 else if(t == "gametype")
1169 t = car(s); s = cdr(s);
1170 Gametype f = MapInfo_Type_FromString(t, true, false);
1172 _MapInfo_Map_ApplyGametypeEx (s, pGametypeToSet, f);
1174 LOG_DEBUG("Map ", pFilename, " supports unknown game type ", t, ", ignored");
1176 else if(t == "size")
1178 float a, b, c, d, e;
1179 t = car(s); s = cdr(s); a = stof(t);
1180 t = car(s); s = cdr(s); b = stof(t);
1181 t = car(s); s = cdr(s); c = stof(t);
1182 t = car(s); s = cdr(s); d = stof(t);
1183 t = car(s); s = cdr(s); e = stof(t);
1187 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");
1191 t = car(s); s = cdr(s); f = stof(t);
1195 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");
1199 if(a >= d || b >= e || c >= f)
1202 LOG_WARN("Map ", pFilename, " contains an incorrect size line, mins have to be < maxs");
1206 MapInfo_Map_mins.x = a;
1207 MapInfo_Map_mins.y = b;
1208 MapInfo_Map_mins.z = c;
1209 MapInfo_Map_maxs.x = d;
1210 MapInfo_Map_maxs.y = e;
1211 MapInfo_Map_maxs.z = f;
1216 else if(t == "settemp_for_type")
1218 t = car(s); s = cdr(s);
1219 bool all = t == "all";
1221 if(all || (f = MapInfo_Type_FromString(t, true, false)))
1223 if((all ? MAPINFO_TYPE_ALL : f.m_flags) & pGametypeToSet.m_flags)
1225 _MapInfo_Parse_Settemp(pFilename, acl, 0, s, 1);
1230 LOG_DEBUG("Map ", pFilename, " has a setting for unknown game type ", t, ", ignored");
1233 else if(t == "clientsettemp_for_type")
1235 t = car(s); s = cdr(s);
1236 bool all = t == "all";
1238 if(all || (f = MapInfo_Type_FromString(t, true, false)))
1240 if((all ? MAPINFO_TYPE_ALL : f.m_flags) & pGametypeToSet.m_flags)
1242 _MapInfo_Parse_Settemp(pFilename, acl, 1, s, 1);
1247 LOG_DEBUG("Map ", pFilename, " has a client setting for unknown game type ", t, ", ignored");
1252 if (!cvar_value_issafe(s))
1255 LOG_WARN("Map ", pFilename, " contains a potentially harmful fog setting, ignored");
1258 MapInfo_Map_fog = s;
1260 else if(t == "cdtrack")
1262 t = car(s); s = cdr(s);
1263 // We do this only if pGametypeToSet even though this
1264 // content is theoretically game type independent,
1265 // because MapInfo_Map_clientstuff contains otherwise
1266 // game type dependent stuff. That way this value stays
1267 // empty when not setting a game type to not set any
1268 // false expectations.
1271 if (!cvar_value_issafe(t))
1274 LOG_WARN("Map ", pFilename, " contains a potentially harmful cdtrack, ignored");
1277 MapInfo_Map_clientstuff = strcat(
1278 MapInfo_Map_clientstuff, "cd loop \"", t, "\"\n"
1283 LOG_WARN("Map ", pFilename, " provides unknown info item ", t, ", ignored");
1285 LABEL(mapinfo_handled)
1288 if(MapInfo_Map_title == "<TITLE>")
1289 MapInfo_Map_titlestring = MapInfo_Map_bspname;
1290 else if(MapInfo_isRedundant(MapInfo_Map_bspname, MapInfo_Map_title))
1291 MapInfo_Map_titlestring = MapInfo_Map_title;
1293 MapInfo_Map_titlestring = sprintf("%s: %s", MapInfo_Map_bspname, MapInfo_Map_title);
1295 MapInfo_Cache_Store();
1296 if(MapInfo_Map_supportedGametypes != 0)
1299 LOG_WARN("Map ", pFilename, " supports no game types, ignored");
1302 int MapInfo_Get_ByName(string pFilename, float pAllowGenerate, Gametype pGametypeToSet)
1304 int r = MapInfo_Get_ByName_NoFallbacks(pFilename, pAllowGenerate, pGametypeToSet);
1306 FOREACH(Gametypes, it.m_isForcedSupported(it), _MapInfo_Map_ApplyGametypeEx("", pGametypeToSet, it));
1310 if(!(MapInfo_Map_supportedGametypes & pGametypeToSet.m_flags))
1312 error("Can't select the requested game type. This should never happen as the caller should prevent it!\n");
1313 //_MapInfo_Map_ApplyGametypeEx("", pGametypeToSet, MAPINFO_TYPE_DEATHMATCH);
1321 float MapInfo_FindName(string s)
1323 // if there is exactly one map of prefix s, return it
1324 // if not, return the null string
1325 // note that DP sorts glob results... so I can use a binary search
1329 // invariants: r is behind s, l-1 is equal or before
1332 m = floor((l + r) / 2);
1333 MapInfo_FindName_match = _MapInfo_GlobItem(MapInfo_FilterList_Lookup(m));
1334 cmp = strcasecmp(MapInfo_FindName_match, s);
1336 return m; // found and good
1338 l = m + 1; // l-1 is before s
1342 MapInfo_FindName_match = _MapInfo_GlobItem(MapInfo_FilterList_Lookup(l));
1343 MapInfo_FindName_firstResult = l;
1344 // r == l, so: l is behind s, l-1 is before
1345 // SO: if there is any, l is the one with the right prefix
1346 // and l+1 may be one too
1347 if(l == MapInfo_count)
1349 MapInfo_FindName_match = string_null;
1350 MapInfo_FindName_firstResult = -1;
1351 return -1; // no MapInfo_FindName_match, behind last item
1353 if(!startsWithNocase(MapInfo_FindName_match, s))
1355 MapInfo_FindName_match = string_null;
1356 MapInfo_FindName_firstResult = -1;
1357 return -1; // wrong prefix
1359 if(l == MapInfo_count - 1)
1360 return l; // last one, nothing can follow => unique
1361 if(startsWithNocase(_MapInfo_GlobItem(MapInfo_FilterList_Lookup(l + 1)), s))
1363 MapInfo_FindName_match = string_null;
1364 return -1; // ambigous MapInfo_FindName_match
1369 string MapInfo_FixName(string s)
1371 MapInfo_FindName(s);
1372 return MapInfo_FindName_match;
1375 int MapInfo_CurrentFeatures()
1378 // TODO: find a better way to check if weapons are required on the map
1379 if(!(cvar("g_instagib") || cvar("g_overkill") || cvar("g_nix") || cvar("g_weaponarena") || !cvar("g_pickup_items")
1380 || cvar("g_race") || cvar("g_cts") || cvar("g_nexball") || cvar("g_ca") || cvar("g_freezetag") || cvar("g_lms")))
1381 req |= MAPINFO_FEATURE_WEAPONS;
1385 Gametype MapInfo_CurrentGametype()
1387 Gametype prev = MapInfo_Type_FromString(cvar_string("gamecfg"), false, false);
1388 FOREACH(Gametypes, cvar(it.netname) && it != prev, return it);
1389 return prev ? prev : MAPINFO_TYPE_DEATHMATCH;
1392 float _MapInfo_CheckMap(string s, bool gametype_only) // returns 0 if the map can't be played with the current settings, 1 otherwise
1394 if(!MapInfo_Get_ByName(s, 1, NULL))
1396 if((MapInfo_Map_supportedGametypes & MapInfo_CurrentGametype().m_flags) == 0)
1400 if((MapInfo_Map_supportedFeatures & MapInfo_CurrentFeatures()) != MapInfo_CurrentFeatures())
1405 float MapInfo_CheckMap(string s) // returns 0 if the map can't be played with the current settings, 1 otherwise
1408 r = _MapInfo_CheckMap(s, false);
1409 MapInfo_ClearTemps();
1413 void MapInfo_SwitchGameType(Gametype t)
1415 FOREACH(Gametypes, true, cvar_set(it.netname, (it == t) ? "1" : "0"));
1418 void MapInfo_LoadMap(string s, float reinit)
1420 MapInfo_Map_supportedGametypes = 0;
1421 // we shouldn't need this, as LoadMapSettings already fixes the gametype
1422 //if(!MapInfo_CheckMap(s))
1424 // print("EMERGENCY: can't play the selected map in the given game mode. Falling back to DM.\n");
1425 // MapInfo_SwitchGameType(MAPINFO_TYPE_DEATHMATCH.m_flags);
1428 LOG_INFO("Switching to map ", s);
1430 cvar_settemp_restore();
1432 localcmd(strcat("\nmap ", s, "\n"));
1434 localcmd(strcat("\nchangelevel ", s, "\n"));
1437 string MapInfo_ListAllowedMaps(Gametype type, float pRequiredFlags, float pForbiddenFlags)
1441 // to make absolutely sure:
1442 MapInfo_Enumerate();
1443 MapInfo_FilterGametype(type, MapInfo_CurrentFeatures(), pRequiredFlags, pForbiddenFlags, 0);
1446 for(float i = 0; i < MapInfo_count; ++i)
1447 out = strcat(out, " ", _MapInfo_GlobItem(MapInfo_FilterList_Lookup(i)));
1448 return substring(out, 1, strlen(out) - 1);
1451 string MapInfo_ListAllAllowedMaps(float pRequiredFlags, float pForbiddenFlags)
1455 // to make absolutely sure:
1456 MapInfo_Enumerate();
1457 _MapInfo_FilterGametype(MAPINFO_TYPE_ALL, 0, pRequiredFlags, pForbiddenFlags, 0);
1460 for(float i = 0; i < MapInfo_count; ++i)
1461 out = strcat(out, " ", _MapInfo_GlobItem(MapInfo_FilterList_Lookup(i)));
1463 MapInfo_FilterGametype(MapInfo_CurrentGametype(), MapInfo_CurrentFeatures(), pRequiredFlags, pForbiddenFlags, 0);
1465 return substring(out, 1, strlen(out) - 1);
1468 void MapInfo_LoadMapSettings_SaveGameType(Gametype t)
1470 MapInfo_SwitchGameType(t);
1471 cvar_set("gamecfg", t.mdl);
1472 MapInfo_LoadedGametype = t;
1475 void MapInfo_LoadMapSettings(string s) // to be called from worldspawn
1477 Gametype t = MapInfo_CurrentGametype();
1478 MapInfo_LoadMapSettings_SaveGameType(t);
1480 if(!_MapInfo_CheckMap(s, true)) // with underscore, it keeps temps
1482 if(cvar("g_mapinfo_allow_unsupported_modes_and_let_stuff_break"))
1484 LOG_SEVERE("can't play the selected map in the given game mode. Working with only the override settings.");
1485 _MapInfo_Map_ApplyGametypeEx("", t, t);
1486 return; // do not call Get_ByName!
1489 if(MapInfo_Map_supportedGametypes == 0)
1491 RandomSelection_Init();
1492 FOREACH(Gametypes, it.m_priority == 2,
1494 MapInfo_Map_supportedGametypes |= it.m_flags;
1495 RandomSelection_AddEnt(it, 1, 1);
1497 if(RandomSelection_chosen_ent)
1498 t = RandomSelection_chosen_ent;
1499 LOG_SEVEREF("Mapinfo system is not functional at all. Falling back to a preferred mode (%s).", t.mdl);
1500 MapInfo_LoadMapSettings_SaveGameType(t);
1501 _MapInfo_Map_ApplyGametypeEx("", t, t);
1502 return; // do not call Get_ByName!
1506 // find the lowest bit in the supported gametypes
1507 // unnecessary now that we select one at random
1509 while(!(MapInfo_Map_supportedGametypes & 1))
1512 MapInfo_Map_supportedGametypes = floor(MapInfo_Map_supportedGametypes >> 1);
1515 RandomSelection_Init();
1516 Gametype t_prev = t;
1517 FOREACH(Gametypes, MapInfo_Map_supportedGametypes & it.m_flags,
1519 RandomSelection_AddEnt(it, 1, it.m_priority);
1521 if(RandomSelection_chosen_ent)
1522 t = RandomSelection_chosen_ent;
1524 // t is now a supported mode!
1525 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);
1526 MapInfo_LoadMapSettings_SaveGameType(t);
1528 if(!_MapInfo_CheckMap(s, false)) { // with underscore, it keeps temps
1529 LOG_WARNF("the selected map lacks features required by current settings; playing anyway.");
1531 MapInfo_Get_ByName(s, 1, t);
1534 void MapInfo_ClearTemps()
1536 MapInfo_Map_bspname = string_null;
1537 MapInfo_Map_title = string_null;
1538 MapInfo_Map_titlestring = string_null;
1539 MapInfo_Map_description = string_null;
1540 MapInfo_Map_author = string_null;
1541 MapInfo_Map_clientstuff = string_null;
1542 MapInfo_Map_supportedGametypes = 0;
1543 MapInfo_Map_supportedFeatures = 0;
1546 void MapInfo_Shutdown()
1548 MapInfo_ClearTemps();
1549 MapInfo_Filter_Free();
1550 MapInfo_Cache_Destroy();
1551 if(_MapInfo_globopen)
1553 search_end(_MapInfo_globhandle);
1554 _MapInfo_globhandle = -1;
1555 _MapInfo_globopen = false;
1559 int MapInfo_ForbiddenFlags()
1561 int f = MAPINFO_FLAG_FORBIDDEN;
1564 if (!cvar("g_maplist_allow_hidden"))
1566 f |= MAPINFO_FLAG_HIDDEN;
1568 if (!cvar("g_maplist_allow_frustrating"))
1569 f |= MAPINFO_FLAG_FRUSTRATING;
1574 int MapInfo_RequiredFlags()
1578 if(cvar("g_maplist_allow_frustrating") > 1)
1579 f |= MAPINFO_FLAG_FRUSTRATING;