Merge branch 'master' into terencehill/ca_fixes
[xonotic/xonotic-data.pk3dir.git] / qcsrc / common / mapinfo.qh
1 float MAPINFO_TYPE_ALL;
2 entity MapInfo_Type_first;
3 entity MapInfo_Type_last;
4 .entity enemy; // internal next pointer
5
6 .float items; // game type ID
7 .string netname; // game type name as in cvar (with g_ prefix)
8 .string mdl; // game type short name
9 .string message; // human readable name
10 .string model2; // game type defaults
11
12 #define REGISTER_GAMETYPE(hname,sname,g_name,NAME,defaults) \
13         var float MAPINFO_TYPE_##NAME; \
14         var entity MapInfo_Type##g_name; \
15         void RegisterGametypes_##g_name() \
16         { \
17                 MAPINFO_TYPE_##NAME = MAPINFO_TYPE_ALL + 1; \
18                 MAPINFO_TYPE_ALL |= MAPINFO_TYPE_##NAME; \
19                 MapInfo_Type##g_name = spawn(); \
20                 MapInfo_Type##g_name.items = MAPINFO_TYPE_##NAME; \
21                 MapInfo_Type##g_name.netname = #g_name; \
22                 MapInfo_Type##g_name.mdl = #sname; \
23                 MapInfo_Type##g_name.message = hname; \
24                 MapInfo_Type##g_name.model2 = defaults; \
25                 if(!MapInfo_Type_first) \
26                         MapInfo_Type_first = MapInfo_Type##g_name; \
27                 if(MapInfo_Type_last) \
28                         MapInfo_Type_last.enemy = MapInfo_Type##g_name; \
29                 MapInfo_Type_last = MapInfo_Type##g_name; \
30         } \
31         ACCUMULATE_FUNCTION(RegisterGametypes, RegisterGametypes_##g_name)
32
33 #define IS_GAMETYPE(NAME) \
34         (MapInfo_LoadedGametype == MAPINFO_TYPE_##NAME)
35
36 REGISTER_GAMETYPE(_("Deathmatch"),dm,g_dm,DEATHMATCH,"timelimit=20 pointlimit=30 leadlimit=0");
37 #define g_dm IS_GAMETYPE(DEATHMATCH)
38
39 REGISTER_GAMETYPE(_("Last Man Standing"),lms,g_lms,LMS,"timelimit=20 lives=9 leadlimit=0");
40 #define g_lms IS_GAMETYPE(LMS)
41
42 REGISTER_GAMETYPE(_("Race"),rc,g_race,RACE,"timelimit=20 qualifying_timelimit=5 laplimit=7 teamlaplimit=15 leadlimit=0");
43 #define g_race IS_GAMETYPE(RACE)
44
45 REGISTER_GAMETYPE(_("Race CTS"),cts,g_cts,CTS,"timelimit=20 skill=-1");
46 #define g_cts IS_GAMETYPE(CTS)
47
48 REGISTER_GAMETYPE(_("Team Deathmatch"),tdm,g_tdm,TEAM_DEATHMATCH,"timelimit=20 pointlimit=50 teams=2 leadlimit=0");
49 #define g_tdm IS_GAMETYPE(TEAM_DEATHMATCH)
50
51 REGISTER_GAMETYPE(_("Capture the Flag"),ctf,g_ctf,CTF,"timelimit=20 caplimit=10 leadlimit=0");
52 #define g_ctf IS_GAMETYPE(CTF)
53
54 REGISTER_GAMETYPE(_("Clan Arena"),ca,g_ca,CA,"timelimit=20 pointlimit=10 teams=2 leadlimit=0");
55 #define g_ca IS_GAMETYPE(CA)
56
57 REGISTER_GAMETYPE(_("Domination"),dom,g_domination,DOMINATION,"timelimit=20 pointlimit=200 teams=2 leadlimit=0");
58 #define g_domination IS_GAMETYPE(DOMINATION)
59
60 REGISTER_GAMETYPE(_("Key Hunt"),kh,g_keyhunt,KEYHUNT,"timelimit=20 pointlimit=1000 teams=3 leadlimit=0");
61 #define g_keyhunt IS_GAMETYPE(KEYHUNT)
62
63 REGISTER_GAMETYPE(_("Assault"),as,g_assault,ASSAULT,"timelimit=20");
64 #define g_assault IS_GAMETYPE(ASSAULT)
65
66 REGISTER_GAMETYPE(_("Onslaught"),ons,g_onslaught,ONSLAUGHT,"timelimit=20");
67 #define g_onslaught IS_GAMETYPE(ONSLAUGHT)
68
69 REGISTER_GAMETYPE(_("Nexball"),nb,g_nexball,NEXBALL,"timelimit=20 pointlimit=5 leadlimit=0");
70 #define g_nexball IS_GAMETYPE(NEXBALL)
71
72 REGISTER_GAMETYPE(_("Freeze Tag"),ft,g_freezetag,FREEZETAG,"timelimit=20 pointlimit=10 teams=2 leadlimit=0");
73 #define g_freezetag IS_GAMETYPE(FREEZETAG)
74
75 REGISTER_GAMETYPE(_("Keepaway"),ka,g_keepaway,KEEPAWAY,"timelimit=20 pointlimit=30");
76 #define g_keepaway IS_GAMETYPE(KEEPAWAY)
77
78 REGISTER_GAMETYPE(_("Invasion"),inv,g_invasion,INVASION,"pointlimit=50 teams=0");
79 #define g_invasion IS_GAMETYPE(INVASION)
80
81 const float MAPINFO_FEATURE_WEAPONS       = 1; // not defined for minstagib-only maps
82 const float MAPINFO_FEATURE_VEHICLES      = 2;
83 const float MAPINFO_FEATURE_TURRETS       = 4;
84 const float MAPINFO_FEATURE_MONSTERS      = 8;
85
86 const float MAPINFO_FLAG_HIDDEN           = 1; // not in lsmaps/menu/vcall/etc., can just be changed to manually
87 const float MAPINFO_FLAG_FORBIDDEN        = 2; // don't even allow the map by a cvar setting that allows hidden maps
88 const float MAPINFO_FLAG_FRUSTRATING      = 4; // this map is near impossible to play, enable at your own risk
89 const float MAPINFO_FLAG_NOAUTOMAPLIST    = 8; // do not include when automatically building maplist (counts as hidden for maplist building purposes)
90
91 float MapInfo_count;
92
93 // info about a map that MapInfo loads
94 string MapInfo_Map_bspname;
95 string MapInfo_Map_title;
96 string MapInfo_Map_titlestring; // either bspname: title or just title, depending on whether bspname is redundant
97 string MapInfo_Map_description;
98 string MapInfo_Map_author;
99 string MapInfo_Map_clientstuff; // not in cache, only for map load
100 string MapInfo_Map_fog; // not in cache, only for map load
101 float MapInfo_Map_supportedGametypes;
102 float MapInfo_Map_supportedFeatures;
103 float MapInfo_Map_flags;
104 vector MapInfo_Map_mins; // these are '0 0 0' if not supported!
105 vector MapInfo_Map_maxs; // these are '0 0 0' if not specified!
106
107 // load MapInfo_count; generate mapinfo for maps that miss them, and clear the
108 // cache; you need to call MapInfo_FilterGametype afterwards!
109 void MapInfo_Enumerate();
110
111 // filter the info by game type mask (updates MapInfo_count)
112 float MapInfo_progress;
113 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)
114 float MapInfo_CurrentFeatures(); // retrieves currently required features from cvars
115 float MapInfo_CurrentGametype(); // retrieves current gametype from cvars
116 float MapInfo_ForbiddenFlags(); // retrieves current flags from cvars
117 float MapInfo_RequiredFlags(); // retrieves current flags from cvars
118
119 // load info about the i-th map into the MapInfo_Map_* globals
120 float MapInfo_Get_ByID(float i); // 1 on success, 0 on failure
121 string MapInfo_BSPName_ByID(float i);
122
123 // load info about a map by name into the MapInfo_Map_* globals
124 float MapInfo_Get_ByName(string s, float allowGenerate, float gametypeToSet); // 1 on success, 0 on failure, 2 if it autogenerated a mapinfo file
125
126 // look for a map by a prefix, returns the actual map name on success, string_null on failure or ambigous match
127 string MapInfo_FindName_match; // the name of the map that was found
128 float MapInfo_FindName_firstResult; // -1 if none were found, index of first one if not unique but found (FindName then returns -1)
129 float MapInfo_FindName(string s);
130 string MapInfo_FixName(string s);
131
132 // play a map
133 float MapInfo_CheckMap(string s); // returns 0 if the map can't be played with the current settings
134 void MapInfo_LoadMap(string s, float reinit);
135
136 // list all maps for the current game type
137 string MapInfo_ListAllowedMaps(float pFlagsRequired, float pFlagsForbidden);
138 // list all allowed maps (for any game type)
139 string MapInfo_ListAllAllowedMaps(float pFlagsRequired, float pFlagsForbidden);
140
141 // gets a gametype from a string
142 string _MapInfo_GetDefaultEx(float t);
143 float MapInfo_Type_FromString(string t);
144 string MapInfo_Type_ToString(float t);
145 string MapInfo_Type_ToText(float t);
146 void MapInfo_SwitchGameType(float t);
147
148 // to be called from worldspawn to set up cvars
149 void MapInfo_LoadMapSettings(string s);
150 float MapInfo_LoadedGametype; // game type that was active during map load
151
152 void MapInfo_Cache_Destroy(); // disable caching
153 void MapInfo_Cache_Create(); // enable caching
154 void MapInfo_Cache_Invalidate(); // delete cache if any, but keep enabled
155
156 void MapInfo_ClearTemps(); // call this when done with mapinfo for this frame
157
158 void MapInfo_Shutdown(); // call this in the shutdown handler
159
160 #define MAPINFO_SETTEMP_ACL_USER cvar_string("g_mapinfo_settemp_acl")
161 #define MAPINFO_SETTEMP_ACL_SYSTEM "-g_mapinfo_* -rcon_* -_* -g_ban* +*"