particles: volume weighting = negative count, absolute weighting = positive count
[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_ALL              = 65535; // this has to include all above bits
13
14 float MAPINFO_FEATURE_WEAPONS       = 1; // not defined for minstagib-only maps
15
16 float MapInfo_count;
17
18 // info about a map that MapInfo loads
19 string MapInfo_Map_bspname;
20 string MapInfo_Map_title;
21 string MapInfo_Map_description;
22 string MapInfo_Map_author;
23 string MapInfo_Map_clientstuff;
24 float MapInfo_Map_supportedGametypes;
25 float MapInfo_Map_supportedFeatures;
26
27 // load MapInfo_count; generate mapinfo for maps that miss them, and clear the
28 // cache; you need to call MapInfo_FilterGametype afterwards!
29 void MapInfo_Enumerate();
30
31 // filter the info by game type mask (updates MapInfo_count)
32 float MapInfo_progress;
33 float MapInfo_FilterGametype(float gametype, float features, float pAbortOnGenerate); // 1 on success, 0 on temporary failure (call it again next frame then; use MapInfo_progress as progress indicator)
34 float MapInfo_CurrentFeatures(); // retrieves currently required features from cvars
35 float MapInfo_CurrentGametype(); // retrieves current gametype from cvars
36
37 // load info about the i-th map into the MapInfo_Map_* globals
38 float MapInfo_Get_ByID(float i); // 1 on success, 0 on failure
39 string MapInfo_BSPName_ByID(float i);
40
41 // load info about a map by name into the MapInfo_Map_* globals
42 float MapInfo_Get_ByName(string s, float allowGenerate, float gametypeToSet); // 1 on success, 0 on failure, 2 if it autogenerated a mapinfo file
43
44 // look for a map by a prefix, returns the actual map name on success, string_null on failure or ambigous match
45 string MapInfo_FindName_match; // the name of the map that was found
46 float MapInfo_FindName_firstResult; // -1 if none were found, index of first one if not unique but found (FindName then returns -1)
47 float MapInfo_FindName(string s);
48 string MapInfo_FixName(string s);
49
50 // play a map
51 float MapInfo_CheckMap(string s); // returns 0 if the map can't be played with the current settings
52 void MapInfo_LoadMap(string s);
53
54 // list all maps for the current game type
55 string MapInfo_ListAllowedMaps();
56
57 // gets a gametype from a string
58 float MapInfo_Type_FromString(string t);
59 void MapInfo_SwitchGameType(float t);
60
61 // to be called from worldspawn to set up cvars
62 void MapInfo_LoadMapSettings(string s);
63
64 void MapInfo_Cache_Destroy(); // disable caching
65 void MapInfo_Cache_Create(); // enable caching
66 void MapInfo_Cache_Invalidate(); // delete cache if any, but keep enabled
67
68 void MapInfo_ClearTemps(); // call this when done with mapinfo for this frame
69
70 void MapInfo_Shutdown(); // call this in the shutdown handler