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 == "td_generator")
319 MapInfo_Map_supportedGametypes |= MAPINFO_TYPE_TD;
320 else if(v == "target_assault_roundend")
321 MapInfo_Map_supportedGametypes |= MAPINFO_TYPE_ASSAULT;
322 else if(v == "onslaught_generator")
323 MapInfo_Map_supportedGametypes |= MAPINFO_TYPE_ONSLAUGHT;
324 else if(substring(v, 0, 8) == "nexball_" || substring(v, 0, 4) == "ball")
325 MapInfo_Map_supportedGametypes |= MAPINFO_TYPE_NEXBALL;
326 else if(v == "info_player_team1")
328 else if(v == "info_player_team2")
330 else if(v == "info_player_start")
332 else if(v == "info_player_deathmatch")
334 else if(v == "trigger_race_checkpoint")
335 MapInfo_Map_supportedGametypes |= MAPINFO_TYPE_RACE;
336 else if(v == "target_startTimer")
337 MapInfo_Map_supportedGametypes |= MAPINFO_TYPE_CTS;
338 else if(v == "weapon_nex")
340 else if(v == "weapon_railgun")
342 else if(startsWith(v, "weapon_"))
343 MapInfo_Map_supportedFeatures |= MAPINFO_FEATURE_WEAPONS;
344 else if(startsWith(v, "turret_"))
345 MapInfo_Map_supportedFeatures |= MAPINFO_FEATURE_TURRETS;
346 else if(startsWith(v, "vehicle_"))
347 MapInfo_Map_supportedFeatures |= MAPINFO_FEATURE_VEHICLES;
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_RUNEMATCH; // Rune always works
370 MapInfo_Map_supportedGametypes |= MAPINFO_TYPE_LMS; // LMS always works
371 MapInfo_Map_supportedGametypes |= MAPINFO_TYPE_KEEPAWAY; // Keepaway always works
373 if(spawnpoints >= 8 && diameter > 4096) {
374 MapInfo_Map_supportedGametypes |= MAPINFO_TYPE_TEAM_DEATHMATCH;
375 MapInfo_Map_supportedGametypes |= MAPINFO_TYPE_FREEZETAG;
376 MapInfo_Map_supportedGametypes |= MAPINFO_TYPE_CA;
379 MapInfo_Map_supportedGametypes |= MAPINFO_TYPE_ARENA;
380 if(spawnpoints >= 12 && diameter > 5120)
381 MapInfo_Map_supportedGametypes |= MAPINFO_TYPE_KEYHUNT;
384 if(MapInfo_Map_supportedGametypes & MAPINFO_TYPE_RACE)
387 MapInfo_Map_supportedGametypes &~= MAPINFO_TYPE_RACE;
388 MapInfo_Map_supportedGametypes |= MAPINFO_TYPE_CTS;
391 dprint("-> diameter ", ftos(diameter));
392 dprint("; spawnpoints ", ftos(spawnpoints));
393 dprint("; modes ", ftos(MapInfo_Map_supportedGametypes), "\n");
400 void _MapInfo_Map_Reset()
402 MapInfo_Map_title = "<TITLE>";
403 MapInfo_Map_titlestring = "<TITLE>";
404 MapInfo_Map_description = "<DESCRIPTION>";
405 MapInfo_Map_author = "<AUTHOR>";
406 MapInfo_Map_supportedGametypes = 0;
407 MapInfo_Map_supportedFeatures = 0;
408 MapInfo_Map_flags = 0;
409 MapInfo_Map_clientstuff = "";
410 MapInfo_Map_fog = "";
411 MapInfo_Map_mins = '0 0 0';
412 MapInfo_Map_maxs = '0 0 0';
415 string _MapInfo_GetDefault(float t)
419 case MAPINFO_TYPE_DEATHMATCH: return "30 20 0";
420 case MAPINFO_TYPE_TEAM_DEATHMATCH: return "50 20 2 0";
421 case MAPINFO_TYPE_DOMINATION: return "200 20 0";
422 case MAPINFO_TYPE_CTF: return "300 20 10 0";
423 case MAPINFO_TYPE_RUNEMATCH: return "200 20 0";
424 case MAPINFO_TYPE_LMS: return "9 20 0";
425 case MAPINFO_TYPE_ARENA: return "10 20 0";
426 case MAPINFO_TYPE_CA: return "10 20 0";
427 case MAPINFO_TYPE_KEYHUNT: return "1000 20 3 0";
428 case MAPINFO_TYPE_ASSAULT: return "20 0";
429 case MAPINFO_TYPE_RACE: return "20 5 7 15 0";
430 case MAPINFO_TYPE_ONSLAUGHT: return "20 0";
431 case MAPINFO_TYPE_NEXBALL: return "5 20 0";
432 case MAPINFO_TYPE_CTS: return "20 0 0";
433 case MAPINFO_TYPE_FREEZETAG: return "10 20 0";
434 // NOTE: DO NOT ADD ANY MORE GAME TYPES HERE
435 // THIS IS JUST LEGACY SUPPORT FOR NEXUIZ MAPS
436 // ONLY ADD NEW STUFF TO _MapInfo_GetDefaultEx
437 // THIS FUNCTION WILL EVENTUALLY BE REMOVED
442 void _MapInfo_Map_ApplyGametype(string s, float pWantedType, float pThisType, float load_default)
445 MapInfo_Map_supportedGametypes |= pThisType;
446 if(!(pThisType & pWantedType))
450 _MapInfo_Map_ApplyGametype(_MapInfo_GetDefault(pThisType), pWantedType, pThisType, FALSE);
452 if(pWantedType == MAPINFO_TYPE_ASSAULT || pWantedType == MAPINFO_TYPE_ONSLAUGHT || pWantedType == MAPINFO_TYPE_RACE || pWantedType == MAPINFO_TYPE_CTS) // these modes don't use fraglimit
454 cvar_set("fraglimit", "0");
460 cvar_set("fraglimit", sa);
466 cvar_set("timelimit", sa);
469 if(pWantedType == MAPINFO_TYPE_TEAM_DEATHMATCH)
473 cvar_set("g_tdm_teams", sa);
477 if(pWantedType == MAPINFO_TYPE_KEYHUNT)
481 cvar_set("g_keyhunt_teams", sa);
485 if(pWantedType == MAPINFO_TYPE_CTF)
489 cvar_set("fraglimit", sa);
494 if(pWantedType == MAPINFO_TYPE_KEEPAWAY)
498 cvar_set("fraglimit", sa);
503 // rc = timelimit timelimit_qualification laps laps_teamplay
504 if(pWantedType == MAPINFO_TYPE_RACE)
506 sa = car(s); if(sa == "") sa = cvar_string("timelimit");
507 cvar_set("g_race_qualifying_timelimit", sa);
512 if(cvar("g_race_teams") < 2)
513 cvar_set("fraglimit", sa);
518 if(cvar("g_race_teams") >= 2)
519 cvar_set("fraglimit", sa);
523 if(pWantedType == MAPINFO_TYPE_CTS)
527 // this is the skill of the map
528 // not parsed by anything yet
531 // cvar_set("fraglimit", sa);
536 if(pWantedType == MAPINFO_TYPE_ASSAULT || pWantedType == MAPINFO_TYPE_ONSLAUGHT || pWantedType == MAPINFO_TYPE_CTS) // these modes don't use fraglimit
538 cvar_set("leadlimit", "0");
544 cvar_set("leadlimit", sa);
549 string _MapInfo_GetDefaultEx(float t)
552 for(e = MapInfo_Type_first; e; e = e.enemy)
558 void _MapInfo_Map_ApplyGametypeEx(string s, float pWantedType, float pThisType)
562 string fraglimit_normal;
563 string fraglimit_teams;
565 MapInfo_Map_supportedGametypes |= pThisType;
566 if(!(pThisType & pWantedType))
569 // reset all the cvars to their defaults
571 cvar_set("timelimit", cvar_defstring("timelimit"));
572 cvar_set("leadlimit", cvar_defstring("leadlimit"));
573 cvar_set("fraglimit", cvar_defstring("fraglimit"));
574 cvar_set("g_tdm_teams", cvar_defstring("g_tdm_teams"));
575 cvar_set("g_keyhunt_teams", cvar_defstring("g_keyhunt_teams"));
576 cvar_set("g_domination_default_teams", cvar_defstring("g_domination_default_teams"));
577 cvar_set("g_race_qualifying_timelimit", cvar_defstring("g_race_qualifying_timelimit"));
579 fraglimit_normal = string_null;
580 fraglimit_teams = string_null;
582 s = strcat(_MapInfo_GetDefaultEx(pWantedType), " ", s);
591 p = strstrofs(sa, "=", 0);
599 k = substring(sa, 0, p);
600 v = substring(sa, p+1, -1);
605 cvar_set("timelimit", v);
607 else if(k == "leadlimit")
609 cvar_set("leadlimit", v);
611 else if(k == "pointlimit" || k == "fraglimit" || k == "lives" || k == "laplimit" || k == "caplimit")
613 fraglimit_normal = v;
615 else if(k == "teampointlimit" || k == "teamlaplimit")
619 else if(k == "teams")
621 cvar_set("g_tdm_teams", v);
622 cvar_set("g_keyhunt_teams", v);
623 cvar_set("g_domination_default_teams", v);
625 else if(k == "qualifying_timelimit")
627 cvar_set("g_race_qualifying_timelimit", v);
629 else if(k == "skill")
635 print("Invalid gametype key in mapinfo: ", k, "\n");
639 if(pWantedType == MAPINFO_TYPE_RACE && cvar("g_race_teams") >= 2)
642 cvar_set("fraglimit", fraglimit_teams);
647 cvar_set("fraglimit", fraglimit_normal);
651 float MapInfo_Type_FromString(string t)
656 print("MapInfo_Type_FromString (probably ", MapInfo_Map_bspname, "): using deprecated name '", t);
658 print("'. Should use '", t, "'.\n");
662 print("MapInfo_Type_FromString (probably ", MapInfo_Map_bspname, "): using deprecated name '", t);
664 print("'. Should use '", t, "'.\n");
668 print("MapInfo_Type_FromString (probably ", MapInfo_Map_bspname, "): using deprecated name '", t);
670 print("'. Should use '", t, "'.\n");
673 return MAPINFO_TYPE_ALL;
674 for(e = MapInfo_Type_first; e; e = e.enemy)
680 string MapInfo_Type_ToString(float t)
683 if(t == MAPINFO_TYPE_ALL)
685 for(e = MapInfo_Type_first; e; e = e.enemy)
691 string MapInfo_Type_ToText(float t)
694 for(e = MapInfo_Type_first; e; e = e.enemy)
697 return _("@!#%'n Tuba Throwing");
700 void _MapInfo_Parse_Settemp(string pFilename, string acl, float type, string s, float recurse)
704 t = car(s); s = cdr(s);
706 // limited support of "" and comments
707 // remove trailing and leading " of t
708 if(substring(t, 0, 1) == "\"")
710 if(substring(t, -1, 1) == "\"")
711 t = substring(t, 1, -2);
714 // remove leading " of s
715 if(substring(s, 0, 1) == "\"")
717 s = substring(s, 1, -1);
719 // remove trailing " of s, and all that follows (cvar description)
720 o = strstrofs(s, "\"", 0);
722 s = substring(s, 0, o);
724 // remove // comments
725 o = strstrofs(s, "//", 0);
727 s = substring(s, 0, o);
729 // remove trailing spaces
730 while(substring(s, -1, 1) == " ")
731 s = substring(s, 0, -2);
737 fh = fopen(s, FILE_READ);
739 print("Map ", pFilename, " references not existing config file ", s, "\n");
744 if not((s = fgets(fh)))
747 // catch different sorts of comments
748 if(s == "") // empty lines
750 if(substring(s, 0, 1) == "#") // UNIX style
752 if(substring(s, 0, 2) == "//") // C++ style
754 if(substring(s, 0, 1) == "_") // q3map style
757 if(substring(s, 0, 4) == "set ")
758 s = substring(s, 4, -1);
759 if(substring(s, 0, 5) == "seta ")
760 s = substring(s, 5, -1);
762 _MapInfo_Parse_Settemp(pFilename, acl, type, s, recurse - 1);
768 print("Map ", pFilename, " uses too many levels of inclusion\n");
771 print("Map ", pFilename, " contains a potentially harmful setting, ignored\n");
772 else if not(cvar_value_issafe(t))
773 print("Map ", pFilename, " contains a potentially harmful setting, ignored\n");
774 else if not (cvar_value_issafe(s))
775 print("Map ", pFilename, " contains a potentially harmful setting, ignored\n");
776 else if(matchacl(MAPINFO_SETTEMP_ACL_SYSTEM, t) <= 0)
777 print("Map ", pFilename, " contains a potentially harmful setting, ignored\n");
778 else if(matchacl(acl, t) <= 0)
779 print("Map ", pFilename, " contains a denied setting, ignored\n");
782 if(type == 0) // server set
784 dprint("Applying temporary setting ", t, " := ", s, "\n");
785 if(cvar("g_campaign"))
786 cvar_set(t, s); // this is a wrapper and is always temporary anyway; no need to backup old values then
792 dprint("Applying temporary client setting ", t, " := ", s, "\n");
793 MapInfo_Map_clientstuff = strcat(
794 MapInfo_Map_clientstuff, "cl_cmd settemp \"", t, "\" \"", s, "\"\n"
800 float MapInfo_isRedundant(string fn, string t)
802 // normalize file name
803 fn = strreplace("_", "-", fn);
805 // normalize visible title
806 t = strreplace(": ", "-", t);
807 t = strreplace(":", "-", t);
808 t = strreplace(" ", "-", t);
809 t = strreplace("_", "-", t);
810 t = strreplace("'", "-", t);
812 if(!strcasecmp(fn, t))
815 // we allow the visible title to have punctuation the file name does
816 // not, but not vice versa
817 t = strreplace("-", "", t);
819 if(!strcasecmp(fn, t))
825 // load info about a map by name into the MapInfo_Map_* globals
826 float MapInfo_Get_ByName_NoFallbacks(string pFilename, float pAllowGenerate, float pGametypeToSet)
834 acl = MAPINFO_SETTEMP_ACL_USER;
836 if(strstrofs(pFilename, "/", 0) >= 0)
838 print("Invalid character in map name, ignored\n");
842 if(pGametypeToSet == 0)
843 if(MapInfo_Cache_Retrieve(pFilename))
848 MapInfo_Map_bspname = pFilename;
850 // default all generic fields so they have "good" values in case something fails
851 fn = strcat("maps/", pFilename, ".mapinfo");
852 fh = fopen(fn, FILE_READ);
855 fn = strcat("maps/autogenerated/", pFilename, ".mapinfo");
856 fh = fopen(fn, FILE_READ);
861 _MapInfo_Map_Reset();
862 r = _MapInfo_Generate(pFilename);
865 fh = fopen(fn, FILE_WRITE);
866 fputs(fh, strcat("title ", MapInfo_Map_title, "\n"));
867 fputs(fh, strcat("description ", MapInfo_Map_description, "\n"));
868 fputs(fh, strcat("author ", MapInfo_Map_author, "\n"));
869 if(_MapInfo_Map_worldspawn_music != "")
872 substring(_MapInfo_Map_worldspawn_music, strlen(_MapInfo_Map_worldspawn_music) - 4, 4) == ".wav"
874 substring(_MapInfo_Map_worldspawn_music, strlen(_MapInfo_Map_worldspawn_music) - 4, 4) == ".ogg"
876 fputs(fh, strcat("cdtrack ", substring(_MapInfo_Map_worldspawn_music, 0, strlen(_MapInfo_Map_worldspawn_music) - 4), "\n"));
878 fputs(fh, strcat("cdtrack ", _MapInfo_Map_worldspawn_music, "\n"));
882 n = tokenize_console(cvar_string("g_cdtracks_remaplist"));
883 s = strcat(" ", cvar_string("g_cdtracks_dontusebydefault"), " ");
886 i = floor(random() * n);
887 if(strstrofs(s, strcat(" ", argv(i), " "), 0) < 0)
890 fputs(fh, strcat("cdtrack ", ftos(i + 1), "\n"));
892 if(MapInfo_Map_supportedFeatures & MAPINFO_FEATURE_WEAPONS)
893 fputs(fh, "has weapons\n");
895 fputs(fh, "// uncomment this if you added weapon pickups: has weapons\n");
896 if(MapInfo_Map_supportedFeatures & MAPINFO_FEATURE_TURRETS)
897 fputs(fh, "has turrets\n");
899 fputs(fh, "// uncomment this if you added turrets: has turrets\n");
900 if(MapInfo_Map_supportedFeatures & MAPINFO_FEATURE_VEHICLES)
901 fputs(fh, "has weapons\n");
903 fputs(fh, "// uncomment this if you added vehicles: has vehicles\n");
904 if(MapInfo_Map_flags & MAPINFO_FLAG_FRUSTRATING)
905 fputs(fh, "frustrating\n");
907 for(i = 1; i <= MapInfo_Map_supportedGametypes; i *= 2)
908 if(MapInfo_Map_supportedGametypes & i)
909 fputs(fh, sprintf("gametype %s // defaults: %s\n", MapInfo_Type_ToString(i), _MapInfo_GetDefaultEx(i)));
911 if(fexists(strcat("scripts/", pFilename, ".arena")))
912 fputs(fh, "settemp_for_type all sv_q3acompat_machineshotgunswap 1\n");
914 fputs(fh, "// optional: fog density red green blue alpha mindist maxdist\n");
915 fputs(fh, "// optional: settemp_for_type (all|gametypename) cvarname value\n");
916 fputs(fh, "// optional: clientsettemp_for_type (all|gametypename) cvarname value\n");
917 fputs(fh, "// optional: size mins_x mins_y mins_z maxs_x maxs_y maxs_z\n");
918 fputs(fh, "// optional: hidden\n");
923 fh = fopen(fn, FILE_READ);
925 error("... but I just wrote it!");
928 print("WARNING: autogenerated mapinfo file ", fn, " has been loaded; please edit that file and move it to maps/", pFilename, ".mapinfo\n");
931 _MapInfo_Map_Reset();
934 if not((s = fgets(fh)))
937 // catch different sorts of comments
938 if(s == "") // empty lines
940 if(substring(s, 0, 1) == "#") // UNIX style
942 if(substring(s, 0, 2) == "//") // C++ style
944 if(substring(s, 0, 1) == "_") // q3map style
947 p = strstrofs(s, "//", 0);
949 s = substring(s, 0, p);
951 t = car(s); s = cdr(s);
953 MapInfo_Map_title = s;
954 else if(t == "description")
955 MapInfo_Map_description = s;
956 else if(t == "author")
957 MapInfo_Map_author = s;
960 t = car(s); // s = cdr(s);
961 if (t == "weapons") MapInfo_Map_supportedFeatures |= MAPINFO_FEATURE_WEAPONS;
962 else if(t == "turrets") MapInfo_Map_supportedFeatures |= MAPINFO_FEATURE_TURRETS;
963 else if(t == "vehicles") MapInfo_Map_supportedFeatures |= MAPINFO_FEATURE_VEHICLES;
964 else if(t == "new_toys") MapInfo_Map_supportedFeatures |= MAPINFO_FEATURE_WEAPONS;
966 dprint("Map ", pFilename, " supports unknown feature ", t, ", ignored\n");
968 else if(t == "hidden")
970 MapInfo_Map_flags |= MAPINFO_FLAG_HIDDEN;
972 else if(t == "forbidden")
974 MapInfo_Map_flags |= MAPINFO_FLAG_FORBIDDEN;
976 else if(t == "frustrating")
978 MapInfo_Map_flags |= MAPINFO_FLAG_FRUSTRATING;
982 t = car(s); s = cdr(s);
983 f = MapInfo_Type_FromString(t);
984 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");
986 _MapInfo_Map_ApplyGametype (s, pGametypeToSet, f, TRUE);
988 dprint("Map ", pFilename, " supports unknown game type ", t, ", ignored\n");
990 else if(t == "gametype")
992 t = car(s); s = cdr(s);
993 f = MapInfo_Type_FromString(t);
995 _MapInfo_Map_ApplyGametypeEx (s, pGametypeToSet, f);
997 dprint("Map ", pFilename, " supports unknown game type ", t, ", ignored\n");
1001 float a, b, c, d, e;
1002 t = car(s); s = cdr(s); a = stof(t);
1003 t = car(s); s = cdr(s); b = stof(t);
1004 t = car(s); s = cdr(s); c = stof(t);
1005 t = car(s); s = cdr(s); d = stof(t);
1006 t = car(s); s = cdr(s); e = stof(t);
1008 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");
1011 t = car(s); s = cdr(s); f = stof(t);
1013 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");
1016 if(a >= d || b >= e || c >= f)
1017 print("Map ", pFilename, " contains an incorrect size line, mins have to be < maxs\n");
1020 MapInfo_Map_mins_x = a;
1021 MapInfo_Map_mins_y = b;
1022 MapInfo_Map_mins_z = c;
1023 MapInfo_Map_maxs_x = d;
1024 MapInfo_Map_maxs_y = e;
1025 MapInfo_Map_maxs_z = f;
1030 else if(t == "settemp_for_type")
1032 t = car(s); s = cdr(s);
1033 if((f = MapInfo_Type_FromString(t)))
1035 if(f & pGametypeToSet)
1037 _MapInfo_Parse_Settemp(pFilename, acl, 0, s, 1);
1042 dprint("Map ", pFilename, " has a setting for unknown game type ", t, ", ignored\n");
1045 else if(t == "clientsettemp_for_type")
1047 t = car(s); s = cdr(s);
1048 if((f = MapInfo_Type_FromString(t)))
1050 if(f & pGametypeToSet)
1052 _MapInfo_Parse_Settemp(pFilename, acl, 1, s, 1);
1057 dprint("Map ", pFilename, " has a client setting for unknown game type ", t, ", ignored\n");
1062 if not(cvar_value_issafe(t))
1063 print("Map ", pFilename, " contains a potentially harmful fog setting, ignored\n");
1065 MapInfo_Map_fog = s;
1067 else if(t == "cdtrack")
1071 if not(cvar_value_issafe(t))
1072 print("Map ", pFilename, " contains a potentially harmful cdtrack, ignored\n");
1074 MapInfo_Map_clientstuff = strcat(
1075 MapInfo_Map_clientstuff, "cd loop \"", s, "\"\n"
1080 dprint("Map ", pFilename, " provides unknown info item ", t, ", ignored\n");
1084 if(MapInfo_Map_title == "<TITLE>")
1085 MapInfo_Map_titlestring = MapInfo_Map_bspname;
1086 else if(MapInfo_isRedundant(MapInfo_Map_bspname, MapInfo_Map_title))
1087 MapInfo_Map_titlestring = MapInfo_Map_title;
1089 MapInfo_Map_titlestring = sprintf(_("%s: %s"), MapInfo_Map_bspname, MapInfo_Map_title);
1091 MapInfo_Cache_Store();
1092 if(MapInfo_Map_supportedGametypes != 0)
1094 dprint("Map ", pFilename, " supports no game types, ignored\n");
1097 float MapInfo_Get_ByName(string pFilename, float pAllowGenerate, float pGametypeToSet)
1099 float r = MapInfo_Get_ByName_NoFallbacks(pFilename, pAllowGenerate, pGametypeToSet);
1101 if(cvar("g_tdm_on_dm_maps"))
1103 // if this is set, all DM maps support TDM too
1104 if not(MapInfo_Map_supportedGametypes & MAPINFO_TYPE_TEAM_DEATHMATCH)
1105 if(MapInfo_Map_supportedGametypes & MAPINFO_TYPE_DEATHMATCH)
1106 _MapInfo_Map_ApplyGametypeEx ("", pGametypeToSet, MAPINFO_TYPE_TEAM_DEATHMATCH);
1111 if(!(MapInfo_Map_supportedGametypes & pGametypeToSet))
1113 error("Can't select the requested game type. This should never happen as the caller should prevent it!\n");
1114 //_MapInfo_Map_ApplyGametypeEx("", pGametypeToSet, MAPINFO_TYPE_DEATHMATCH);
1122 float MapInfo_FindName(string s)
1124 // if there is exactly one map of prefix s, return it
1125 // if not, return the null string
1126 // note that DP sorts glob results... so I can use a binary search
1130 // invariants: r is behind s, l-1 is equal or before
1133 m = floor((l + r) / 2);
1134 MapInfo_FindName_match = _MapInfo_GlobItem(MapInfo_FilterList_Lookup(m));
1135 cmp = strcasecmp(MapInfo_FindName_match, s);
1137 return m; // found and good
1139 l = m + 1; // l-1 is before s
1143 MapInfo_FindName_match = _MapInfo_GlobItem(MapInfo_FilterList_Lookup(l));
1144 MapInfo_FindName_firstResult = l;
1145 // r == l, so: l is behind s, l-1 is before
1146 // SO: if there is any, l is the one with the right prefix
1147 // and l+1 may be one too
1148 if(l == MapInfo_count)
1150 MapInfo_FindName_match = string_null;
1151 MapInfo_FindName_firstResult = -1;
1152 return -1; // no MapInfo_FindName_match, behind last item
1154 if(!startsWithNocase(MapInfo_FindName_match, s))
1156 MapInfo_FindName_match = string_null;
1157 MapInfo_FindName_firstResult = -1;
1158 return -1; // wrong prefix
1160 if(l == MapInfo_count - 1)
1161 return l; // last one, nothing can follow => unique
1162 if(startsWithNocase(_MapInfo_GlobItem(MapInfo_FilterList_Lookup(l + 1)), s))
1164 MapInfo_FindName_match = string_null;
1165 return -1; // ambigous MapInfo_FindName_match
1170 string MapInfo_FixName(string s)
1172 MapInfo_FindName(s);
1173 return MapInfo_FindName_match;
1176 float MapInfo_CurrentFeatures()
1180 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")))
1181 req |= MAPINFO_FEATURE_WEAPONS;
1185 float MapInfo_CurrentGametype()
1189 prev = cvar("gamecfg");
1190 for(e = MapInfo_Type_first; e; e = e.enemy)
1196 return MAPINFO_TYPE_DEATHMATCH;
1199 float _MapInfo_CheckMap(string s) // returns 0 if the map can't be played with the current settings, 1 otherwise
1201 if(!MapInfo_Get_ByName(s, 1, 0))
1203 if((MapInfo_Map_supportedGametypes & MapInfo_CurrentGametype()) == 0)
1205 if((MapInfo_Map_supportedFeatures & MapInfo_CurrentFeatures()) != MapInfo_CurrentFeatures())
1210 float MapInfo_CheckMap(string s) // returns 0 if the map can't be played with the current settings, 1 otherwise
1213 r = _MapInfo_CheckMap(s);
1214 MapInfo_ClearTemps();
1218 void MapInfo_SwitchGameType(float t)
1221 for(e = MapInfo_Type_first; e; e = e.enemy)
1222 cvar_set(e.netname, (t == e.items) ? "1" : "0");
1225 void MapInfo_LoadMap(string s, float reinit)
1227 MapInfo_Map_supportedGametypes = 0;
1228 // we shouldn't need this, as LoadMapSettings already fixes the gametype
1229 //if(!MapInfo_CheckMap(s))
1231 // print("EMERGENCY: can't play the selected map in the given game mode. Falling back to DM.\n");
1232 // MapInfo_SwitchGameType(MAPINFO_TYPE_DEATHMATCH);
1235 cvar_settemp_restore();
1237 localcmd(strcat("\nmap ", s, "\n"));
1239 localcmd(strcat("\nchangelevel ", s, "\n"));
1242 string MapInfo_ListAllowedMaps(float pRequiredFlags, float pForbiddenFlags)
1247 // to make absolutely sure:
1248 MapInfo_Enumerate();
1249 MapInfo_FilterGametype(MapInfo_CurrentGametype(), MapInfo_CurrentFeatures(), pRequiredFlags, pForbiddenFlags, 0);
1252 for(i = 0; i < MapInfo_count; ++i)
1253 out = strcat(out, " ", _MapInfo_GlobItem(MapInfo_FilterList_Lookup(i)));
1254 return substring(out, 1, strlen(out) - 1);
1257 string MapInfo_ListAllAllowedMaps(float pRequiredFlags, float pForbiddenFlags)
1262 // to make absolutely sure:
1263 MapInfo_Enumerate();
1264 MapInfo_FilterGametype(MAPINFO_TYPE_ALL, 0, pRequiredFlags, pForbiddenFlags, 0);
1267 for(i = 0; i < MapInfo_count; ++i)
1268 out = strcat(out, " ", _MapInfo_GlobItem(MapInfo_FilterList_Lookup(i)));
1270 MapInfo_FilterGametype(MapInfo_CurrentGametype(), MapInfo_CurrentFeatures(), pRequiredFlags, pForbiddenFlags, 0);
1272 return substring(out, 1, strlen(out) - 1);
1275 void MapInfo_LoadMapSettings_SaveGameType(float t)
1277 MapInfo_SwitchGameType(t);
1278 cvar_set("gamecfg", ftos(t));
1279 MapInfo_LoadedGametype = t;
1282 void MapInfo_LoadMapSettings(string s) // to be called from worldspawn
1286 t = MapInfo_CurrentGametype();
1287 MapInfo_LoadMapSettings_SaveGameType(t);
1289 if(!_MapInfo_CheckMap(s)) // with underscore, it keeps temps
1291 if(cvar("g_mapinfo_allow_unsupported_modes_and_let_stuff_break"))
1293 print("EMERGENCY: can't play the selected map in the given game mode. Working with only the override settings.\n");
1294 _MapInfo_Map_ApplyGametypeEx("", t, t);
1295 return; // do not call Get_ByName!
1298 if(MapInfo_Map_supportedGametypes == 0)
1300 print("Mapinfo system is not functional at all. Assuming deathmatch.\n");
1301 MapInfo_Map_supportedGametypes = MAPINFO_TYPE_DEATHMATCH;
1302 MapInfo_LoadMapSettings_SaveGameType(MAPINFO_TYPE_DEATHMATCH);
1303 _MapInfo_Map_ApplyGametypeEx("", MAPINFO_TYPE_DEATHMATCH, MAPINFO_TYPE_DEATHMATCH);
1304 return; // do not call Get_ByName!
1308 while(!(MapInfo_Map_supportedGametypes & 1))
1311 MapInfo_Map_supportedGametypes = floor(MapInfo_Map_supportedGametypes / 2);
1314 // t is now a supported mode!
1315 print("EMERGENCY: can't play the selected map in the given game mode. Falling back to a supported mode.\n");
1316 MapInfo_LoadMapSettings_SaveGameType(t);
1318 MapInfo_Get_ByName(s, 1, t);
1321 void MapInfo_ClearTemps()
1323 MapInfo_Map_bspname = string_null;
1324 MapInfo_Map_title = string_null;
1325 MapInfo_Map_titlestring = string_null;
1326 MapInfo_Map_description = string_null;
1327 MapInfo_Map_author = string_null;
1328 MapInfo_Map_clientstuff = string_null;
1329 MapInfo_Map_supportedGametypes = 0;
1330 MapInfo_Map_supportedFeatures = 0;
1333 void MapInfo_Shutdown()
1335 MapInfo_ClearTemps();
1336 MapInfo_Filter_Free();
1337 MapInfo_Cache_Destroy();
1338 if(_MapInfo_globopen)
1340 search_end(_MapInfo_globhandle);
1341 _MapInfo_globhandle = -1;
1342 _MapInfo_globopen = FALSE;
1346 float MapInfo_ForbiddenFlags()
1349 f = MAPINFO_FLAG_FORBIDDEN;
1352 if not(cvar("g_maplist_allow_hidden"))
1354 f |= MAPINFO_FLAG_HIDDEN;
1356 if not(cvar("g_maplist_allow_frustrating"))
1357 f |= MAPINFO_FLAG_FRUSTRATING;
1362 float MapInfo_RequiredFlags()
1367 if(cvar("g_maplist_allow_frustrating") > 1)
1368 f |= MAPINFO_FLAG_FRUSTRATING;