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