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 (!_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 (!((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 == "invasion_spawnpoint")
317 MapInfo_Map_supportedGametypes |= MAPINFO_TYPE_INVASION;
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(startsWith(v, "monster_"))
347 MapInfo_Map_supportedFeatures |= MAPINFO_FEATURE_MONSTERS;
348 else if(v == "target_music" || v == "trigger_music")
349 _MapInfo_Map_worldspawn_music = string_null; // don't use regular BGM
355 print(fn, " ended still in worldspawn, BUG\n");
358 diameter = vlen(mapMaxs - mapMins);
360 twoBaseModes = MapInfo_Map_supportedGametypes & (MAPINFO_TYPE_CTF | MAPINFO_TYPE_ASSAULT | MAPINFO_TYPE_RACE | MAPINFO_TYPE_NEXBALL);
361 if(twoBaseModes && (MapInfo_Map_supportedGametypes == twoBaseModes))
363 // we have a CTF-only or Assault-only map. Don't add other modes then,
364 // as the map is too symmetric for them.
368 MapInfo_Map_supportedGametypes |= MAPINFO_TYPE_DEATHMATCH; // DM always works
369 MapInfo_Map_supportedGametypes |= MAPINFO_TYPE_LMS; // LMS always works
370 MapInfo_Map_supportedGametypes |= MAPINFO_TYPE_KEEPAWAY; // Keepaway always works
372 if(spawnpoints >= 8 && diameter > 4096) {
373 MapInfo_Map_supportedGametypes |= MAPINFO_TYPE_TEAM_DEATHMATCH;
374 MapInfo_Map_supportedGametypes |= MAPINFO_TYPE_FREEZETAG;
375 MapInfo_Map_supportedGametypes |= MAPINFO_TYPE_CA;
377 if(spawnpoints >= 12 && diameter > 5120)
378 MapInfo_Map_supportedGametypes |= MAPINFO_TYPE_KEYHUNT;
381 if(MapInfo_Map_supportedGametypes & MAPINFO_TYPE_RACE)
384 MapInfo_Map_supportedGametypes &= ~MAPINFO_TYPE_RACE;
385 MapInfo_Map_supportedGametypes |= MAPINFO_TYPE_CTS;
388 dprint("-> diameter ", ftos(diameter));
389 dprint("; spawnpoints ", ftos(spawnpoints));
390 dprint("; modes ", ftos(MapInfo_Map_supportedGametypes), "\n");
397 void _MapInfo_Map_Reset()
399 MapInfo_Map_title = "<TITLE>";
400 MapInfo_Map_titlestring = "<TITLE>";
401 MapInfo_Map_description = "<DESCRIPTION>";
402 MapInfo_Map_author = "<AUTHOR>";
403 MapInfo_Map_supportedGametypes = 0;
404 MapInfo_Map_supportedFeatures = 0;
405 MapInfo_Map_flags = 0;
406 MapInfo_Map_clientstuff = "";
407 MapInfo_Map_fog = "";
408 MapInfo_Map_mins = '0 0 0';
409 MapInfo_Map_maxs = '0 0 0';
412 string _MapInfo_GetDefault(float t)
416 case MAPINFO_TYPE_DEATHMATCH: return "30 20 0";
417 case MAPINFO_TYPE_TEAM_DEATHMATCH: return "50 20 2 0";
418 case MAPINFO_TYPE_DOMINATION: return "200 20 0";
419 case MAPINFO_TYPE_CTF: return "300 20 10 0";
420 case MAPINFO_TYPE_LMS: return "9 20 0";
421 case MAPINFO_TYPE_CA: return "10 20 0";
422 case MAPINFO_TYPE_KEYHUNT: return "1000 20 3 0";
423 case MAPINFO_TYPE_ASSAULT: return "20 0";
424 case MAPINFO_TYPE_RACE: return "20 5 7 15 0";
425 case MAPINFO_TYPE_ONSLAUGHT: return "20 0";
426 case MAPINFO_TYPE_NEXBALL: return "5 20 0";
427 case MAPINFO_TYPE_CTS: return "20 0 0";
428 case MAPINFO_TYPE_FREEZETAG: return "10 20 0";
429 // NOTE: DO NOT ADD ANY MORE GAME TYPES HERE
430 // THIS IS JUST LEGACY SUPPORT FOR NEXUIZ MAPS
431 // ONLY ADD NEW STUFF TO _MapInfo_GetDefaultEx
432 // THIS FUNCTION WILL EVENTUALLY BE REMOVED
437 void _MapInfo_Map_ApplyGametype(string s, float pWantedType, float pThisType, float load_default)
440 MapInfo_Map_supportedGametypes |= pThisType;
441 if(!(pThisType & pWantedType))
445 _MapInfo_Map_ApplyGametype(_MapInfo_GetDefault(pThisType), pWantedType, pThisType, FALSE);
447 if(pWantedType == MAPINFO_TYPE_ASSAULT || pWantedType == MAPINFO_TYPE_ONSLAUGHT || pWantedType == MAPINFO_TYPE_RACE || pWantedType == MAPINFO_TYPE_CTS) // these modes don't use fraglimit
449 cvar_set("fraglimit", "0");
455 cvar_set("fraglimit", sa);
461 cvar_set("timelimit", sa);
464 if(pWantedType == MAPINFO_TYPE_TEAM_DEATHMATCH)
468 cvar_set("g_tdm_teams", sa);
472 if(pWantedType == MAPINFO_TYPE_KEYHUNT)
476 cvar_set("g_keyhunt_teams", sa);
480 if(pWantedType == MAPINFO_TYPE_CA)
484 cvar_set("g_ca_teams", sa);
488 if(pWantedType == MAPINFO_TYPE_FREEZETAG)
492 cvar_set("g_freezetag_teams", sa);
496 if(pWantedType == MAPINFO_TYPE_CTF)
500 cvar_set("fraglimit", sa);
505 if(pWantedType == MAPINFO_TYPE_KEEPAWAY)
509 cvar_set("fraglimit", sa);
514 // rc = timelimit timelimit_qualification laps laps_teamplay
515 if(pWantedType == MAPINFO_TYPE_RACE)
517 sa = car(s); if(sa == "") sa = cvar_string("timelimit");
518 cvar_set("g_race_qualifying_timelimit", sa);
523 if(cvar("g_race_teams") < 2)
524 cvar_set("fraglimit", sa);
529 if(cvar("g_race_teams") >= 2)
530 cvar_set("fraglimit", sa);
534 if(pWantedType == MAPINFO_TYPE_CTS)
538 // this is the skill of the map
539 // not parsed by anything yet
542 // cvar_set("fraglimit", sa);
547 if(pWantedType == MAPINFO_TYPE_ASSAULT || pWantedType == MAPINFO_TYPE_ONSLAUGHT || pWantedType == MAPINFO_TYPE_CTS) // these modes don't use fraglimit
549 cvar_set("leadlimit", "0");
555 cvar_set("leadlimit", sa);
560 string _MapInfo_GetDefaultEx(float t)
563 for(e = MapInfo_Type_first; e; e = e.enemy)
569 void _MapInfo_Map_ApplyGametypeEx(string s, float pWantedType, float pThisType)
573 string fraglimit_normal;
574 string fraglimit_teams;
576 MapInfo_Map_supportedGametypes |= pThisType;
577 if(!(pThisType & pWantedType))
580 // reset all the cvars to their defaults
582 cvar_set("timelimit", cvar_defstring("timelimit"));
583 cvar_set("leadlimit", cvar_defstring("leadlimit"));
584 cvar_set("fraglimit", cvar_defstring("fraglimit"));
585 cvar_set("g_tdm_teams", cvar_defstring("g_tdm_teams"));
586 cvar_set("g_ca_teams", cvar_defstring("g_ca_teams"));
587 cvar_set("g_freezetag_teams", cvar_defstring("g_freezetag_teams"));
588 cvar_set("g_keyhunt_teams", cvar_defstring("g_keyhunt_teams"));
589 cvar_set("g_domination_default_teams", cvar_defstring("g_domination_default_teams"));
590 cvar_set("g_race_qualifying_timelimit", cvar_defstring("g_race_qualifying_timelimit"));
592 fraglimit_normal = string_null;
593 fraglimit_teams = string_null;
595 s = strcat(_MapInfo_GetDefaultEx(pWantedType), " ", s);
604 p = strstrofs(sa, "=", 0);
607 print("Invalid gametype setting in mapinfo for gametype ", MapInfo_Type_ToString(pWantedType), ": ", sa, "\n");
610 k = substring(sa, 0, p);
611 v = substring(sa, p+1, -1);
615 cvar_set("timelimit", v);
617 else if(k == "leadlimit")
619 cvar_set("leadlimit", v);
621 else if(k == "pointlimit" || k == "fraglimit" || k == "lives" || k == "laplimit" || k == "caplimit")
623 fraglimit_normal = v;
625 else if(k == "teampointlimit" || k == "teamlaplimit")
629 else if(k == "teams")
631 cvar_set("g_tdm_teams", v);
632 cvar_set("g_ca_teams", v);
633 cvar_set("g_freezetag_teams", v);
634 cvar_set("g_keyhunt_teams", v);
635 cvar_set("g_domination_default_teams", v);
637 else if(k == "qualifying_timelimit")
639 cvar_set("g_race_qualifying_timelimit", v);
641 else if(k == "skill")
647 print("Invalid gametype setting in mapinfo for gametype ", MapInfo_Type_ToString(pWantedType), ": ", sa, "\n");
651 if(pWantedType == MAPINFO_TYPE_RACE && cvar("g_race_teams") >= 2)
654 cvar_set("fraglimit", fraglimit_teams);
659 cvar_set("fraglimit", fraglimit_normal);
663 float MapInfo_Type_FromString(string t)
668 print("MapInfo_Type_FromString (probably ", MapInfo_Map_bspname, "): using deprecated name '", t);
670 print("'. Should use '", t, "'.\n");
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 /* xgettext:no-c-format */
716 return _("@!#%'n Tuba Throwing");
719 void _MapInfo_Parse_Settemp(string pFilename, string acl, float type, string s, float recurse)
723 t = car(s); s = cdr(s);
725 // limited support of "" and comments
726 // remove trailing and leading " of t
727 if(substring(t, 0, 1) == "\"")
729 if(substring(t, -1, 1) == "\"")
730 t = substring(t, 1, -2);
733 // remove leading " of s
734 if(substring(s, 0, 1) == "\"")
736 s = substring(s, 1, -1);
738 // remove trailing " of s, and all that follows (cvar description)
739 o = strstrofs(s, "\"", 0);
741 s = substring(s, 0, o);
743 // remove // comments
744 o = strstrofs(s, "//", 0);
746 s = substring(s, 0, o);
748 // remove trailing spaces
749 while(substring(s, -1, 1) == " ")
750 s = substring(s, 0, -2);
756 fh = fopen(s, FILE_READ);
758 print("Map ", pFilename, " references not existing config file ", s, "\n");
763 if (!((s = fgets(fh))))
766 // catch different sorts of comments
767 if(s == "") // empty lines
769 if(substring(s, 0, 1) == "#") // UNIX style
771 if(substring(s, 0, 2) == "//") // C++ style
773 if(substring(s, 0, 1) == "_") // q3map style
776 if(substring(s, 0, 4) == "set ")
777 s = substring(s, 4, -1);
778 if(substring(s, 0, 5) == "seta ")
779 s = substring(s, 5, -1);
781 _MapInfo_Parse_Settemp(pFilename, acl, type, s, recurse - 1);
787 print("Map ", pFilename, " uses too many levels of inclusion\n");
790 print("Map ", pFilename, " contains a potentially harmful setting, ignored\n");
791 else if (!cvar_value_issafe(t))
792 print("Map ", pFilename, " contains a potentially harmful setting, ignored\n");
793 else if (!cvar_value_issafe(s))
794 print("Map ", pFilename, " contains a potentially harmful setting, ignored\n");
795 else if(matchacl(MAPINFO_SETTEMP_ACL_SYSTEM, t) <= 0)
796 print("Map ", pFilename, " contains a potentially harmful setting, ignored\n");
797 else if(matchacl(acl, t) <= 0)
798 print("Map ", pFilename, " contains a denied setting, ignored\n");
801 if(type == 0) // server set
803 dprint("Applying temporary setting ", t, " := ", s, "\n");
804 if(cvar("g_campaign"))
805 cvar_set(t, s); // this is a wrapper and is always temporary anyway; no need to backup old values then
811 dprint("Applying temporary client setting ", t, " := ", s, "\n");
812 MapInfo_Map_clientstuff = strcat(
813 MapInfo_Map_clientstuff, "cl_cmd settemp \"", t, "\" \"", s, "\"\n"
819 float MapInfo_isRedundant(string fn, string t)
821 // normalize file name
822 fn = strreplace("_", "-", fn);
824 // normalize visible title
825 t = strreplace(": ", "-", t);
826 t = strreplace(":", "-", t);
827 t = strreplace(" ", "-", t);
828 t = strreplace("_", "-", t);
829 t = strreplace("'", "-", t);
831 if(!strcasecmp(fn, t))
834 // we allow the visible title to have punctuation the file name does
835 // not, but not vice versa
836 t = strreplace("-", "", t);
838 if(!strcasecmp(fn, t))
844 // load info about a map by name into the MapInfo_Map_* globals
845 float MapInfo_Get_ByName_NoFallbacks(string pFilename, float pAllowGenerate, float pGametypeToSet)
853 acl = MAPINFO_SETTEMP_ACL_USER;
855 if(strstrofs(pFilename, "/", 0) >= 0)
857 print("Invalid character in map name, ignored\n");
861 if(pGametypeToSet == 0)
862 if(MapInfo_Cache_Retrieve(pFilename))
867 MapInfo_Map_bspname = pFilename;
869 // default all generic fields so they have "good" values in case something fails
870 fn = strcat("maps/", pFilename, ".mapinfo");
871 fh = fopen(fn, FILE_READ);
874 fn = strcat("maps/autogenerated/", pFilename, ".mapinfo");
875 fh = fopen(fn, FILE_READ);
880 _MapInfo_Map_Reset();
881 r = _MapInfo_Generate(pFilename);
884 fh = fopen(fn, FILE_WRITE);
885 fputs(fh, strcat("title ", MapInfo_Map_title, "\n"));
886 fputs(fh, strcat("description ", MapInfo_Map_description, "\n"));
887 fputs(fh, strcat("author ", MapInfo_Map_author, "\n"));
888 if(_MapInfo_Map_worldspawn_music != "")
891 substring(_MapInfo_Map_worldspawn_music, strlen(_MapInfo_Map_worldspawn_music) - 4, 4) == ".wav"
893 substring(_MapInfo_Map_worldspawn_music, strlen(_MapInfo_Map_worldspawn_music) - 4, 4) == ".ogg"
895 fputs(fh, strcat("cdtrack ", substring(_MapInfo_Map_worldspawn_music, 0, strlen(_MapInfo_Map_worldspawn_music) - 4), "\n"));
897 fputs(fh, strcat("cdtrack ", _MapInfo_Map_worldspawn_music, "\n"));
901 n = tokenize_console(cvar_string("g_cdtracks_remaplist"));
902 s = strcat(" ", cvar_string("g_cdtracks_dontusebydefault"), " ");
905 i = floor(random() * n);
906 if(strstrofs(s, strcat(" ", argv(i), " "), 0) < 0)
909 fputs(fh, strcat("cdtrack ", ftos(i + 1), "\n"));
911 if(MapInfo_Map_supportedFeatures & MAPINFO_FEATURE_WEAPONS)
912 fputs(fh, "has weapons\n");
914 fputs(fh, "// uncomment this if you added weapon pickups: has weapons\n");
915 if(MapInfo_Map_supportedFeatures & MAPINFO_FEATURE_TURRETS)
916 fputs(fh, "has turrets\n");
918 fputs(fh, "// uncomment this if you added turrets: has turrets\n");
919 if(MapInfo_Map_supportedFeatures & MAPINFO_FEATURE_VEHICLES)
920 fputs(fh, "has vehicles\n");
922 fputs(fh, "// uncomment this if you added vehicles: has vehicles\n");
923 if(MapInfo_Map_flags & MAPINFO_FLAG_FRUSTRATING)
924 fputs(fh, "frustrating\n");
926 for(i = 1; i <= MapInfo_Map_supportedGametypes; i *= 2)
927 if(MapInfo_Map_supportedGametypes & i)
928 fputs(fh, sprintf("gametype %s // defaults: %s\n", MapInfo_Type_ToString(i), _MapInfo_GetDefaultEx(i)));
930 if(fexists(strcat("scripts/", pFilename, ".arena")))
931 fputs(fh, "settemp_for_type all sv_q3acompat_machineshotgunswap 1\n");
933 fputs(fh, "// optional: fog density red green blue alpha mindist maxdist\n");
934 fputs(fh, "// optional: settemp_for_type (all|gametypename) cvarname value\n");
935 fputs(fh, "// optional: clientsettemp_for_type (all|gametypename) cvarname value\n");
936 fputs(fh, "// optional: size mins_x mins_y mins_z maxs_x maxs_y maxs_z\n");
937 fputs(fh, "// optional: hidden\n");
942 fh = fopen(fn, FILE_READ);
944 error("... but I just wrote it!");
947 print("WARNING: autogenerated mapinfo file ", fn, " has been loaded; please edit that file and move it to maps/", pFilename, ".mapinfo\n");
950 _MapInfo_Map_Reset();
953 if (!((s = fgets(fh))))
956 // catch different sorts of comments
957 if(s == "") // empty lines
959 if(substring(s, 0, 1) == "#") // UNIX style
961 if(substring(s, 0, 2) == "//") // C++ style
963 if(substring(s, 0, 1) == "_") // q3map style
966 p = strstrofs(s, "//", 0);
968 s = substring(s, 0, p);
970 t = car(s); s = cdr(s);
972 MapInfo_Map_title = s;
973 else if(t == "description")
974 MapInfo_Map_description = s;
975 else if(t == "author")
976 MapInfo_Map_author = s;
979 t = car(s); // s = cdr(s);
980 if (t == "weapons") MapInfo_Map_supportedFeatures |= MAPINFO_FEATURE_WEAPONS;
981 else if(t == "turrets") MapInfo_Map_supportedFeatures |= MAPINFO_FEATURE_TURRETS;
982 else if(t == "vehicles") MapInfo_Map_supportedFeatures |= MAPINFO_FEATURE_VEHICLES;
983 else if(t == "monsters") MapInfo_Map_supportedFeatures |= MAPINFO_FEATURE_MONSTERS;
984 else if(t == "new_toys") MapInfo_Map_supportedFeatures |= MAPINFO_FEATURE_WEAPONS;
986 dprint("Map ", pFilename, " supports unknown feature ", t, ", ignored\n");
988 else if(t == "hidden")
990 MapInfo_Map_flags |= MAPINFO_FLAG_HIDDEN;
992 else if(t == "forbidden")
994 MapInfo_Map_flags |= MAPINFO_FLAG_FORBIDDEN;
996 else if(t == "frustrating")
998 MapInfo_Map_flags |= MAPINFO_FLAG_FRUSTRATING;
1000 else if(t == "noautomaplist")
1002 MapInfo_Map_flags |= MAPINFO_FLAG_NOAUTOMAPLIST;
1004 else if(t == "type")
1006 t = car(s); s = cdr(s);
1007 f = MapInfo_Type_FromString(t);
1008 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");
1010 _MapInfo_Map_ApplyGametype (s, pGametypeToSet, f, TRUE);
1012 dprint("Map ", pFilename, " supports unknown game type ", t, ", ignored\n");
1014 else if(t == "gametype")
1016 t = car(s); s = cdr(s);
1017 f = MapInfo_Type_FromString(t);
1019 _MapInfo_Map_ApplyGametypeEx (s, pGametypeToSet, f);
1021 dprint("Map ", pFilename, " supports unknown game type ", t, ", ignored\n");
1023 else if(t == "size")
1025 float a, b, c, d, e;
1026 t = car(s); s = cdr(s); a = stof(t);
1027 t = car(s); s = cdr(s); b = stof(t);
1028 t = car(s); s = cdr(s); c = stof(t);
1029 t = car(s); s = cdr(s); d = stof(t);
1030 t = car(s); s = cdr(s); e = stof(t);
1032 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");
1035 t = car(s); s = cdr(s); f = stof(t);
1037 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");
1040 if(a >= d || b >= e || c >= f)
1041 print("Map ", pFilename, " contains an incorrect size line, mins have to be < maxs\n");
1044 MapInfo_Map_mins_x = a;
1045 MapInfo_Map_mins_y = b;
1046 MapInfo_Map_mins_z = c;
1047 MapInfo_Map_maxs_x = d;
1048 MapInfo_Map_maxs_y = e;
1049 MapInfo_Map_maxs_z = f;
1054 else if(t == "settemp_for_type")
1056 t = car(s); s = cdr(s);
1057 if((f = MapInfo_Type_FromString(t)))
1059 if(f & pGametypeToSet)
1061 _MapInfo_Parse_Settemp(pFilename, acl, 0, s, 1);
1066 dprint("Map ", pFilename, " has a setting for unknown game type ", t, ", ignored\n");
1069 else if(t == "clientsettemp_for_type")
1071 t = car(s); s = cdr(s);
1072 if((f = MapInfo_Type_FromString(t)))
1074 if(f & pGametypeToSet)
1076 _MapInfo_Parse_Settemp(pFilename, acl, 1, s, 1);
1081 dprint("Map ", pFilename, " has a client setting for unknown game type ", t, ", ignored\n");
1086 if (!cvar_value_issafe(s))
1087 print("Map ", pFilename, " contains a potentially harmful fog setting, ignored\n");
1089 MapInfo_Map_fog = s;
1091 else if(t == "cdtrack")
1093 t = car(s); s = cdr(s);
1094 if(pGametypeToSet) // FIXME is this check right here?
1096 if (!cvar_value_issafe(t))
1097 print("Map ", pFilename, " contains a potentially harmful cdtrack, ignored\n");
1099 MapInfo_Map_clientstuff = strcat(
1100 MapInfo_Map_clientstuff, "cd loop \"", t, "\"\n"
1105 dprint("Map ", pFilename, " provides unknown info item ", t, ", ignored\n");
1109 if(MapInfo_Map_title == "<TITLE>")
1110 MapInfo_Map_titlestring = MapInfo_Map_bspname;
1111 else if(MapInfo_isRedundant(MapInfo_Map_bspname, MapInfo_Map_title))
1112 MapInfo_Map_titlestring = MapInfo_Map_title;
1114 MapInfo_Map_titlestring = sprintf(_("%s: %s"), MapInfo_Map_bspname, MapInfo_Map_title);
1116 MapInfo_Cache_Store();
1117 if(MapInfo_Map_supportedGametypes != 0)
1119 dprint("Map ", pFilename, " supports no game types, ignored\n");
1122 float MapInfo_Get_ByName(string pFilename, float pAllowGenerate, float pGametypeToSet)
1124 float r = MapInfo_Get_ByName_NoFallbacks(pFilename, pAllowGenerate, pGametypeToSet);
1126 if(cvar("g_tdm_on_dm_maps"))
1128 // if this is set, all DM maps support TDM too
1129 if (!(MapInfo_Map_supportedGametypes & MAPINFO_TYPE_TEAM_DEATHMATCH))
1130 if(MapInfo_Map_supportedGametypes & MAPINFO_TYPE_DEATHMATCH)
1131 _MapInfo_Map_ApplyGametypeEx ("", pGametypeToSet, MAPINFO_TYPE_TEAM_DEATHMATCH);
1136 if(!(MapInfo_Map_supportedGametypes & pGametypeToSet))
1138 error("Can't select the requested game type. This should never happen as the caller should prevent it!\n");
1139 //_MapInfo_Map_ApplyGametypeEx("", pGametypeToSet, MAPINFO_TYPE_DEATHMATCH);
1147 float MapInfo_FindName(string s)
1149 // if there is exactly one map of prefix s, return it
1150 // if not, return the null string
1151 // note that DP sorts glob results... so I can use a binary search
1155 // invariants: r is behind s, l-1 is equal or before
1158 m = floor((l + r) / 2);
1159 MapInfo_FindName_match = _MapInfo_GlobItem(MapInfo_FilterList_Lookup(m));
1160 cmp = strcasecmp(MapInfo_FindName_match, s);
1162 return m; // found and good
1164 l = m + 1; // l-1 is before s
1168 MapInfo_FindName_match = _MapInfo_GlobItem(MapInfo_FilterList_Lookup(l));
1169 MapInfo_FindName_firstResult = l;
1170 // r == l, so: l is behind s, l-1 is before
1171 // SO: if there is any, l is the one with the right prefix
1172 // and l+1 may be one too
1173 if(l == MapInfo_count)
1175 MapInfo_FindName_match = string_null;
1176 MapInfo_FindName_firstResult = -1;
1177 return -1; // no MapInfo_FindName_match, behind last item
1179 if(!startsWithNocase(MapInfo_FindName_match, s))
1181 MapInfo_FindName_match = string_null;
1182 MapInfo_FindName_firstResult = -1;
1183 return -1; // wrong prefix
1185 if(l == MapInfo_count - 1)
1186 return l; // last one, nothing can follow => unique
1187 if(startsWithNocase(_MapInfo_GlobItem(MapInfo_FilterList_Lookup(l + 1)), s))
1189 MapInfo_FindName_match = string_null;
1190 return -1; // ambigous MapInfo_FindName_match
1195 string MapInfo_FixName(string s)
1197 MapInfo_FindName(s);
1198 return MapInfo_FindName_match;
1201 float MapInfo_CurrentFeatures()
1205 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")))
1206 req |= MAPINFO_FEATURE_WEAPONS;
1210 float MapInfo_CurrentGametype()
1214 prev = cvar("gamecfg");
1215 for(e = MapInfo_Type_first; e; e = e.enemy)
1221 return MAPINFO_TYPE_DEATHMATCH;
1224 float _MapInfo_CheckMap(string s) // returns 0 if the map can't be played with the current settings, 1 otherwise
1226 if(!MapInfo_Get_ByName(s, 1, 0))
1228 if((MapInfo_Map_supportedGametypes & MapInfo_CurrentGametype()) == 0)
1230 if((MapInfo_Map_supportedFeatures & MapInfo_CurrentFeatures()) != MapInfo_CurrentFeatures())
1235 float MapInfo_CheckMap(string s) // returns 0 if the map can't be played with the current settings, 1 otherwise
1238 r = _MapInfo_CheckMap(s);
1239 MapInfo_ClearTemps();
1243 void MapInfo_SwitchGameType(float t)
1246 for(e = MapInfo_Type_first; e; e = e.enemy)
1247 cvar_set(e.netname, (t == e.items) ? "1" : "0");
1250 void MapInfo_LoadMap(string s, float reinit)
1252 MapInfo_Map_supportedGametypes = 0;
1253 // we shouldn't need this, as LoadMapSettings already fixes the gametype
1254 //if(!MapInfo_CheckMap(s))
1256 // print("EMERGENCY: can't play the selected map in the given game mode. Falling back to DM.\n");
1257 // MapInfo_SwitchGameType(MAPINFO_TYPE_DEATHMATCH);
1260 cvar_settemp_restore();
1262 localcmd(strcat("\nmap ", s, "\n"));
1264 localcmd(strcat("\nchangelevel ", s, "\n"));
1267 string MapInfo_ListAllowedMaps(float pRequiredFlags, float pForbiddenFlags)
1272 // to make absolutely sure:
1273 MapInfo_Enumerate();
1274 MapInfo_FilterGametype(MapInfo_CurrentGametype(), MapInfo_CurrentFeatures(), pRequiredFlags, pForbiddenFlags, 0);
1277 for(i = 0; i < MapInfo_count; ++i)
1278 out = strcat(out, " ", _MapInfo_GlobItem(MapInfo_FilterList_Lookup(i)));
1279 return substring(out, 1, strlen(out) - 1);
1282 string MapInfo_ListAllAllowedMaps(float pRequiredFlags, float pForbiddenFlags)
1287 // to make absolutely sure:
1288 MapInfo_Enumerate();
1289 MapInfo_FilterGametype(MAPINFO_TYPE_ALL, 0, pRequiredFlags, pForbiddenFlags, 0);
1292 for(i = 0; i < MapInfo_count; ++i)
1293 out = strcat(out, " ", _MapInfo_GlobItem(MapInfo_FilterList_Lookup(i)));
1295 MapInfo_FilterGametype(MapInfo_CurrentGametype(), MapInfo_CurrentFeatures(), pRequiredFlags, pForbiddenFlags, 0);
1297 return substring(out, 1, strlen(out) - 1);
1300 void MapInfo_LoadMapSettings_SaveGameType(float t)
1302 MapInfo_SwitchGameType(t);
1303 cvar_set("gamecfg", ftos(t));
1304 MapInfo_LoadedGametype = t;
1307 void MapInfo_LoadMapSettings(string s) // to be called from worldspawn
1311 t = MapInfo_CurrentGametype();
1312 MapInfo_LoadMapSettings_SaveGameType(t);
1314 if(!_MapInfo_CheckMap(s)) // with underscore, it keeps temps
1316 if(cvar("g_mapinfo_allow_unsupported_modes_and_let_stuff_break"))
1318 print("EMERGENCY: can't play the selected map in the given game mode. Working with only the override settings.\n");
1319 _MapInfo_Map_ApplyGametypeEx("", t, t);
1320 return; // do not call Get_ByName!
1323 if(MapInfo_Map_supportedGametypes == 0)
1325 print("Mapinfo system is not functional at all. Assuming deathmatch.\n");
1326 MapInfo_Map_supportedGametypes = MAPINFO_TYPE_DEATHMATCH;
1327 MapInfo_LoadMapSettings_SaveGameType(MAPINFO_TYPE_DEATHMATCH);
1328 _MapInfo_Map_ApplyGametypeEx("", MAPINFO_TYPE_DEATHMATCH, MAPINFO_TYPE_DEATHMATCH);
1329 return; // do not call Get_ByName!
1333 while(!(MapInfo_Map_supportedGametypes & 1))
1336 MapInfo_Map_supportedGametypes = floor(MapInfo_Map_supportedGametypes / 2);
1339 // t is now a supported mode!
1340 print("EMERGENCY: can't play the selected map in the given game mode. Falling back to a supported mode.\n");
1341 MapInfo_LoadMapSettings_SaveGameType(t);
1343 MapInfo_Get_ByName(s, 1, t);
1346 void MapInfo_ClearTemps()
1348 MapInfo_Map_bspname = string_null;
1349 MapInfo_Map_title = string_null;
1350 MapInfo_Map_titlestring = string_null;
1351 MapInfo_Map_description = string_null;
1352 MapInfo_Map_author = string_null;
1353 MapInfo_Map_clientstuff = string_null;
1354 MapInfo_Map_supportedGametypes = 0;
1355 MapInfo_Map_supportedFeatures = 0;
1358 void MapInfo_Shutdown()
1360 MapInfo_ClearTemps();
1361 MapInfo_Filter_Free();
1362 MapInfo_Cache_Destroy();
1363 if(_MapInfo_globopen)
1365 search_end(_MapInfo_globhandle);
1366 _MapInfo_globhandle = -1;
1367 _MapInfo_globopen = FALSE;
1371 float MapInfo_ForbiddenFlags()
1374 f = MAPINFO_FLAG_FORBIDDEN;
1377 if (!cvar("g_maplist_allow_hidden"))
1379 f |= MAPINFO_FLAG_HIDDEN;
1381 if (!cvar("g_maplist_allow_frustrating"))
1382 f |= MAPINFO_FLAG_FRUSTRATING;
1387 float MapInfo_RequiredFlags()
1392 if(cvar("g_maplist_allow_frustrating") > 1)
1393 f |= MAPINFO_FLAG_FRUSTRATING;