4de17c92430cfe20f2b0173b6113a20c5e748b09
[xonotic/xonotic-data.pk3dir.git] / qcsrc / common / mapinfo.qh
1 float MAPINFO_TYPE_DEATHMATCH           = 1;
2 float MAPINFO_TYPE_LMS                  = 2;
3 float MAPINFO_TYPE_ARENA                = 4;
4 float MAPINFO_TYPE_RUNEMATCH            = 8;
5 float MAPINFO_TYPE_RACE                 = 16;
6 float MAPINFO_TYPE_CTS                  = 32;
7 float MAPINFO_TYPE_TEAM_DEATHMATCH      = 64;
8 float MAPINFO_TYPE_CTF                  = 128;
9 float MAPINFO_TYPE_CA                   = 256;
10 float MAPINFO_TYPE_DOMINATION           = 512;
11 float MAPINFO_TYPE_KEYHUNT              = 1024;
12 float MAPINFO_TYPE_ASSAULT              = 2048;
13 float MAPINFO_TYPE_ONSLAUGHT            = 4096;
14 float MAPINFO_TYPE_NEXBALL              = 8192;
15 float MAPINFO_TYPE_FREEZETAG            = 16384;
16 float MAPINFO_TYPE_KEEPAWAY     = 32768;
17 float MAPINFO_TYPE_ALL                  = 65535; // this has to include all above bits
18
19 float MAPINFO_FEATURE_WEAPONS       = 1; // not defined for minstagib-only maps
20 float MAPINFO_FEATURE_VEHICLES      = 2;
21 float MAPINFO_FEATURE_TURRETS       = 4;
22
23 float MAPINFO_FLAG_HIDDEN           = 1; // not in lsmaps/menu/vcall/etc., can just be changed to manually
24 float MAPINFO_FLAG_FORBIDDEN        = 2; // don't even allow the map by a cvar setting that allows hidden maps
25 float MAPINFO_FLAG_FRUSTRATING      = 4; // this map is near impossible to play, enable at your own risk
26
27 float MapInfo_count;
28
29 // info about a map that MapInfo loads
30 string MapInfo_Map_bspname;
31 string MapInfo_Map_title;
32 string MapInfo_Map_titlestring; // either bspname: title or just title, depending on whether bspname is redundant
33 string MapInfo_Map_description;
34 string MapInfo_Map_author;
35 string MapInfo_Map_clientstuff; // not in cache, only for map load
36 string MapInfo_Map_fog; // not in cache, only for map load
37 float MapInfo_Map_supportedGametypes;
38 float MapInfo_Map_supportedFeatures;
39 float MapInfo_Map_flags;
40 vector MapInfo_Map_mins; // these are '0 0 0' if not supported!
41 vector MapInfo_Map_maxs; // these are '0 0 0' if not specified!
42
43 // load MapInfo_count; generate mapinfo for maps that miss them, and clear the
44 // cache; you need to call MapInfo_FilterGametype afterwards!
45 void MapInfo_Enumerate();
46
47 // filter the info by game type mask (updates MapInfo_count)
48 float MapInfo_progress;
49 float MapInfo_FilterGametype(float gametype, float features, float pFlagsRequired, float pFlagsForbidden, float pAbortOnGenerate); // 1 on success, 0 on temporary failure (call it again next frame then; use MapInfo_progress as progress indicator)
50 float MapInfo_CurrentFeatures(); // retrieves currently required features from cvars
51 float MapInfo_CurrentGametype(); // retrieves current gametype from cvars
52 float MapInfo_ForbiddenFlags(); // retrieves current flags from cvars
53 float MapInfo_RequiredFlags(); // retrieves current flags from cvars
54
55 // load info about the i-th map into the MapInfo_Map_* globals
56 float MapInfo_Get_ByID(float i); // 1 on success, 0 on failure
57 string MapInfo_BSPName_ByID(float i);
58
59 // load info about a map by name into the MapInfo_Map_* globals
60 float MapInfo_Get_ByName(string s, float allowGenerate, float gametypeToSet); // 1 on success, 0 on failure, 2 if it autogenerated a mapinfo file
61
62 // look for a map by a prefix, returns the actual map name on success, string_null on failure or ambigous match
63 string MapInfo_FindName_match; // the name of the map that was found
64 float MapInfo_FindName_firstResult; // -1 if none were found, index of first one if not unique but found (FindName then returns -1)
65 float MapInfo_FindName(string s);
66 string MapInfo_FixName(string s);
67
68 // play a map
69 float MapInfo_CheckMap(string s); // returns 0 if the map can't be played with the current settings
70 void MapInfo_LoadMap(string s, float reinit);
71
72 // list all maps for the current game type
73 string MapInfo_ListAllowedMaps(float pFlagsRequired, float pFlagsForbidden);
74 // list all allowed maps (for any game type)
75 string MapInfo_ListAllAllowedMaps(float pFlagsRequired, float pFlagsForbidden);
76
77 // gets a gametype from a string
78 float MapInfo_Type_FromString(string t);
79 string MapInfo_Type_ToString(float t);
80 string MapInfo_GetGameTypeCvar(float t);
81 void MapInfo_SwitchGameType(float t);
82
83 // to be called from worldspawn to set up cvars
84 void MapInfo_LoadMapSettings(string s);
85
86 void MapInfo_Cache_Destroy(); // disable caching
87 void MapInfo_Cache_Create(); // enable caching
88 void MapInfo_Cache_Invalidate(); // delete cache if any, but keep enabled
89
90 void MapInfo_ClearTemps(); // call this when done with mapinfo for this frame
91
92 void MapInfo_Shutdown(); // call this in the shutdown handler
93
94 #define MAPINFO_SETTEMP_ACL_USER cvar_string("g_mapinfo_settemp_acl")
95 #define MAPINFO_SETTEMP_ACL_SYSTEM "-g_mapinfo_* -rcon_* -settemp_* -_* -g_ban* +*"