2 #include "../client/defs.qh"
4 #include <common/weapons/all.qh>
9 #include <common/monsters/all.qh>
13 // generic string stuff
15 int _MapInfo_Cache_Active;
16 int _MapInfo_Cache_DB_NameToIndex;
17 int _MapInfo_Cache_Buf_IndexToMapData;
19 void MapInfo_Cache_Destroy()
21 if(!_MapInfo_Cache_Active)
24 db_close(_MapInfo_Cache_DB_NameToIndex);
25 buf_del(_MapInfo_Cache_Buf_IndexToMapData);
26 _MapInfo_Cache_Active = 0;
29 void MapInfo_Cache_Create()
31 MapInfo_Cache_Destroy();
32 _MapInfo_Cache_DB_NameToIndex = db_create();
33 _MapInfo_Cache_Buf_IndexToMapData = buf_create();
34 _MapInfo_Cache_Active = 1;
37 void MapInfo_Cache_Invalidate()
39 if(!_MapInfo_Cache_Active)
42 MapInfo_Cache_Create();
45 void MapInfo_Cache_Store()
49 if(!_MapInfo_Cache_Active)
52 s = db_get(_MapInfo_Cache_DB_NameToIndex, MapInfo_Map_bspname);
55 i = buf_getsize(_MapInfo_Cache_Buf_IndexToMapData);
56 db_put(_MapInfo_Cache_DB_NameToIndex, MapInfo_Map_bspname, ftos(i));
61 // now store all the stuff
62 bufstr_set(_MapInfo_Cache_Buf_IndexToMapData, i, MapInfo_Map_bspname);
63 bufstr_set(_MapInfo_Cache_Buf_IndexToMapData, ++i, MapInfo_Map_title);
64 bufstr_set(_MapInfo_Cache_Buf_IndexToMapData, ++i, MapInfo_Map_titlestring);
65 bufstr_set(_MapInfo_Cache_Buf_IndexToMapData, ++i, MapInfo_Map_description);
66 bufstr_set(_MapInfo_Cache_Buf_IndexToMapData, ++i, MapInfo_Map_author);
67 bufstr_set(_MapInfo_Cache_Buf_IndexToMapData, ++i, ftos(MapInfo_Map_supportedGametypes));
68 bufstr_set(_MapInfo_Cache_Buf_IndexToMapData, ++i, ftos(MapInfo_Map_supportedFeatures));
69 bufstr_set(_MapInfo_Cache_Buf_IndexToMapData, ++i, ftos(MapInfo_Map_flags));
72 float MapInfo_Cache_Retrieve(string map)
76 if(!_MapInfo_Cache_Active)
79 s = db_get(_MapInfo_Cache_DB_NameToIndex, map);
84 // now retrieve all the stuff
85 MapInfo_Map_bspname = bufstr_get(_MapInfo_Cache_Buf_IndexToMapData, i);
86 MapInfo_Map_title = bufstr_get(_MapInfo_Cache_Buf_IndexToMapData, ++i);
87 MapInfo_Map_titlestring = bufstr_get(_MapInfo_Cache_Buf_IndexToMapData, ++i);
88 MapInfo_Map_description = bufstr_get(_MapInfo_Cache_Buf_IndexToMapData, ++i);
89 MapInfo_Map_author = bufstr_get(_MapInfo_Cache_Buf_IndexToMapData, ++i);
90 MapInfo_Map_supportedGametypes = stof(bufstr_get(_MapInfo_Cache_Buf_IndexToMapData, ++i));
91 MapInfo_Map_supportedFeatures = stof(bufstr_get(_MapInfo_Cache_Buf_IndexToMapData, ++i));
92 MapInfo_Map_flags = stof(bufstr_get(_MapInfo_Cache_Buf_IndexToMapData, ++i));
97 // GLOB HANDLING (for all BSP files)
98 float _MapInfo_globopen;
99 float _MapInfo_globcount;
100 float _MapInfo_globhandle;
101 string _MapInfo_GlobItem(float i)
104 if(!_MapInfo_globopen)
106 s = search_getfilename(_MapInfo_globhandle, i);
107 return substring(s, 5, strlen(s) - 9); // without maps/ and .bsp
110 void MapInfo_Enumerate()
112 if(_MapInfo_globopen)
114 search_end(_MapInfo_globhandle);
115 _MapInfo_globopen = 0;
117 MapInfo_Cache_Invalidate();
118 _MapInfo_globhandle = search_begin("maps/*.bsp", true, true);
119 if(_MapInfo_globhandle >= 0)
121 _MapInfo_globcount = search_getsize(_MapInfo_globhandle);
122 _MapInfo_globopen = 1;
125 _MapInfo_globcount = 0;
128 // filter the info by game type mask (updates MapInfo_count)
130 float _MapInfo_filtered;
131 float _MapInfo_filtered_allocated;
132 float MapInfo_FilterList_Lookup(float i)
134 return stof(bufstr_get(_MapInfo_filtered, i));
137 void _MapInfo_FilterList_swap(float i, float j, entity pass)
140 h = bufstr_get(_MapInfo_filtered, i);
141 bufstr_set(_MapInfo_filtered, i, bufstr_get(_MapInfo_filtered, j));
142 bufstr_set(_MapInfo_filtered, j, h);
145 float _MapInfo_FilterList_cmp(float i, float j, entity pass)
148 a = _MapInfo_GlobItem(stof(bufstr_get(_MapInfo_filtered, i)));
149 b = _MapInfo_GlobItem(stof(bufstr_get(_MapInfo_filtered, j)));
150 return strcasecmp(a, b);
153 float MapInfo_FilterGametype(int pGametype, int pFeatures, int pFlagsRequired, int pFlagsForbidden, bool pAbortOnGenerate)
156 if (!_MapInfo_filtered_allocated)
158 _MapInfo_filtered_allocated = 1;
159 _MapInfo_filtered = buf_create();
162 for(i = 0, j = -1; i < _MapInfo_globcount; ++i)
164 if(MapInfo_Get_ByName(_MapInfo_GlobItem(i), 1, 0) == 2) // if we generated one... BAIL OUT and let the caller continue in the next frame.
167 LOG_TRACE("Autogenerated a .mapinfo, doing the rest later.\n");
168 MapInfo_progress = i / _MapInfo_globcount;
171 if((MapInfo_Map_supportedGametypes & pGametype) != 0)
172 if((MapInfo_Map_supportedFeatures & pFeatures) == pFeatures)
173 if((MapInfo_Map_flags & pFlagsForbidden) == 0)
174 if((MapInfo_Map_flags & pFlagsRequired) == pFlagsRequired)
175 bufstr_set(_MapInfo_filtered, ++j, ftos(i));
177 MapInfo_count = j + 1;
178 MapInfo_ClearTemps();
180 // sometimes the glob isn't sorted nicely, so fix it here...
181 heapsort(MapInfo_count, _MapInfo_FilterList_swap, _MapInfo_FilterList_cmp, NULL);
185 void MapInfo_FilterString(string sf)
187 // this function further filters _MapInfo_filtered, which is prepared by MapInfo_FilterGametype by string
191 for(i = 0, j = -1; i < MapInfo_count; ++i)
193 if (MapInfo_Get_ByID(i))
195 // prepare for keyword filter
196 if (MapInfo_Map_title && strstrofs(MapInfo_Map_title, "<TITLE>", 0) == -1)
197 title = MapInfo_Map_title;
199 title = MapInfo_Map_bspname;
201 if((strstrofs(strtolower(title), strtolower(sf), 0)) >= 0)
202 bufstr_set(_MapInfo_filtered, ++j, bufstr_get(_MapInfo_filtered, i));
205 MapInfo_count = j + 1;
206 MapInfo_ClearTemps();
208 // sometimes the glob isn't sorted nicely, so fix it here...
209 heapsort(MapInfo_count, _MapInfo_FilterList_swap, _MapInfo_FilterList_cmp, NULL);
212 void MapInfo_Filter_Free()
214 if(_MapInfo_filtered_allocated)
216 buf_del(_MapInfo_filtered);
217 _MapInfo_filtered_allocated = 0;
221 // load info about the i-th map into the MapInfo_Map_* globals
222 string MapInfo_BSPName_ByID(float i)
224 return _MapInfo_GlobItem(MapInfo_FilterList_Lookup(i));
227 string unquote(string s)
232 for(i = 0; i < l; ++i)
235 ch = substring(s, i, 1);
236 if(ch != " ") if(ch != "\"")
238 for(j = strlen(s) - i - 1; j > 0; --j)
240 ch = substring(s, i+j, 1);
241 if(ch != " ") if(ch != "\"")
242 return substring(s, i, j+1);
244 return substring(s, i, 1);
250 float MapInfo_Get_ByID(float i)
252 if(MapInfo_Get_ByName(MapInfo_BSPName_ByID(i), 0, 0))
257 string _MapInfo_Map_worldspawn_music;
259 float _MapInfo_Generate(string pFilename) // 0: failure, 1: ok ent, 2: ok bsp
269 float diameter, spawnpoints;
272 vector mapMins, mapMaxs;
275 fn = strcat("maps/", pFilename, ".ent");
276 fh = fopen(fn, FILE_READ);
280 fn = strcat("maps/", pFilename, ".bsp");
281 fh = fopen(fn, FILE_READ);
285 LOG_INFO("Analyzing ", fn, " to generate initial mapinfo\n");
288 MapInfo_Map_flags = 0;
289 MapInfo_Map_supportedGametypes = 0;
292 _MapInfo_Map_worldspawn_music = "";
298 if (!((s = fgets(fh))))
300 if(inWorldspawn == 1)
301 if(startsWith(s, "}"))
307 if(k == "classname" && v == "worldspawn")
309 else if(k == "author")
310 MapInfo_Map_author = v;
311 else if(k == "_description")
312 MapInfo_Map_description = v;
313 else if(k == "music")
314 _MapInfo_Map_worldspawn_music = v;
315 else if(k == "noise")
316 _MapInfo_Map_worldspawn_music = v;
317 else if(k == "message")
319 i = strstrofs(v, " by ", 0);
320 if(MapInfo_Map_author == "<AUTHOR>" && i >= 0)
322 MapInfo_Map_title = substring(v, 0, i);
323 MapInfo_Map_author = substring(v, i + 4, strlen(v) - (i + 4));
326 MapInfo_Map_title = v;
333 o = stov(strcat("'", v, "'"));
334 mapMins.x = min(mapMins.x, o.x);
335 mapMins.y = min(mapMins.y, o.y);
336 mapMins.z = min(mapMins.z, o.z);
337 mapMaxs.x = max(mapMaxs.x, o.x);
338 mapMaxs.y = max(mapMaxs.y, o.y);
339 mapMaxs.z = max(mapMaxs.z, o.z);
341 else if(k == "race_place")
346 else if(k == "classname")
348 if(v == "dom_controlpoint")
349 MapInfo_Map_supportedGametypes |= MAPINFO_TYPE_DOMINATION;
350 else if(v == "item_flag_team2")
351 MapInfo_Map_supportedGametypes |= MAPINFO_TYPE_CTF;
352 else if(v == "team_CTF_blueflag")
353 MapInfo_Map_supportedGametypes |= MAPINFO_TYPE_CTF;
354 else if(v == "invasion_spawnpoint")
355 MapInfo_Map_supportedGametypes |= MAPINFO_TYPE_INVASION;
356 else if(v == "target_assault_roundend")
357 MapInfo_Map_supportedGametypes |= MAPINFO_TYPE_ASSAULT;
358 else if(v == "onslaught_generator")
359 MapInfo_Map_supportedGametypes |= MAPINFO_TYPE_ONSLAUGHT;
360 else if(substring(v, 0, 8) == "nexball_" || substring(v, 0, 4) == "ball")
361 MapInfo_Map_supportedGametypes |= MAPINFO_TYPE_NEXBALL;
362 else if(v == "info_player_team1")
364 else if(v == "info_player_team2")
366 else if(v == "info_player_start")
368 else if(v == "info_player_deathmatch")
370 else if(v == "trigger_race_checkpoint")
371 MapInfo_Map_supportedGametypes |= MAPINFO_TYPE_RACE;
372 else if(v == "target_startTimer")
373 MapInfo_Map_supportedGametypes |= MAPINFO_TYPE_CTS;
374 else if(v == "weapon_nex")
376 else if(v == "weapon_railgun")
378 else if(startsWith(v, "weapon_"))
379 MapInfo_Map_supportedFeatures |= MAPINFO_FEATURE_WEAPONS;
380 else if(startsWith(v, "turret_"))
381 MapInfo_Map_supportedFeatures |= MAPINFO_FEATURE_TURRETS;
382 else if(startsWith(v, "vehicle_"))
383 MapInfo_Map_supportedFeatures |= MAPINFO_FEATURE_VEHICLES;
384 else if(startsWith(v, "monster_"))
385 MapInfo_Map_supportedFeatures |= MAPINFO_FEATURE_MONSTERS;
386 else if(v == "target_music" || v == "trigger_music")
387 _MapInfo_Map_worldspawn_music = string_null; // don't use regular BGM
393 LOG_MAPWARN(fn, " ended still in worldspawn, BUG\n");
396 diameter = vlen(mapMaxs - mapMins);
398 twoBaseModes = MapInfo_Map_supportedGametypes & (MAPINFO_TYPE_CTF | MAPINFO_TYPE_ASSAULT | MAPINFO_TYPE_RACE | MAPINFO_TYPE_NEXBALL);
399 if(twoBaseModes && (MapInfo_Map_supportedGametypes == twoBaseModes))
401 // we have a CTF-only or Assault-only map. Don't add other modes then,
402 // as the map is too symmetric for them.
406 MapInfo_Map_supportedGametypes |= MAPINFO_TYPE_DEATHMATCH; // DM always works
407 MapInfo_Map_supportedGametypes |= MAPINFO_TYPE_LMS; // LMS always works
408 MapInfo_Map_supportedGametypes |= MAPINFO_TYPE_KEEPAWAY; // Keepaway always works
410 if(spawnpoints >= 8 && diameter > 4096) {
411 MapInfo_Map_supportedGametypes |= MAPINFO_TYPE_TEAM_DEATHMATCH;
412 MapInfo_Map_supportedGametypes |= MAPINFO_TYPE_FREEZETAG;
413 MapInfo_Map_supportedGametypes |= MAPINFO_TYPE_CA;
415 if(spawnpoints >= 12 && diameter > 5120)
416 MapInfo_Map_supportedGametypes |= MAPINFO_TYPE_KEYHUNT;
419 if(MapInfo_Map_supportedGametypes & MAPINFO_TYPE_RACE)
422 MapInfo_Map_supportedGametypes &= ~MAPINFO_TYPE_RACE;
423 MapInfo_Map_supportedGametypes |= MAPINFO_TYPE_CTS;
426 LOG_TRACE("-> diameter ", ftos(diameter));
427 LOG_TRACE("; spawnpoints ", ftos(spawnpoints));
428 LOG_TRACE("; modes ", ftos(MapInfo_Map_supportedGametypes), "\n");
435 void _MapInfo_Map_Reset()
437 MapInfo_Map_title = "<TITLE>";
438 MapInfo_Map_titlestring = "<TITLE>";
439 MapInfo_Map_description = "<DESCRIPTION>";
440 MapInfo_Map_author = "<AUTHOR>";
441 MapInfo_Map_supportedGametypes = 0;
442 MapInfo_Map_supportedFeatures = 0;
443 MapInfo_Map_flags = 0;
444 MapInfo_Map_clientstuff = "";
445 MapInfo_Map_fog = "";
446 MapInfo_Map_mins = '0 0 0';
447 MapInfo_Map_maxs = '0 0 0';
450 string _MapInfo_GetDefault(float t)
454 case MAPINFO_TYPE_DEATHMATCH: return "30 20 0";
455 case MAPINFO_TYPE_TEAM_DEATHMATCH: return "50 20 2 0";
456 case MAPINFO_TYPE_DOMINATION: return "200 20 0";
457 case MAPINFO_TYPE_CTF: return "300 20 10 0";
458 case MAPINFO_TYPE_LMS: return "9 20 0";
459 case MAPINFO_TYPE_CA: return "10 20 0";
460 case MAPINFO_TYPE_KEYHUNT: return "1000 20 3 0";
461 case MAPINFO_TYPE_ASSAULT: return "20 0";
462 case MAPINFO_TYPE_RACE: return "20 5 7 15 0";
463 case MAPINFO_TYPE_ONSLAUGHT: return "20 0";
464 case MAPINFO_TYPE_NEXBALL: return "5 20 0";
465 case MAPINFO_TYPE_CTS: return "20 0 0";
466 case MAPINFO_TYPE_FREEZETAG: return "10 20 0";
467 // NOTE: DO NOT ADD ANY MORE GAME TYPES HERE
468 // THIS IS JUST LEGACY SUPPORT FOR NEXUIZ MAPS
469 // ONLY ADD NEW STUFF TO _MapInfo_GetDefaultEx
470 // THIS FUNCTION WILL EVENTUALLY BE REMOVED
475 void _MapInfo_Map_ApplyGametype(string s, int pWantedType, int pThisType, int load_default)
478 MapInfo_Map_supportedGametypes |= pThisType;
479 if(!(pThisType & pWantedType))
483 _MapInfo_Map_ApplyGametype(_MapInfo_GetDefault(pThisType), pWantedType, pThisType, false);
485 if(pWantedType == MAPINFO_TYPE_ASSAULT || pWantedType == MAPINFO_TYPE_ONSLAUGHT || pWantedType == MAPINFO_TYPE_RACE || pWantedType == MAPINFO_TYPE_CTS) // these modes don't use fraglimit
487 cvar_set("fraglimit", "0");
493 cvar_set("fraglimit", sa);
499 cvar_set("timelimit", sa);
502 if(pWantedType == MAPINFO_TYPE_TEAM_DEATHMATCH)
506 cvar_set("g_tdm_teams", sa);
510 if(pWantedType == MAPINFO_TYPE_KEYHUNT)
514 cvar_set("g_keyhunt_teams", sa);
518 if(pWantedType == MAPINFO_TYPE_CA)
522 cvar_set("g_ca_teams", sa);
526 if(pWantedType == MAPINFO_TYPE_FREEZETAG)
530 cvar_set("g_freezetag_teams", sa);
534 if(pWantedType == MAPINFO_TYPE_CTF)
538 cvar_set("fraglimit", sa);
543 if(pWantedType == MAPINFO_TYPE_KEEPAWAY)
547 cvar_set("fraglimit", sa);
552 // rc = timelimit timelimit_qualification laps laps_teamplay
553 if(pWantedType == MAPINFO_TYPE_RACE)
555 sa = car(s); if(sa == "") sa = cvar_string("timelimit");
556 cvar_set("g_race_qualifying_timelimit", sa);
561 if(cvar("g_race_teams") < 2)
562 cvar_set("fraglimit", sa);
567 if(cvar("g_race_teams") >= 2)
568 cvar_set("fraglimit", sa);
572 if(pWantedType == MAPINFO_TYPE_CTS)
576 // this is the skill of the map
577 // not parsed by anything yet
580 // cvar_set("fraglimit", sa);
585 if(pWantedType == MAPINFO_TYPE_ASSAULT || pWantedType == MAPINFO_TYPE_ONSLAUGHT || pWantedType == MAPINFO_TYPE_CTS) // these modes don't use fraglimit
587 cvar_set("leadlimit", "0");
593 cvar_set("leadlimit", sa);
598 string _MapInfo_GetDefaultEx(float t)
600 FOREACH(Gametypes, it.items == t, return it.model2);
604 float _MapInfo_GetTeamPlayBool(float t)
606 FOREACH(Gametypes, it.items == t, return it.team);
610 void _MapInfo_Map_ApplyGametypeEx(string s, int pWantedType, int pThisType)
612 MapInfo_Map_supportedGametypes |= pThisType;
613 if (!(pThisType & pWantedType))
616 // reset all the cvars to their defaults
618 cvar_set("timelimit", cvar_defstring("timelimit"));
619 cvar_set("leadlimit", cvar_defstring("leadlimit"));
620 cvar_set("fraglimit", cvar_defstring("fraglimit"));
621 FOREACH(Gametypes, true, it.m_parse_mapinfo(string_null, string_null));
623 string fraglimit_normal = string_null;
624 string fraglimit_teams = string_null;
626 for (s = strcat(_MapInfo_GetDefaultEx(pWantedType), " ", s); s != ""; s = cdr(s)) {
628 if (sa == "") continue;
629 int p = strstrofs(sa, "=", 0);
631 LOG_MAPWARNF("Invalid gametype setting in mapinfo for gametype %s: %s\n", MapInfo_Type_ToString(pWantedType), sa);
634 string k = substring(sa, 0, p);
635 string v = substring(sa, p + 1, -1);
640 cvar_set("timelimit", v);
645 cvar_set("leadlimit", v);
654 fraglimit_normal = v;
657 case "teampointlimit":
669 FOREACH(Gametypes, true, handled |= it.m_parse_mapinfo(k, v));
671 LOG_MAPWARNF("Invalid gametype setting in mapinfo for gametype %s: %s\n", MapInfo_Type_ToString(pWantedType), sa);
674 if (pWantedType == MAPINFO_TYPE_RACE && cvar("g_race_teams") >= 2)
677 cvar_set("fraglimit", fraglimit_teams);
682 cvar_set("fraglimit", fraglimit_normal);
686 Gametype MapInfo_Type(int t)
688 FOREACH(Gametypes, it.items == t, return it);
692 int MapInfo_Type_FromString(string t)
694 #define deprecate(from, to) MACRO_BEGIN { \
696 string replacement = #to; \
697 LOG_MAPWARNF("MapInfo_Type_FromString (probably %s): using deprecated name '%s'. Should use '%s'.\n", MapInfo_Map_bspname, t, replacement); \
701 deprecate(nexball, nb);
702 deprecate(freezetag, ft);
703 deprecate(keepaway, ka);
704 deprecate(invasion, inv);
705 deprecate(assault, as);
707 if (t == "all") return MAPINFO_TYPE_ALL;
708 FOREACH(Gametypes, it.mdl == t, return it.items);
713 string MapInfo_Type_Description(float t)
715 FOREACH(Gametypes, it.items == t, return it.gametype_description);
719 string MapInfo_Type_ToString(float t)
721 if(t == MAPINFO_TYPE_ALL)
723 FOREACH(Gametypes, it.items == t, return it.mdl);
727 string MapInfo_Type_ToText(float t)
729 FOREACH(Gametypes, it.items == t, return it.message);
730 /* xgettext:no-c-format */
731 return _("@!#%'n Tuba Throwing");
734 void _MapInfo_Parse_Settemp(string pFilename, string acl, float type, string s, float recurse)
738 t = car(s); s = cdr(s);
740 // limited support of "" and comments
741 // remove trailing and leading " of t
742 if(substring(t, 0, 1) == "\"")
744 if(substring(t, -1, 1) == "\"")
745 t = substring(t, 1, -2);
748 // remove leading " of s
749 if(substring(s, 0, 1) == "\"")
751 s = substring(s, 1, -1);
753 // remove trailing " of s, and all that follows (cvar description)
754 o = strstrofs(s, "\"", 0);
756 s = substring(s, 0, o);
758 // remove // comments
759 o = strstrofs(s, "//", 0);
761 s = substring(s, 0, o);
763 // remove trailing spaces
764 while(substring(s, -1, 1) == " ")
765 s = substring(s, 0, -2);
771 fh = fopen(s, FILE_READ);
773 LOG_MAPWARN("Map ", pFilename, " references not existing config file ", s, "\n");
778 if (!((s = fgets(fh))))
781 // catch different sorts of comments
782 if(s == "") // empty lines
784 if(substring(s, 0, 1) == "#") // UNIX style
786 if(substring(s, 0, 2) == "//") // C++ style
788 if(substring(s, 0, 1) == "_") // q3map style
791 if(substring(s, 0, 4) == "set ")
792 s = substring(s, 4, -1);
793 if(substring(s, 0, 5) == "seta ")
794 s = substring(s, 5, -1);
796 _MapInfo_Parse_Settemp(pFilename, acl, type, s, recurse - 1);
802 LOG_MAPWARN("Map ", pFilename, " uses too many levels of inclusion\n");
805 LOG_MAPWARN("Map ", pFilename, " contains a potentially harmful setting, ignored\n");
806 else if (!cvar_value_issafe(t))
807 LOG_MAPWARN("Map ", pFilename, " contains a potentially harmful setting, ignored\n");
808 else if (!cvar_value_issafe(s))
809 LOG_MAPWARN("Map ", pFilename, " contains a potentially harmful setting, ignored\n");
810 else if(matchacl(MAPINFO_SETTEMP_ACL_SYSTEM, t) <= 0)
811 LOG_MAPWARN("Map ", pFilename, " contains a potentially harmful setting, ignored\n");
812 else if(matchacl(acl, t) <= 0)
813 LOG_MAPWARN("Map ", pFilename, " contains a denied setting, ignored\n");
816 if(type == 0) // server set
818 LOG_TRACE("Applying temporary setting ", t, " := ", s, "\n");
819 if(cvar("g_campaign"))
820 cvar_set(t, s); // this is a wrapper and is always temporary anyway; no need to backup old values then
826 LOG_TRACE("Applying temporary client setting ", t, " := ", s, "\n");
827 MapInfo_Map_clientstuff = strcat(
828 MapInfo_Map_clientstuff, "cl_cmd settemp \"", t, "\" \"", s, "\"\n"
834 float MapInfo_isRedundant(string fn, string t)
836 // normalize file name
837 fn = strreplace("_", "-", fn);
839 // normalize visible title
840 t = strreplace(": ", "-", t);
841 t = strreplace(":", "-", t);
842 t = strreplace(" ", "-", t);
843 t = strreplace("_", "-", t);
844 t = strreplace("'", "-", t);
846 if(!strcasecmp(fn, t))
849 // we allow the visible title to have punctuation the file name does
850 // not, but not vice versa
851 t = strreplace("-", "", t);
853 if(!strcasecmp(fn, t))
859 // load info about a map by name into the MapInfo_Map_* globals
860 float MapInfo_Get_ByName_NoFallbacks(string pFilename, int pAllowGenerate, int pGametypeToSet)
869 acl = MAPINFO_SETTEMP_ACL_USER;
871 if(strstrofs(pFilename, "/", 0) >= 0)
873 LOG_MAPWARN("Invalid character in map name, ignored\n");
877 if(pGametypeToSet == 0)
878 if(MapInfo_Cache_Retrieve(pFilename))
883 MapInfo_Map_bspname = pFilename;
885 // default all generic fields so they have "good" values in case something fails
886 fn = strcat("maps/", pFilename, ".mapinfo");
887 fh = fopen(fn, FILE_READ);
890 fn = strcat("maps/autogenerated/", pFilename, ".mapinfo");
891 fh = fopen(fn, FILE_READ);
896 _MapInfo_Map_Reset();
897 r = _MapInfo_Generate(pFilename);
900 fh = fopen(fn, FILE_WRITE);
901 fputs(fh, strcat("title ", MapInfo_Map_title, "\n"));
902 fputs(fh, strcat("description ", MapInfo_Map_description, "\n"));
903 fputs(fh, strcat("author ", MapInfo_Map_author, "\n"));
904 if(_MapInfo_Map_worldspawn_music != "")
907 substring(_MapInfo_Map_worldspawn_music, strlen(_MapInfo_Map_worldspawn_music) - 4, 4) == ".wav"
909 substring(_MapInfo_Map_worldspawn_music, strlen(_MapInfo_Map_worldspawn_music) - 4, 4) == ".ogg"
911 fputs(fh, strcat("cdtrack ", substring(_MapInfo_Map_worldspawn_music, 0, strlen(_MapInfo_Map_worldspawn_music) - 4), "\n"));
913 fputs(fh, strcat("cdtrack ", _MapInfo_Map_worldspawn_music, "\n"));
917 n = tokenize_console(cvar_string("g_cdtracks_remaplist"));
918 s = strcat(" ", cvar_string("g_cdtracks_dontusebydefault"), " ");
921 i = floor(random() * n);
922 if(strstrofs(s, strcat(" ", argv(i), " "), 0) < 0)
925 fputs(fh, strcat("cdtrack ", ftos(i + 1), "\n"));
927 if(MapInfo_Map_supportedFeatures & MAPINFO_FEATURE_WEAPONS)
928 fputs(fh, "has weapons\n");
930 fputs(fh, "// uncomment this if you added weapon pickups: has weapons\n");
931 if(MapInfo_Map_supportedFeatures & MAPINFO_FEATURE_TURRETS)
932 fputs(fh, "has turrets\n");
934 fputs(fh, "// uncomment this if you added turrets: has turrets\n");
935 if(MapInfo_Map_supportedFeatures & MAPINFO_FEATURE_VEHICLES)
936 fputs(fh, "has vehicles\n");
938 fputs(fh, "// uncomment this if you added vehicles: has vehicles\n");
939 if(MapInfo_Map_flags & MAPINFO_FLAG_FRUSTRATING)
940 fputs(fh, "frustrating\n");
942 for(i = 1; i <= MapInfo_Map_supportedGametypes; i *= 2)
943 if(MapInfo_Map_supportedGametypes & i)
944 fputs(fh, sprintf("gametype %s // defaults: %s\n", MapInfo_Type_ToString(i), _MapInfo_GetDefaultEx(i)));
946 if(fexists(strcat("scripts/", pFilename, ".arena")))
947 fputs(fh, "settemp_for_type all sv_q3acompat_machineshotgunswap 1\n");
949 fputs(fh, "// optional: fog density red green blue alpha mindist maxdist\n");
950 fputs(fh, "// optional: settemp_for_type (all|gametypename) cvarname value\n");
951 fputs(fh, "// optional: clientsettemp_for_type (all|gametypename) cvarname value\n");
952 fputs(fh, "// optional: size mins_x mins_y mins_z maxs_x maxs_y maxs_z\n");
953 fputs(fh, "// optional: hidden\n");
958 fh = fopen(fn, FILE_READ);
960 error("... but I just wrote it!");
963 LOG_MAPWARN("autogenerated mapinfo file ", fn, " has been loaded; please edit that file and move it to maps/", pFilename, ".mapinfo\n");
966 _MapInfo_Map_Reset();
969 if (!((s = fgets(fh))))
972 // catch different sorts of comments
973 if(s == "") // empty lines
975 if(substring(s, 0, 1) == "#") // UNIX style
977 if(substring(s, 0, 2) == "//") // C++ style
979 if(substring(s, 0, 1) == "_") // q3map style
982 p = strstrofs(s, "//", 0);
984 s = substring(s, 0, p);
986 t = car(s); s = cdr(s);
988 MapInfo_Map_title = s;
989 else if(t == "description")
990 MapInfo_Map_description = s;
991 else if(t == "author")
992 MapInfo_Map_author = s;
995 t = car(s); // s = cdr(s);
996 if (t == "weapons") MapInfo_Map_supportedFeatures |= MAPINFO_FEATURE_WEAPONS;
997 else if(t == "turrets") MapInfo_Map_supportedFeatures |= MAPINFO_FEATURE_TURRETS;
998 else if(t == "vehicles") MapInfo_Map_supportedFeatures |= MAPINFO_FEATURE_VEHICLES;
999 else if(t == "monsters") MapInfo_Map_supportedFeatures |= MAPINFO_FEATURE_MONSTERS;
1000 else if(t == "new_toys") MapInfo_Map_supportedFeatures |= MAPINFO_FEATURE_WEAPONS;
1002 LOG_MAPWARN("Map ", pFilename, " supports unknown feature ", t, ", ignored\n");
1004 else if(t == "hidden")
1006 MapInfo_Map_flags |= MAPINFO_FLAG_HIDDEN;
1008 else if(t == "forbidden")
1010 MapInfo_Map_flags |= MAPINFO_FLAG_FORBIDDEN;
1012 else if(t == "frustrating")
1014 MapInfo_Map_flags |= MAPINFO_FLAG_FRUSTRATING;
1016 else if(t == "noautomaplist")
1018 MapInfo_Map_flags |= MAPINFO_FLAG_NOAUTOMAPLIST;
1020 else if(t == "gameversion_min")
1022 if (cvar("gameversion") < stof(s))
1023 MapInfo_Map_flags |= MAPINFO_FLAG_NOAUTOMAPLIST;
1025 else if(t == "type")
1027 t = car(s); s = cdr(s);
1028 f = MapInfo_Type_FromString(t);
1029 LOG_MAPWARN("Map ", pFilename, " contains the legacy 'type' keyword which is deprecated and will be removed in the future. Please migrate the mapinfo file to 'gametype'.\n");
1031 _MapInfo_Map_ApplyGametype (s, pGametypeToSet, f, true);
1033 LOG_MAPWARN("Map ", pFilename, " supports unknown game type ", t, ", ignored\n");
1035 else if(t == "gametype")
1037 t = car(s); s = cdr(s);
1038 f = MapInfo_Type_FromString(t);
1040 _MapInfo_Map_ApplyGametypeEx (s, pGametypeToSet, f);
1042 LOG_MAPWARN("Map ", pFilename, " supports unknown game type ", t, ", ignored\n");
1044 else if(t == "size")
1046 float a, b, c, d, e;
1047 t = car(s); s = cdr(s); a = stof(t);
1048 t = car(s); s = cdr(s); b = stof(t);
1049 t = car(s); s = cdr(s); c = stof(t);
1050 t = car(s); s = cdr(s); d = stof(t);
1051 t = car(s); s = cdr(s); e = stof(t);
1053 LOG_MAPWARN("Map ", pFilename, " contains an incorrect size line (not enough params), syntax: size mins_x mins_y mins_z maxs_x maxs_y maxs_z\n");
1056 t = car(s); s = cdr(s); f = stof(t);
1058 LOG_MAPWARN("Map ", pFilename, " contains an incorrect size line (too many params), syntax: size mins_x mins_y mins_z maxs_x maxs_y maxs_z\n");
1061 if(a >= d || b >= e || c >= f)
1062 LOG_MAPWARN("Map ", pFilename, " contains an incorrect size line, mins have to be < maxs\n");
1065 MapInfo_Map_mins.x = a;
1066 MapInfo_Map_mins.y = b;
1067 MapInfo_Map_mins.z = c;
1068 MapInfo_Map_maxs.x = d;
1069 MapInfo_Map_maxs.y = e;
1070 MapInfo_Map_maxs.z = f;
1075 else if(t == "settemp_for_type")
1077 t = car(s); s = cdr(s);
1078 if((f = MapInfo_Type_FromString(t)))
1080 if(f & pGametypeToSet)
1082 _MapInfo_Parse_Settemp(pFilename, acl, 0, s, 1);
1087 LOG_MAPWARN("Map ", pFilename, " has a setting for unknown game type ", t, ", ignored\n");
1090 else if(t == "clientsettemp_for_type")
1092 t = car(s); s = cdr(s);
1093 if((f = MapInfo_Type_FromString(t)))
1095 if(f & pGametypeToSet)
1097 _MapInfo_Parse_Settemp(pFilename, acl, 1, s, 1);
1102 LOG_MAPWARN("Map ", pFilename, " has a client setting for unknown game type ", t, ", ignored\n");
1107 if (!cvar_value_issafe(s))
1108 LOG_MAPWARN("Map ", pFilename, " contains a potentially harmful fog setting, ignored\n");
1110 MapInfo_Map_fog = s;
1112 else if(t == "cdtrack")
1114 t = car(s); s = cdr(s);
1115 // We do this only if pGametypeToSet even though this
1116 // content is theoretically game type independent,
1117 // because MapInfo_Map_clientstuff contains otherwise
1118 // game type dependent stuff. That way this value stays
1119 // empty when not setting a game type to not set any
1120 // false expectations.
1123 if (!cvar_value_issafe(t))
1124 LOG_MAPWARN("Map ", pFilename, " contains a potentially harmful cdtrack, ignored\n");
1126 MapInfo_Map_clientstuff = strcat(
1127 MapInfo_Map_clientstuff, "cd loop \"", t, "\"\n"
1132 LOG_MAPWARN("Map ", pFilename, " provides unknown info item ", t, ", ignored\n");
1136 if(MapInfo_Map_title == "<TITLE>")
1137 MapInfo_Map_titlestring = MapInfo_Map_bspname;
1138 else if(MapInfo_isRedundant(MapInfo_Map_bspname, MapInfo_Map_title))
1139 MapInfo_Map_titlestring = MapInfo_Map_title;
1141 MapInfo_Map_titlestring = sprintf("%s: %s", MapInfo_Map_bspname, MapInfo_Map_title);
1143 MapInfo_Cache_Store();
1144 if(MapInfo_Map_supportedGametypes != 0)
1146 LOG_MAPWARN("Map ", pFilename, " supports no game types, ignored\n");
1149 float MapInfo_Get_ByName(string pFilename, float pAllowGenerate, int pGametypeToSet)
1151 float r = MapInfo_Get_ByName_NoFallbacks(pFilename, pAllowGenerate, pGametypeToSet);
1153 if(cvar("g_tdm_on_dm_maps"))
1155 // if this is set, all DM maps support TDM too
1156 if (!(MapInfo_Map_supportedGametypes & MAPINFO_TYPE_TEAM_DEATHMATCH))
1157 if(MapInfo_Map_supportedGametypes & MAPINFO_TYPE_DEATHMATCH)
1158 _MapInfo_Map_ApplyGametypeEx ("", pGametypeToSet, MAPINFO_TYPE_TEAM_DEATHMATCH);
1163 if(!(MapInfo_Map_supportedGametypes & pGametypeToSet))
1165 error("Can't select the requested game type. This should never happen as the caller should prevent it!\n");
1166 //_MapInfo_Map_ApplyGametypeEx("", pGametypeToSet, MAPINFO_TYPE_DEATHMATCH);
1174 float MapInfo_FindName(string s)
1176 // if there is exactly one map of prefix s, return it
1177 // if not, return the null string
1178 // note that DP sorts glob results... so I can use a binary search
1182 // invariants: r is behind s, l-1 is equal or before
1185 m = floor((l + r) / 2);
1186 MapInfo_FindName_match = _MapInfo_GlobItem(MapInfo_FilterList_Lookup(m));
1187 cmp = strcasecmp(MapInfo_FindName_match, s);
1189 return m; // found and good
1191 l = m + 1; // l-1 is before s
1195 MapInfo_FindName_match = _MapInfo_GlobItem(MapInfo_FilterList_Lookup(l));
1196 MapInfo_FindName_firstResult = l;
1197 // r == l, so: l is behind s, l-1 is before
1198 // SO: if there is any, l is the one with the right prefix
1199 // and l+1 may be one too
1200 if(l == MapInfo_count)
1202 MapInfo_FindName_match = string_null;
1203 MapInfo_FindName_firstResult = -1;
1204 return -1; // no MapInfo_FindName_match, behind last item
1206 if(!startsWithNocase(MapInfo_FindName_match, s))
1208 MapInfo_FindName_match = string_null;
1209 MapInfo_FindName_firstResult = -1;
1210 return -1; // wrong prefix
1212 if(l == MapInfo_count - 1)
1213 return l; // last one, nothing can follow => unique
1214 if(startsWithNocase(_MapInfo_GlobItem(MapInfo_FilterList_Lookup(l + 1)), s))
1216 MapInfo_FindName_match = string_null;
1217 return -1; // ambigous MapInfo_FindName_match
1222 string MapInfo_FixName(string s)
1224 MapInfo_FindName(s);
1225 return MapInfo_FindName_match;
1228 int MapInfo_CurrentFeatures()
1231 if(!(cvar("g_lms") || cvar("g_instagib") || cvar("g_overkill") || cvar("g_nix") || cvar("g_weaponarena") || !cvar("g_pickup_items") || cvar("g_race") || cvar("g_cts") || cvar("g_nexball")))
1232 req |= MAPINFO_FEATURE_WEAPONS;
1236 int MapInfo_CurrentGametype()
1238 int prev = cvar("gamecfg");
1239 FOREACH(Gametypes, cvar(it.netname) && it.items != prev, return it.items);
1240 if (prev) return prev;
1241 return MAPINFO_TYPE_DEATHMATCH;
1244 float _MapInfo_CheckMap(string s) // returns 0 if the map can't be played with the current settings, 1 otherwise
1246 if(!MapInfo_Get_ByName(s, 1, 0))
1248 if((MapInfo_Map_supportedGametypes & MapInfo_CurrentGametype()) == 0)
1250 if((MapInfo_Map_supportedFeatures & MapInfo_CurrentFeatures()) != MapInfo_CurrentFeatures())
1255 float MapInfo_CheckMap(string s) // returns 0 if the map can't be played with the current settings, 1 otherwise
1258 r = _MapInfo_CheckMap(s);
1259 MapInfo_ClearTemps();
1263 void MapInfo_SwitchGameType(int t)
1265 FOREACH(Gametypes, true, cvar_set(it.netname, (it.items == t) ? "1" : "0"));
1268 void MapInfo_LoadMap(string s, float reinit)
1270 MapInfo_Map_supportedGametypes = 0;
1271 // we shouldn't need this, as LoadMapSettings already fixes the gametype
1272 //if(!MapInfo_CheckMap(s))
1274 // print("EMERGENCY: can't play the selected map in the given game mode. Falling back to DM.\n");
1275 // MapInfo_SwitchGameType(MAPINFO_TYPE_DEATHMATCH);
1278 cvar_settemp_restore();
1280 localcmd(strcat("\nmap ", s, "\n"));
1282 localcmd(strcat("\nchangelevel ", s, "\n"));
1285 string MapInfo_ListAllowedMaps(float type, float pRequiredFlags, float pForbiddenFlags)
1290 // to make absolutely sure:
1291 MapInfo_Enumerate();
1292 MapInfo_FilterGametype(type, MapInfo_CurrentFeatures(), pRequiredFlags, pForbiddenFlags, 0);
1295 for(i = 0; i < MapInfo_count; ++i)
1296 out = strcat(out, " ", _MapInfo_GlobItem(MapInfo_FilterList_Lookup(i)));
1297 return substring(out, 1, strlen(out) - 1);
1300 string MapInfo_ListAllAllowedMaps(float pRequiredFlags, float pForbiddenFlags)
1305 // to make absolutely sure:
1306 MapInfo_Enumerate();
1307 MapInfo_FilterGametype(MAPINFO_TYPE_ALL, 0, pRequiredFlags, pForbiddenFlags, 0);
1310 for(i = 0; i < MapInfo_count; ++i)
1311 out = strcat(out, " ", _MapInfo_GlobItem(MapInfo_FilterList_Lookup(i)));
1313 MapInfo_FilterGametype(MapInfo_CurrentGametype(), MapInfo_CurrentFeatures(), pRequiredFlags, pForbiddenFlags, 0);
1315 return substring(out, 1, strlen(out) - 1);
1318 void MapInfo_LoadMapSettings_SaveGameType(float t)
1320 MapInfo_SwitchGameType(t);
1321 cvar_set("gamecfg", ftos(t));
1322 MapInfo_LoadedGametype = t;
1325 void MapInfo_LoadMapSettings(string s) // to be called from worldspawn
1329 t = MapInfo_CurrentGametype();
1330 MapInfo_LoadMapSettings_SaveGameType(t);
1332 if(!_MapInfo_CheckMap(s)) // with underscore, it keeps temps
1334 if(cvar("g_mapinfo_allow_unsupported_modes_and_let_stuff_break"))
1336 LOG_SEVERE("can't play the selected map in the given game mode. Working with only the override settings.\n");
1337 _MapInfo_Map_ApplyGametypeEx("", t, t);
1338 return; // do not call Get_ByName!
1341 if(MapInfo_Map_supportedGametypes == 0)
1343 LOG_SEVERE("Mapinfo system is not functional at all. Assuming deathmatch.\n");
1344 MapInfo_Map_supportedGametypes = MAPINFO_TYPE_DEATHMATCH;
1345 MapInfo_LoadMapSettings_SaveGameType(MAPINFO_TYPE_DEATHMATCH);
1346 _MapInfo_Map_ApplyGametypeEx("", MAPINFO_TYPE_DEATHMATCH, MAPINFO_TYPE_DEATHMATCH);
1347 return; // do not call Get_ByName!
1351 while(!(MapInfo_Map_supportedGametypes & 1))
1354 MapInfo_Map_supportedGametypes = floor(MapInfo_Map_supportedGametypes / 2);
1357 // t is now a supported mode!
1358 LOG_WARNING("can't play the selected map in the given game mode. Falling back to a supported mode.\n");
1359 MapInfo_LoadMapSettings_SaveGameType(t);
1361 MapInfo_Get_ByName(s, 1, t);
1364 void MapInfo_ClearTemps()
1366 MapInfo_Map_bspname = string_null;
1367 MapInfo_Map_title = string_null;
1368 MapInfo_Map_titlestring = string_null;
1369 MapInfo_Map_description = string_null;
1370 MapInfo_Map_author = string_null;
1371 MapInfo_Map_clientstuff = string_null;
1372 MapInfo_Map_supportedGametypes = 0;
1373 MapInfo_Map_supportedFeatures = 0;
1376 void MapInfo_Shutdown()
1378 MapInfo_ClearTemps();
1379 MapInfo_Filter_Free();
1380 MapInfo_Cache_Destroy();
1381 if(_MapInfo_globopen)
1383 search_end(_MapInfo_globhandle);
1384 _MapInfo_globhandle = -1;
1385 _MapInfo_globopen = false;
1389 int MapInfo_ForbiddenFlags()
1391 int f = MAPINFO_FLAG_FORBIDDEN;
1394 if (!cvar("g_maplist_allow_hidden"))
1396 f |= MAPINFO_FLAG_HIDDEN;
1398 if (!cvar("g_maplist_allow_frustrating"))
1399 f |= MAPINFO_FLAG_FRUSTRATING;
1404 int MapInfo_RequiredFlags()
1408 if(cvar("g_maplist_allow_frustrating") > 1)
1409 f |= MAPINFO_FLAG_FRUSTRATING;