1 // generic string stuff
3 float _MapInfo_Cache_Active;
4 float _MapInfo_Cache_DB_NameToIndex;
5 float _MapInfo_Cache_Buf_IndexToMapData;
7 void MapInfo_Cache_Destroy()
9 if(!_MapInfo_Cache_Active)
12 db_close(_MapInfo_Cache_DB_NameToIndex);
13 buf_del(_MapInfo_Cache_Buf_IndexToMapData);
14 _MapInfo_Cache_Active = 0;
17 void MapInfo_Cache_Create()
19 MapInfo_Cache_Destroy();
20 _MapInfo_Cache_DB_NameToIndex = db_create();
21 _MapInfo_Cache_Buf_IndexToMapData = buf_create();
22 _MapInfo_Cache_Active = 1;
25 void MapInfo_Cache_Invalidate()
27 if(!_MapInfo_Cache_Active)
30 MapInfo_Cache_Create();
33 void MapInfo_Cache_Store()
37 if(!_MapInfo_Cache_Active)
40 s = db_get(_MapInfo_Cache_DB_NameToIndex, MapInfo_Map_bspname);
43 i = buf_getsize(_MapInfo_Cache_Buf_IndexToMapData);
44 db_put(_MapInfo_Cache_DB_NameToIndex, MapInfo_Map_bspname, ftos(i));
49 // now store all the stuff
50 bufstr_set(_MapInfo_Cache_Buf_IndexToMapData, i, MapInfo_Map_bspname);
51 bufstr_set(_MapInfo_Cache_Buf_IndexToMapData, ++i, MapInfo_Map_title);
52 bufstr_set(_MapInfo_Cache_Buf_IndexToMapData, ++i, MapInfo_Map_titlestring);
53 bufstr_set(_MapInfo_Cache_Buf_IndexToMapData, ++i, MapInfo_Map_description);
54 bufstr_set(_MapInfo_Cache_Buf_IndexToMapData, ++i, MapInfo_Map_author);
55 bufstr_set(_MapInfo_Cache_Buf_IndexToMapData, ++i, ftos(MapInfo_Map_supportedGametypes));
56 bufstr_set(_MapInfo_Cache_Buf_IndexToMapData, ++i, ftos(MapInfo_Map_supportedFeatures));
57 bufstr_set(_MapInfo_Cache_Buf_IndexToMapData, ++i, ftos(MapInfo_Map_flags));
60 float MapInfo_Cache_Retrieve(string map)
64 if(!_MapInfo_Cache_Active)
67 s = db_get(_MapInfo_Cache_DB_NameToIndex, map);
72 // now retrieve all the stuff
73 MapInfo_Map_bspname = bufstr_get(_MapInfo_Cache_Buf_IndexToMapData, i);
74 MapInfo_Map_title = bufstr_get(_MapInfo_Cache_Buf_IndexToMapData, ++i);
75 MapInfo_Map_titlestring = bufstr_get(_MapInfo_Cache_Buf_IndexToMapData, ++i);
76 MapInfo_Map_description = bufstr_get(_MapInfo_Cache_Buf_IndexToMapData, ++i);
77 MapInfo_Map_author = bufstr_get(_MapInfo_Cache_Buf_IndexToMapData, ++i);
78 MapInfo_Map_supportedGametypes = stof(bufstr_get(_MapInfo_Cache_Buf_IndexToMapData, ++i));
79 MapInfo_Map_supportedFeatures = stof(bufstr_get(_MapInfo_Cache_Buf_IndexToMapData, ++i));
80 MapInfo_Map_flags = stof(bufstr_get(_MapInfo_Cache_Buf_IndexToMapData, ++i));
85 // GLOB HANDLING (for all BSP files)
86 float _MapInfo_globopen;
87 float _MapInfo_globcount;
88 float _MapInfo_globhandle;
89 string _MapInfo_GlobItem(float i)
92 if(!_MapInfo_globopen)
94 s = search_getfilename(_MapInfo_globhandle, i);
95 return substring(s, 5, strlen(s) - 9); // without maps/ and .bsp
98 void MapInfo_Enumerate()
100 if(_MapInfo_globopen)
102 search_end(_MapInfo_globhandle);
103 _MapInfo_globopen = 0;
105 MapInfo_Cache_Invalidate();
106 _MapInfo_globhandle = search_begin("maps/*.bsp", TRUE, TRUE);
107 if(_MapInfo_globhandle >= 0)
109 _MapInfo_globcount = search_getsize(_MapInfo_globhandle);
110 _MapInfo_globopen = 1;
113 _MapInfo_globcount = 0;
116 // filter the info by game type mask (updates MapInfo_count)
118 float _MapInfo_filtered;
119 float _MapInfo_filtered_allocated;
120 float MapInfo_FilterList_Lookup(float i)
122 return stof(bufstr_get(_MapInfo_filtered, i));
125 void _MapInfo_FilterList_swap(float i, float j, entity pass)
128 h = bufstr_get(_MapInfo_filtered, i);
129 bufstr_set(_MapInfo_filtered, i, bufstr_get(_MapInfo_filtered, j));
130 bufstr_set(_MapInfo_filtered, j, h);
133 float _MapInfo_FilterList_cmp(float i, float j, entity pass)
136 a = _MapInfo_GlobItem(stof(bufstr_get(_MapInfo_filtered, i)));
137 b = _MapInfo_GlobItem(stof(bufstr_get(_MapInfo_filtered, j)));
138 return strcasecmp(a, b);
141 float MapInfo_FilterGametype(float pGametype, float pFeatures, float pFlagsRequired, float pFlagsForbidden, float pAbortOnGenerate)
144 if not(_MapInfo_filtered_allocated)
146 _MapInfo_filtered_allocated = 1;
147 _MapInfo_filtered = buf_create();
150 for(i = 0, j = -1; i < _MapInfo_globcount; ++i)
152 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.
155 dprint("Autogenerated a .mapinfo, doing the rest later.\n");
156 MapInfo_progress = i / _MapInfo_globcount;
159 if((MapInfo_Map_supportedGametypes & pGametype) != 0)
160 if((MapInfo_Map_supportedFeatures & pFeatures) == pFeatures)
161 if((MapInfo_Map_flags & pFlagsForbidden) == 0)
162 if((MapInfo_Map_flags & pFlagsRequired) == pFlagsRequired)
163 bufstr_set(_MapInfo_filtered, ++j, ftos(i));
165 MapInfo_count = j + 1;
166 MapInfo_ClearTemps();
168 // sometimes the glob isn't sorted nicely, so fix it here...
169 heapsort(MapInfo_count, _MapInfo_FilterList_swap, _MapInfo_FilterList_cmp, world);
174 void MapInfo_Filter_Free()
176 if(_MapInfo_filtered_allocated)
178 buf_del(_MapInfo_filtered);
179 _MapInfo_filtered_allocated = 0;
183 // load info about the i-th map into the MapInfo_Map_* globals
184 string MapInfo_BSPName_ByID(float i)
186 return _MapInfo_GlobItem(MapInfo_FilterList_Lookup(i));
189 string unquote(string s)
194 for(i = 0; i < l; ++i)
197 ch = substring(s, i, 1);
198 if(ch != " ") if(ch != "\"")
200 for(j = strlen(s) - i - 1; j > 0; --j)
202 ch = substring(s, i+j, 1);
203 if(ch != " ") if(ch != "\"")
204 return substring(s, i, j+1);
206 return substring(s, i, 1);
212 float MapInfo_Get_ByID(float i)
214 if(MapInfo_Get_ByName(MapInfo_BSPName_ByID(i), 0, 0))
219 string _MapInfo_Map_worldspawn_music;
221 float _MapInfo_Generate(string pFilename) // 0: failure, 1: ok ent, 2: ok bsp
231 float diameter, spawnpoints;
234 vector mapMins, mapMaxs;
237 fn = strcat("maps/", pFilename, ".ent");
238 fh = fopen(fn, FILE_READ);
242 fn = strcat("maps/", pFilename, ".bsp");
243 fh = fopen(fn, FILE_READ);
247 print("Analyzing ", fn, " to generate initial mapinfo\n");
250 MapInfo_Map_flags = 0;
251 MapInfo_Map_supportedGametypes = 0;
254 _MapInfo_Map_worldspawn_music = "";
260 if not((s = fgets(fh)))
262 if(inWorldspawn == 1)
263 if(startsWith(s, "}"))
269 if(k == "classname" && v == "worldspawn")
271 else if(k == "author")
272 MapInfo_Map_author = v;
273 else if(k == "_description")
274 MapInfo_Map_description = v;
275 else if(k == "music")
276 _MapInfo_Map_worldspawn_music = v;
277 else if(k == "noise")
278 _MapInfo_Map_worldspawn_music = v;
279 else if(k == "message")
281 i = strstrofs(v, " by ", 0);
282 if(MapInfo_Map_author == "<AUTHOR>" && i >= 0)
284 MapInfo_Map_title = substring(v, 0, i);
285 MapInfo_Map_author = substring(v, i + 4, strlen(v) - (i + 4));
288 MapInfo_Map_title = v;
295 o = stov(strcat("'", v, "'"));
296 mapMins_x = min(mapMins_x, o_x);
297 mapMins_y = min(mapMins_y, o_y);
298 mapMins_z = min(mapMins_z, o_z);
299 mapMaxs_x = max(mapMaxs_x, o_x);
300 mapMaxs_y = max(mapMaxs_y, o_y);
301 mapMaxs_z = max(mapMaxs_z, o_z);
303 else if(k == "race_place")
308 else if(k == "classname")
310 if(v == "dom_controlpoint")
311 MapInfo_Map_supportedGametypes |= MAPINFO_TYPE_DOMINATION;
312 else if(v == "item_flag_team2")
313 MapInfo_Map_supportedGametypes |= MAPINFO_TYPE_CTF;
314 else if(v == "team_CTF_blueflag")
315 MapInfo_Map_supportedGametypes |= MAPINFO_TYPE_CTF;
316 else if(v == "runematch_spawn_point")
317 MapInfo_Map_supportedGametypes |= MAPINFO_TYPE_RUNEMATCH;
318 else if(v == "target_assault_roundend")
319 MapInfo_Map_supportedGametypes |= MAPINFO_TYPE_ASSAULT;
320 else if(v == "onslaught_generator")
321 MapInfo_Map_supportedGametypes |= MAPINFO_TYPE_ONSLAUGHT;
322 else if(substring(v, 0, 8) == "nexball_" || substring(v, 0, 4) == "ball")
323 MapInfo_Map_supportedGametypes |= MAPINFO_TYPE_NEXBALL;
324 else if(v == "info_player_team1")
326 else if(v == "info_player_team2")
328 else if(v == "info_player_start")
330 else if(v == "info_player_deathmatch")
332 else if(v == "trigger_race_checkpoint")
333 MapInfo_Map_supportedGametypes |= MAPINFO_TYPE_RACE;
334 else if(v == "target_startTimer")
335 MapInfo_Map_supportedGametypes |= MAPINFO_TYPE_CTS;
336 else if(v == "weapon_nex")
338 else if(v == "weapon_railgun")
340 else if(startsWith(v, "weapon_"))
341 MapInfo_Map_supportedFeatures |= MAPINFO_FEATURE_WEAPONS;
342 else if(startsWith(v, "turret_"))
343 MapInfo_Map_supportedFeatures |= MAPINFO_FEATURE_TURRETS;
344 else if(startsWith(v, "vehicle_"))
345 MapInfo_Map_supportedFeatures |= MAPINFO_FEATURE_VEHICLES;
346 else if(v == "target_music" || v == "trigger_music")
347 _MapInfo_Map_worldspawn_music = string_null; // don't use regular BGM
353 print(fn, " ended still in worldspawn, BUG\n");
356 diameter = vlen(mapMaxs - mapMins);
358 twoBaseModes = MapInfo_Map_supportedGametypes & (MAPINFO_TYPE_CTF | MAPINFO_TYPE_ASSAULT | MAPINFO_TYPE_RACE | MAPINFO_TYPE_NEXBALL);
359 if(twoBaseModes && (MapInfo_Map_supportedGametypes == twoBaseModes))
361 // we have a CTF-only or Assault-only map. Don't add other modes then,
362 // as the map is too symmetric for them.
366 MapInfo_Map_supportedGametypes |= MAPINFO_TYPE_DEATHMATCH; // DM always works
367 MapInfo_Map_supportedGametypes |= MAPINFO_TYPE_RUNEMATCH; // Rune always works
368 MapInfo_Map_supportedGametypes |= MAPINFO_TYPE_LMS; // LMS always works
369 MapInfo_Map_supportedGametypes |= MAPINFO_TYPE_KEEPAWAY; // Keepaway always works
371 if(spawnpoints >= 8 && diameter > 4096) {
372 MapInfo_Map_supportedGametypes |= MAPINFO_TYPE_TEAM_DEATHMATCH;
373 MapInfo_Map_supportedGametypes |= MAPINFO_TYPE_FREEZETAG;
374 MapInfo_Map_supportedGametypes |= MAPINFO_TYPE_CA;
377 MapInfo_Map_supportedGametypes |= MAPINFO_TYPE_ARENA;
378 if(spawnpoints >= 12 && diameter > 5120)
379 MapInfo_Map_supportedGametypes |= MAPINFO_TYPE_KEYHUNT;
382 if(MapInfo_Map_supportedGametypes & MAPINFO_TYPE_RACE)
385 MapInfo_Map_supportedGametypes &~= MAPINFO_TYPE_RACE;
386 MapInfo_Map_supportedGametypes |= MAPINFO_TYPE_CTS;
389 dprint("-> diameter ", ftos(diameter));
390 dprint("; spawnpoints ", ftos(spawnpoints));
391 dprint("; modes ", ftos(MapInfo_Map_supportedGametypes), "\n");
398 void _MapInfo_Map_Reset()
400 MapInfo_Map_title = "<TITLE>";
401 MapInfo_Map_titlestring = "<TITLE>";
402 MapInfo_Map_description = "<DESCRIPTION>";
403 MapInfo_Map_author = "<AUTHOR>";
404 MapInfo_Map_supportedGametypes = 0;
405 MapInfo_Map_supportedFeatures = 0;
406 MapInfo_Map_flags = 0;
407 MapInfo_Map_clientstuff = "";
408 MapInfo_Map_fog = "";
409 MapInfo_Map_mins = '0 0 0';
410 MapInfo_Map_maxs = '0 0 0';
413 string _MapInfo_GetDefault(float t)
417 case MAPINFO_TYPE_DEATHMATCH: return "30 20 0";
418 case MAPINFO_TYPE_TEAM_DEATHMATCH: return "50 20 2 0";
419 case MAPINFO_TYPE_DOMINATION: return "200 20 0";
420 case MAPINFO_TYPE_CTF: return "300 20 10 0";
421 case MAPINFO_TYPE_RUNEMATCH: return "200 20 0";
422 case MAPINFO_TYPE_LMS: return "9 20 0";
423 case MAPINFO_TYPE_ARENA: return "10 20 0";
424 case MAPINFO_TYPE_CA: return "10 20 0";
425 case MAPINFO_TYPE_KEYHUNT: return "1000 20 3 0";
426 case MAPINFO_TYPE_ASSAULT: return "20 0";
427 case MAPINFO_TYPE_RACE: return "20 5 7 15 0";
428 case MAPINFO_TYPE_ONSLAUGHT: return "20 0";
429 case MAPINFO_TYPE_NEXBALL: return "5 20 0";
430 case MAPINFO_TYPE_CTS: return "20 0 0";
431 case MAPINFO_TYPE_FREEZETAG: return "10 20 0";
432 // NOTE: DO NOT ADD ANY MORE GAME TYPES HERE
433 // THIS IS JUST LEGACY SUPPORT FOR NEXUIZ MAPS
434 // ONLY ADD NEW STUFF TO _MapInfo_GetDefaultEx
435 // THIS FUNCTION WILL EVENTUALLY BE REMOVED
440 void _MapInfo_Map_ApplyGametype(string s, float pWantedType, float pThisType, float load_default)
443 MapInfo_Map_supportedGametypes |= pThisType;
444 if(!(pThisType & pWantedType))
448 _MapInfo_Map_ApplyGametype(_MapInfo_GetDefault(pThisType), pWantedType, pThisType, FALSE);
450 if(pWantedType == MAPINFO_TYPE_ASSAULT || pWantedType == MAPINFO_TYPE_ONSLAUGHT || pWantedType == MAPINFO_TYPE_RACE || pWantedType == MAPINFO_TYPE_CTS) // these modes don't use fraglimit
452 cvar_set("fraglimit", "0");
458 cvar_set("fraglimit", sa);
464 cvar_set("timelimit", sa);
467 if(pWantedType == MAPINFO_TYPE_TEAM_DEATHMATCH)
471 cvar_set("g_tdm_teams", sa);
475 if(pWantedType == MAPINFO_TYPE_KEYHUNT)
479 cvar_set("g_keyhunt_teams", sa);
483 if(pWantedType == MAPINFO_TYPE_CA)
487 cvar_set("g_ca_teams", sa);
491 if(pWantedType == MAPINFO_TYPE_FREEZETAG)
495 cvar_set("g_freezetag_teams", sa);
499 if(pWantedType == MAPINFO_TYPE_CTF)
503 cvar_set("fraglimit", sa);
508 if(pWantedType == MAPINFO_TYPE_KEEPAWAY)
512 cvar_set("fraglimit", sa);
517 // rc = timelimit timelimit_qualification laps laps_teamplay
518 if(pWantedType == MAPINFO_TYPE_RACE)
520 sa = car(s); if(sa == "") sa = cvar_string("timelimit");
521 cvar_set("g_race_qualifying_timelimit", sa);
526 if(cvar("g_race_teams") < 2)
527 cvar_set("fraglimit", sa);
532 if(cvar("g_race_teams") >= 2)
533 cvar_set("fraglimit", sa);
537 if(pWantedType == MAPINFO_TYPE_CTS)
541 // this is the skill of the map
542 // not parsed by anything yet
545 // cvar_set("fraglimit", sa);
550 if(pWantedType == MAPINFO_TYPE_ASSAULT || pWantedType == MAPINFO_TYPE_ONSLAUGHT || pWantedType == MAPINFO_TYPE_CTS) // these modes don't use fraglimit
552 cvar_set("leadlimit", "0");
558 cvar_set("leadlimit", sa);
563 string _MapInfo_GetDefaultEx(float t)
566 for(e = MapInfo_Type_first; e; e = e.enemy)
572 void _MapInfo_Map_ApplyGametypeEx(string s, float pWantedType, float pThisType)
576 string fraglimit_normal;
577 string fraglimit_teams;
579 MapInfo_Map_supportedGametypes |= pThisType;
580 if(!(pThisType & pWantedType))
583 // reset all the cvars to their defaults
585 cvar_set("timelimit", cvar_defstring("timelimit"));
586 cvar_set("leadlimit", cvar_defstring("leadlimit"));
587 cvar_set("fraglimit", cvar_defstring("fraglimit"));
588 cvar_set("g_tdm_teams", cvar_defstring("g_tdm_teams"));
589 cvar_set("g_ca_teams", cvar_defstring("g_ca_teams"));
590 cvar_set("g_freezetag_teams", cvar_defstring("g_freezetag_teams"));
591 cvar_set("g_keyhunt_teams", cvar_defstring("g_keyhunt_teams"));
592 cvar_set("g_domination_default_teams", cvar_defstring("g_domination_default_teams"));
593 cvar_set("g_race_qualifying_timelimit", cvar_defstring("g_race_qualifying_timelimit"));
595 fraglimit_normal = string_null;
596 fraglimit_teams = string_null;
598 s = strcat(_MapInfo_GetDefaultEx(pWantedType), " ", s);
607 p = strstrofs(sa, "=", 0);
615 k = substring(sa, 0, p);
616 v = substring(sa, p+1, -1);
621 cvar_set("timelimit", v);
623 else if(k == "leadlimit")
625 cvar_set("leadlimit", v);
627 else if(k == "pointlimit" || k == "fraglimit" || k == "lives" || k == "laplimit" || k == "caplimit")
629 fraglimit_normal = v;
631 else if(k == "teampointlimit" || k == "teamlaplimit")
635 else if(k == "teams")
637 cvar_set("g_tdm_teams", v);
638 cvar_set("g_ca_teams", v);
639 cvar_set("g_freezetag_teams", v);
640 cvar_set("g_keyhunt_teams", v);
641 cvar_set("g_domination_default_teams", v);
643 else if(k == "qualifying_timelimit")
645 cvar_set("g_race_qualifying_timelimit", v);
647 else if(k == "skill")
653 print("Invalid gametype key in mapinfo: ", k, "\n");
657 if(pWantedType == MAPINFO_TYPE_RACE && cvar("g_race_teams") >= 2)
660 cvar_set("fraglimit", fraglimit_teams);
665 cvar_set("fraglimit", fraglimit_normal);
669 float MapInfo_Type_FromString(string t)
674 print("MapInfo_Type_FromString (probably ", MapInfo_Map_bspname, "): using deprecated name '", t);
676 print("'. Should use '", t, "'.\n");
680 print("MapInfo_Type_FromString (probably ", MapInfo_Map_bspname, "): using deprecated name '", t);
682 print("'. Should use '", t, "'.\n");
686 print("MapInfo_Type_FromString (probably ", MapInfo_Map_bspname, "): using deprecated name '", t);
688 print("'. Should use '", t, "'.\n");
691 return MAPINFO_TYPE_ALL;
692 for(e = MapInfo_Type_first; e; e = e.enemy)
698 string MapInfo_Type_ToString(float t)
701 if(t == MAPINFO_TYPE_ALL)
703 for(e = MapInfo_Type_first; e; e = e.enemy)
709 string MapInfo_Type_ToText(float t)
712 for(e = MapInfo_Type_first; e; e = e.enemy)
715 return _("@!#%'n Tuba Throwing");
718 void _MapInfo_Parse_Settemp(string pFilename, string acl, float type, string s, float recurse)
722 t = car(s); s = cdr(s);
724 // limited support of "" and comments
725 // remove trailing and leading " of t
726 if(substring(t, 0, 1) == "\"")
728 if(substring(t, -1, 1) == "\"")
729 t = substring(t, 1, -2);
732 // remove leading " of s
733 if(substring(s, 0, 1) == "\"")
735 s = substring(s, 1, -1);
737 // remove trailing " of s, and all that follows (cvar description)
738 o = strstrofs(s, "\"", 0);
740 s = substring(s, 0, o);
742 // remove // comments
743 o = strstrofs(s, "//", 0);
745 s = substring(s, 0, o);
747 // remove trailing spaces
748 while(substring(s, -1, 1) == " ")
749 s = substring(s, 0, -2);
755 fh = fopen(s, FILE_READ);
757 print("Map ", pFilename, " references not existing config file ", s, "\n");
762 if not((s = fgets(fh)))
765 // catch different sorts of comments
766 if(s == "") // empty lines
768 if(substring(s, 0, 1) == "#") // UNIX style
770 if(substring(s, 0, 2) == "//") // C++ style
772 if(substring(s, 0, 1) == "_") // q3map style
775 if(substring(s, 0, 4) == "set ")
776 s = substring(s, 4, -1);
777 if(substring(s, 0, 5) == "seta ")
778 s = substring(s, 5, -1);
780 _MapInfo_Parse_Settemp(pFilename, acl, type, s, recurse - 1);
786 print("Map ", pFilename, " uses too many levels of inclusion\n");
789 print("Map ", pFilename, " contains a potentially harmful setting, ignored\n");
790 else if not(cvar_value_issafe(t))
791 print("Map ", pFilename, " contains a potentially harmful setting, ignored\n");
792 else if not (cvar_value_issafe(s))
793 print("Map ", pFilename, " contains a potentially harmful setting, ignored\n");
794 else if(matchacl(MAPINFO_SETTEMP_ACL_SYSTEM, t) <= 0)
795 print("Map ", pFilename, " contains a potentially harmful setting, ignored\n");
796 else if(matchacl(acl, t) <= 0)
797 print("Map ", pFilename, " contains a denied setting, ignored\n");
800 if(type == 0) // server set
802 dprint("Applying temporary setting ", t, " := ", s, "\n");
803 if(cvar("g_campaign"))
804 cvar_set(t, s); // this is a wrapper and is always temporary anyway; no need to backup old values then
810 dprint("Applying temporary client setting ", t, " := ", s, "\n");
811 MapInfo_Map_clientstuff = strcat(
812 MapInfo_Map_clientstuff, "cl_cmd settemp \"", t, "\" \"", s, "\"\n"
818 float MapInfo_isRedundant(string fn, string t)
820 // normalize file name
821 fn = strreplace("_", "-", fn);
823 // normalize visible title
824 t = strreplace(": ", "-", t);
825 t = strreplace(":", "-", t);
826 t = strreplace(" ", "-", t);
827 t = strreplace("_", "-", t);
828 t = strreplace("'", "-", t);
830 if(!strcasecmp(fn, t))
833 // we allow the visible title to have punctuation the file name does
834 // not, but not vice versa
835 t = strreplace("-", "", t);
837 if(!strcasecmp(fn, t))
843 // load info about a map by name into the MapInfo_Map_* globals
844 float MapInfo_Get_ByName_NoFallbacks(string pFilename, float pAllowGenerate, float pGametypeToSet)
852 acl = MAPINFO_SETTEMP_ACL_USER;
854 if(strstrofs(pFilename, "/", 0) >= 0)
856 print("Invalid character in map name, ignored\n");
860 if(pGametypeToSet == 0)
861 if(MapInfo_Cache_Retrieve(pFilename))
866 MapInfo_Map_bspname = pFilename;
868 // default all generic fields so they have "good" values in case something fails
869 fn = strcat("maps/", pFilename, ".mapinfo");
870 fh = fopen(fn, FILE_READ);
873 fn = strcat("maps/autogenerated/", pFilename, ".mapinfo");
874 fh = fopen(fn, FILE_READ);
879 _MapInfo_Map_Reset();
880 r = _MapInfo_Generate(pFilename);
883 fh = fopen(fn, FILE_WRITE);
884 fputs(fh, strcat("title ", MapInfo_Map_title, "\n"));
885 fputs(fh, strcat("description ", MapInfo_Map_description, "\n"));
886 fputs(fh, strcat("author ", MapInfo_Map_author, "\n"));
887 if(_MapInfo_Map_worldspawn_music != "")
890 substring(_MapInfo_Map_worldspawn_music, strlen(_MapInfo_Map_worldspawn_music) - 4, 4) == ".wav"
892 substring(_MapInfo_Map_worldspawn_music, strlen(_MapInfo_Map_worldspawn_music) - 4, 4) == ".ogg"
894 fputs(fh, strcat("cdtrack ", substring(_MapInfo_Map_worldspawn_music, 0, strlen(_MapInfo_Map_worldspawn_music) - 4), "\n"));
896 fputs(fh, strcat("cdtrack ", _MapInfo_Map_worldspawn_music, "\n"));
900 n = tokenize_console(cvar_string("g_cdtracks_remaplist"));
901 s = strcat(" ", cvar_string("g_cdtracks_dontusebydefault"), " ");
904 i = floor(random() * n);
905 if(strstrofs(s, strcat(" ", argv(i), " "), 0) < 0)
908 fputs(fh, strcat("cdtrack ", ftos(i + 1), "\n"));
910 if(MapInfo_Map_supportedFeatures & MAPINFO_FEATURE_WEAPONS)
911 fputs(fh, "has weapons\n");
913 fputs(fh, "// uncomment this if you added weapon pickups: has weapons\n");
914 if(MapInfo_Map_supportedFeatures & MAPINFO_FEATURE_TURRETS)
915 fputs(fh, "has turrets\n");
917 fputs(fh, "// uncomment this if you added turrets: has turrets\n");
918 if(MapInfo_Map_supportedFeatures & MAPINFO_FEATURE_VEHICLES)
919 fputs(fh, "has weapons\n");
921 fputs(fh, "// uncomment this if you added vehicles: has vehicles\n");
922 if(MapInfo_Map_flags & MAPINFO_FLAG_FRUSTRATING)
923 fputs(fh, "frustrating\n");
925 for(i = 1; i <= MapInfo_Map_supportedGametypes; i *= 2)
926 if(MapInfo_Map_supportedGametypes & i)
927 fputs(fh, sprintf("gametype %s // defaults: %s\n", MapInfo_Type_ToString(i), _MapInfo_GetDefaultEx(i)));
929 if(fexists(strcat("scripts/", pFilename, ".arena")))
930 fputs(fh, "settemp_for_type all sv_q3acompat_machineshotgunswap 1\n");
932 fputs(fh, "// optional: fog density red green blue alpha mindist maxdist\n");
933 fputs(fh, "// optional: settemp_for_type (all|gametypename) cvarname value\n");
934 fputs(fh, "// optional: clientsettemp_for_type (all|gametypename) cvarname value\n");
935 fputs(fh, "// optional: size mins_x mins_y mins_z maxs_x maxs_y maxs_z\n");
936 fputs(fh, "// optional: hidden\n");
941 fh = fopen(fn, FILE_READ);
943 error("... but I just wrote it!");
946 print("WARNING: autogenerated mapinfo file ", fn, " has been loaded; please edit that file and move it to maps/", pFilename, ".mapinfo\n");
949 _MapInfo_Map_Reset();
952 if not((s = fgets(fh)))
955 // catch different sorts of comments
956 if(s == "") // empty lines
958 if(substring(s, 0, 1) == "#") // UNIX style
960 if(substring(s, 0, 2) == "//") // C++ style
962 if(substring(s, 0, 1) == "_") // q3map style
965 p = strstrofs(s, "//", 0);
967 s = substring(s, 0, p);
969 t = car(s); s = cdr(s);
971 MapInfo_Map_title = s;
972 else if(t == "description")
973 MapInfo_Map_description = s;
974 else if(t == "author")
975 MapInfo_Map_author = s;
978 t = car(s); // s = cdr(s);
979 if (t == "weapons") MapInfo_Map_supportedFeatures |= MAPINFO_FEATURE_WEAPONS;
980 else if(t == "turrets") MapInfo_Map_supportedFeatures |= MAPINFO_FEATURE_TURRETS;
981 else if(t == "vehicles") MapInfo_Map_supportedFeatures |= MAPINFO_FEATURE_VEHICLES;
982 else if(t == "new_toys") MapInfo_Map_supportedFeatures |= MAPINFO_FEATURE_WEAPONS;
984 dprint("Map ", pFilename, " supports unknown feature ", t, ", ignored\n");
986 else if(t == "hidden")
988 MapInfo_Map_flags |= MAPINFO_FLAG_HIDDEN;
990 else if(t == "forbidden")
992 MapInfo_Map_flags |= MAPINFO_FLAG_FORBIDDEN;
994 else if(t == "frustrating")
996 MapInfo_Map_flags |= MAPINFO_FLAG_FRUSTRATING;
1000 t = car(s); s = cdr(s);
1001 f = MapInfo_Type_FromString(t);
1002 print("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");
1004 _MapInfo_Map_ApplyGametype (s, pGametypeToSet, f, TRUE);
1006 dprint("Map ", pFilename, " supports unknown game type ", t, ", ignored\n");
1008 else if(t == "gametype")
1010 t = car(s); s = cdr(s);
1011 f = MapInfo_Type_FromString(t);
1013 _MapInfo_Map_ApplyGametypeEx (s, pGametypeToSet, f);
1015 dprint("Map ", pFilename, " supports unknown game type ", t, ", ignored\n");
1017 else if(t == "size")
1019 float a, b, c, d, e;
1020 t = car(s); s = cdr(s); a = stof(t);
1021 t = car(s); s = cdr(s); b = stof(t);
1022 t = car(s); s = cdr(s); c = stof(t);
1023 t = car(s); s = cdr(s); d = stof(t);
1024 t = car(s); s = cdr(s); e = stof(t);
1026 print("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");
1029 t = car(s); s = cdr(s); f = stof(t);
1031 print("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");
1034 if(a >= d || b >= e || c >= f)
1035 print("Map ", pFilename, " contains an incorrect size line, mins have to be < maxs\n");
1038 MapInfo_Map_mins_x = a;
1039 MapInfo_Map_mins_y = b;
1040 MapInfo_Map_mins_z = c;
1041 MapInfo_Map_maxs_x = d;
1042 MapInfo_Map_maxs_y = e;
1043 MapInfo_Map_maxs_z = f;
1048 else if(t == "settemp_for_type")
1050 t = car(s); s = cdr(s);
1051 if((f = MapInfo_Type_FromString(t)))
1053 if(f & pGametypeToSet)
1055 _MapInfo_Parse_Settemp(pFilename, acl, 0, s, 1);
1060 dprint("Map ", pFilename, " has a setting for unknown game type ", t, ", ignored\n");
1063 else if(t == "clientsettemp_for_type")
1065 t = car(s); s = cdr(s);
1066 if((f = MapInfo_Type_FromString(t)))
1068 if(f & pGametypeToSet)
1070 _MapInfo_Parse_Settemp(pFilename, acl, 1, s, 1);
1075 dprint("Map ", pFilename, " has a client setting for unknown game type ", t, ", ignored\n");
1080 if not(cvar_value_issafe(t))
1081 print("Map ", pFilename, " contains a potentially harmful fog setting, ignored\n");
1083 MapInfo_Map_fog = s;
1085 else if(t == "cdtrack")
1089 if not(cvar_value_issafe(t))
1090 print("Map ", pFilename, " contains a potentially harmful cdtrack, ignored\n");
1092 MapInfo_Map_clientstuff = strcat(
1093 MapInfo_Map_clientstuff, "cd loop \"", s, "\"\n"
1098 dprint("Map ", pFilename, " provides unknown info item ", t, ", ignored\n");
1102 if(MapInfo_Map_title == "<TITLE>")
1103 MapInfo_Map_titlestring = MapInfo_Map_bspname;
1104 else if(MapInfo_isRedundant(MapInfo_Map_bspname, MapInfo_Map_title))
1105 MapInfo_Map_titlestring = MapInfo_Map_title;
1107 MapInfo_Map_titlestring = sprintf(_("%s: %s"), MapInfo_Map_bspname, MapInfo_Map_title);
1109 MapInfo_Cache_Store();
1110 if(MapInfo_Map_supportedGametypes != 0)
1112 dprint("Map ", pFilename, " supports no game types, ignored\n");
1115 float MapInfo_Get_ByName(string pFilename, float pAllowGenerate, float pGametypeToSet)
1117 float r = MapInfo_Get_ByName_NoFallbacks(pFilename, pAllowGenerate, pGametypeToSet);
1119 if(cvar("g_tdm_on_dm_maps"))
1121 // if this is set, all DM maps support TDM too
1122 if not(MapInfo_Map_supportedGametypes & MAPINFO_TYPE_TEAM_DEATHMATCH)
1123 if(MapInfo_Map_supportedGametypes & MAPINFO_TYPE_DEATHMATCH)
1124 _MapInfo_Map_ApplyGametypeEx ("", pGametypeToSet, MAPINFO_TYPE_TEAM_DEATHMATCH);
1129 if(!(MapInfo_Map_supportedGametypes & pGametypeToSet))
1131 error("Can't select the requested game type. This should never happen as the caller should prevent it!\n");
1132 //_MapInfo_Map_ApplyGametypeEx("", pGametypeToSet, MAPINFO_TYPE_DEATHMATCH);
1140 float MapInfo_FindName(string s)
1142 // if there is exactly one map of prefix s, return it
1143 // if not, return the null string
1144 // note that DP sorts glob results... so I can use a binary search
1148 // invariants: r is behind s, l-1 is equal or before
1151 m = floor((l + r) / 2);
1152 MapInfo_FindName_match = _MapInfo_GlobItem(MapInfo_FilterList_Lookup(m));
1153 cmp = strcasecmp(MapInfo_FindName_match, s);
1155 return m; // found and good
1157 l = m + 1; // l-1 is before s
1161 MapInfo_FindName_match = _MapInfo_GlobItem(MapInfo_FilterList_Lookup(l));
1162 MapInfo_FindName_firstResult = l;
1163 // r == l, so: l is behind s, l-1 is before
1164 // SO: if there is any, l is the one with the right prefix
1165 // and l+1 may be one too
1166 if(l == MapInfo_count)
1168 MapInfo_FindName_match = string_null;
1169 MapInfo_FindName_firstResult = -1;
1170 return -1; // no MapInfo_FindName_match, behind last item
1172 if(!startsWithNocase(MapInfo_FindName_match, s))
1174 MapInfo_FindName_match = string_null;
1175 MapInfo_FindName_firstResult = -1;
1176 return -1; // wrong prefix
1178 if(l == MapInfo_count - 1)
1179 return l; // last one, nothing can follow => unique
1180 if(startsWithNocase(_MapInfo_GlobItem(MapInfo_FilterList_Lookup(l + 1)), s))
1182 MapInfo_FindName_match = string_null;
1183 return -1; // ambigous MapInfo_FindName_match
1188 string MapInfo_FixName(string s)
1190 MapInfo_FindName(s);
1191 return MapInfo_FindName_match;
1194 float MapInfo_CurrentFeatures()
1198 if(!(cvar("g_lms") || cvar("g_minstagib") || cvar("g_nix") || cvar("g_weaponarena") || !cvar("g_pickup_items") || cvar("g_race") || cvar("g_cts") || cvar("g_nexball")))
1199 req |= MAPINFO_FEATURE_WEAPONS;
1203 float MapInfo_CurrentGametype()
1207 prev = cvar("gamecfg");
1208 for(e = MapInfo_Type_first; e; e = e.enemy)
1214 return MAPINFO_TYPE_DEATHMATCH;
1217 float _MapInfo_CheckMap(string s) // returns 0 if the map can't be played with the current settings, 1 otherwise
1219 if(!MapInfo_Get_ByName(s, 1, 0))
1221 if((MapInfo_Map_supportedGametypes & MapInfo_CurrentGametype()) == 0)
1223 if((MapInfo_Map_supportedFeatures & MapInfo_CurrentFeatures()) != MapInfo_CurrentFeatures())
1228 float MapInfo_CheckMap(string s) // returns 0 if the map can't be played with the current settings, 1 otherwise
1231 r = _MapInfo_CheckMap(s);
1232 MapInfo_ClearTemps();
1236 void MapInfo_SwitchGameType(float t)
1239 for(e = MapInfo_Type_first; e; e = e.enemy)
1240 cvar_set(e.netname, (t == e.items) ? "1" : "0");
1243 void MapInfo_LoadMap(string s, float reinit)
1245 MapInfo_Map_supportedGametypes = 0;
1246 // we shouldn't need this, as LoadMapSettings already fixes the gametype
1247 //if(!MapInfo_CheckMap(s))
1249 // print("EMERGENCY: can't play the selected map in the given game mode. Falling back to DM.\n");
1250 // MapInfo_SwitchGameType(MAPINFO_TYPE_DEATHMATCH);
1253 cvar_settemp_restore();
1255 localcmd(strcat("\nmap ", s, "\n"));
1257 localcmd(strcat("\nchangelevel ", s, "\n"));
1260 string MapInfo_ListAllowedMaps(float pRequiredFlags, float pForbiddenFlags)
1265 // to make absolutely sure:
1266 MapInfo_Enumerate();
1267 MapInfo_FilterGametype(MapInfo_CurrentGametype(), MapInfo_CurrentFeatures(), pRequiredFlags, pForbiddenFlags, 0);
1270 for(i = 0; i < MapInfo_count; ++i)
1271 out = strcat(out, " ", _MapInfo_GlobItem(MapInfo_FilterList_Lookup(i)));
1272 return substring(out, 1, strlen(out) - 1);
1275 string MapInfo_ListAllAllowedMaps(float pRequiredFlags, float pForbiddenFlags)
1280 // to make absolutely sure:
1281 MapInfo_Enumerate();
1282 MapInfo_FilterGametype(MAPINFO_TYPE_ALL, 0, pRequiredFlags, pForbiddenFlags, 0);
1285 for(i = 0; i < MapInfo_count; ++i)
1286 out = strcat(out, " ", _MapInfo_GlobItem(MapInfo_FilterList_Lookup(i)));
1288 MapInfo_FilterGametype(MapInfo_CurrentGametype(), MapInfo_CurrentFeatures(), pRequiredFlags, pForbiddenFlags, 0);
1290 return substring(out, 1, strlen(out) - 1);
1293 void MapInfo_LoadMapSettings_SaveGameType(float t)
1295 MapInfo_SwitchGameType(t);
1296 cvar_set("gamecfg", ftos(t));
1297 MapInfo_LoadedGametype = t;
1300 void MapInfo_LoadMapSettings(string s) // to be called from worldspawn
1304 t = MapInfo_CurrentGametype();
1305 MapInfo_LoadMapSettings_SaveGameType(t);
1307 if(!_MapInfo_CheckMap(s)) // with underscore, it keeps temps
1309 if(cvar("g_mapinfo_allow_unsupported_modes_and_let_stuff_break"))
1311 print("EMERGENCY: can't play the selected map in the given game mode. Working with only the override settings.\n");
1312 _MapInfo_Map_ApplyGametypeEx("", t, t);
1313 return; // do not call Get_ByName!
1316 if(MapInfo_Map_supportedGametypes == 0)
1318 print("Mapinfo system is not functional at all. Assuming deathmatch.\n");
1319 MapInfo_Map_supportedGametypes = MAPINFO_TYPE_DEATHMATCH;
1320 MapInfo_LoadMapSettings_SaveGameType(MAPINFO_TYPE_DEATHMATCH);
1321 _MapInfo_Map_ApplyGametypeEx("", MAPINFO_TYPE_DEATHMATCH, MAPINFO_TYPE_DEATHMATCH);
1322 return; // do not call Get_ByName!
1326 while(!(MapInfo_Map_supportedGametypes & 1))
1329 MapInfo_Map_supportedGametypes = floor(MapInfo_Map_supportedGametypes / 2);
1332 // t is now a supported mode!
1333 print("EMERGENCY: can't play the selected map in the given game mode. Falling back to a supported mode.\n");
1334 MapInfo_LoadMapSettings_SaveGameType(t);
1336 MapInfo_Get_ByName(s, 1, t);
1339 void MapInfo_ClearTemps()
1341 MapInfo_Map_bspname = string_null;
1342 MapInfo_Map_title = string_null;
1343 MapInfo_Map_titlestring = string_null;
1344 MapInfo_Map_description = string_null;
1345 MapInfo_Map_author = string_null;
1346 MapInfo_Map_clientstuff = string_null;
1347 MapInfo_Map_supportedGametypes = 0;
1348 MapInfo_Map_supportedFeatures = 0;
1351 void MapInfo_Shutdown()
1353 MapInfo_ClearTemps();
1354 MapInfo_Filter_Free();
1355 MapInfo_Cache_Destroy();
1356 if(_MapInfo_globopen)
1358 search_end(_MapInfo_globhandle);
1359 _MapInfo_globhandle = -1;
1360 _MapInfo_globopen = FALSE;
1364 float MapInfo_ForbiddenFlags()
1367 f = MAPINFO_FLAG_FORBIDDEN;
1370 if not(cvar("g_maplist_allow_hidden"))
1372 f |= MAPINFO_FLAG_HIDDEN;
1374 if not(cvar("g_maplist_allow_frustrating"))
1375 f |= MAPINFO_FLAG_FRUSTRATING;
1380 float MapInfo_RequiredFlags()
1385 if(cvar("g_maplist_allow_frustrating") > 1)
1386 f |= MAPINFO_FLAG_FRUSTRATING;