]> git.xonotic.org Git - xonotic/xonotic-data.pk3dir.git/blob - qcsrc/server/mutators/base.qh
Merge remote-tracking branch 'origin/master' into Mario/lms_updates
[xonotic/xonotic-data.pk3dir.git] / qcsrc / server / mutators / base.qh
1 #define CBC_ORDER_EXCLUSIVE 3
2 #define CBC_ORDER_FIRST 1
3 #define CBC_ORDER_LAST 2
4 #define CBC_ORDER_ANY 4
5
6 float CallbackChain_ReturnValue; // read-only field of the current return value
7
8 entity CallbackChain_New(string name);
9 float CallbackChain_Add(entity cb, float() func, float order);
10 float CallbackChain_Remove(entity cb, float() func);
11 // a callback function is like this:
12 // float mycallback(entity me)
13 // {
14 //   do something
15 //   return r;
16 // }
17 float CallbackChain_Call(entity cb);
18
19 #define MUTATOR_REMOVING 0
20 #define MUTATOR_ADDING 1
21 #define MUTATOR_ROLLING_BACK 2
22 typedef float(float) mutatorfunc_t;
23 float Mutator_Add(mutatorfunc_t func, string name);
24 void Mutator_Remove(mutatorfunc_t func, string name); // calls error() on fail
25
26 #define MUTATOR_ADD(name) Mutator_Add(MUTATOR_##name, #name)
27 #define MUTATOR_REMOVE(name) Mutator_Remove(MUTATOR_##name, #name)
28 #define MUTATOR_DEFINITION(name) float MUTATOR_##name(float mode)
29 #define MUTATOR_DECLARATION(name) float MUTATOR_##name(float mode)
30 #define MUTATOR_HOOKFUNCTION(name) float HOOKFUNCTION_##name()
31 #define MUTATOR_HOOK(cb,func,order) do { if(mode == MUTATOR_ADDING) { if(!HOOK_##cb) HOOK_##cb = CallbackChain_New(#cb); if(!CallbackChain_Add(HOOK_##cb,HOOKFUNCTION_##func,order)) { print("HOOK FAILED: ", #func, "\n"); return 1; } } else if(mode == MUTATOR_REMOVING || mode == MUTATOR_ROLLING_BACK) { if(HOOK_##cb) CallbackChain_Remove(HOOK_##cb,HOOKFUNCTION_##func); } } while(0)
32 #define MUTATOR_ONADD if(mode == MUTATOR_ADDING)
33 #define MUTATOR_ONREMOVE if(mode == MUTATOR_REMOVING)
34 #define MUTATOR_ONROLLBACK_OR_REMOVE if(mode == MUTATOR_REMOVING || mode == MUTATOR_ROLLING_BACK)
35
36 #define MUTATOR_HOOKABLE(cb) entity HOOK_##cb
37 #define MUTATOR_CALLHOOK(cb) CallbackChain_Call(HOOK_##cb)
38
39 #define MUTATOR_RETURNVALUE CallbackChain_ReturnValue
40
41
42
43
44 // register all possible hooks here
45
46 MUTATOR_HOOKABLE(MakePlayerObserver);
47         // called when a player becomes observer, after shared setup
48
49 MUTATOR_HOOKABLE(PutClientInServer);
50         entity self; // client wanting to spawn
51
52 MUTATOR_HOOKABLE(PlayerSpawn);
53         entity spawn_spot; // spot that was used, or world
54         // called when a player spawns as player, after shared setup, before his weapon is chosen (so items may be changed in here)
55
56 MUTATOR_HOOKABLE(reset_map_global);
57         // called in reset_map
58
59 MUTATOR_HOOKABLE(reset_map_players);
60         // called in reset_map
61
62 MUTATOR_HOOKABLE(ForbidPlayerScore_Clear);
63         // returns 1 if clearing player score shall not be allowed
64
65 MUTATOR_HOOKABLE(ClientDisconnect);
66         // called when a player disconnects
67
68 MUTATOR_HOOKABLE(PlayerDies);
69         // called when a player dies to e.g. remove stuff he was carrying.
70         // INPUT:
71                 entity frag_inflictor;
72                 entity frag_attacker;
73                 entity frag_target; // same as self
74                 float frag_deathtype;
75
76 MUTATOR_HOOKABLE(GiveFragsForKill);
77         // called when someone was fragged by "self", and is expected to change frag_score to adjust scoring for the kill
78         // INPUT:
79                 entity frag_attacker; // same as self
80                 entity frag_target;
81         // INPUT, OUTPUT:
82                 float frag_score;
83
84 MUTATOR_HOOKABLE(MatchEnd);
85         // called when the match ends
86
87 MUTATOR_HOOKABLE(GetTeamCount);
88         // should adjust ret_float to contain the team count
89         // INPUT, OUTPUT:
90                 float ret_float;
91
92 MUTATOR_HOOKABLE(SpectateCopy);
93         // copies variables for spectating "other" to "self"
94         // INPUT:
95                 entity other;
96
97 MUTATOR_HOOKABLE(ForbidThrowCurrentWeapon);
98         // returns 1 if throwing the current weapon shall not be allowed
99
100 MUTATOR_HOOKABLE(SetStartItems);
101         // adjusts {warmup_}start_{items,weapons,ammo_{cells,rockets,nails,shells,fuel}}
102
103 MUTATOR_HOOKABLE(BuildMutatorsString);
104         // appends ":mutatorname" to ret_string for logging
105         // INPUT, OUTPUT:
106                 string ret_string;
107
108 MUTATOR_HOOKABLE(BuildMutatorsPrettyString);
109         // appends ", Mutator name" to ret_string for display
110         // INPUT, OUTPUT:
111                 string ret_string;
112
113 MUTATOR_HOOKABLE(FilterItem);
114         // checks if the current item may be spawned (self.items and self.weapons may be read and written to, as well as the ammo_ fields)
115         // return error to request removal
116
117 MUTATOR_HOOKABLE(TurretSpawn);
118         // return error to request removal
119         // INPUT: self - turret
120         
121 MUTATOR_HOOKABLE(OnEntityPreSpawn);
122         // return error to prevent entity spawn, or modify the entity
123
124 MUTATOR_HOOKABLE(PlayerPreThink);
125         // runs in the event loop for players; is called for ALL player entities, also bots, also the dead, or spectators
126
127 MUTATOR_HOOKABLE(GetPressedKeys);
128         // TODO change this into a general PlayerPostThink hook?
129
130 MUTATOR_HOOKABLE(PlayerPhysics);
131         // called before any player physics, may adjust variables for movement,
132         // is run AFTER bot code and idle checking
133
134 MUTATOR_HOOKABLE(GetCvars);
135         // is meant to call GetCvars_handle*(get_cvars_s, get_cvars_f, cvarfield, "cvarname") for cvars this mutator needs from the client
136         // INPUT:
137                 float get_cvars_f;
138                 string get_cvars_s;
139
140 MUTATOR_HOOKABLE(EditProjectile);
141         // can edit any "just fired" projectile
142         // INPUT:
143                 entity self;
144                 entity other;
145
146 MUTATOR_HOOKABLE(PlayerDamage_SplitHealthArmor);
147         // called when a player gets damaged to e.g. remove stuff he was carrying.
148         // INPUT:
149                 entity frag_inflictor;
150                 entity frag_attacker;
151                 entity frag_target; // same as self
152                 vector damage_force; // NOTE: this force already HAS been applied
153         // INPUT, OUTPUT:
154                 float damage_take;
155                 float damage_save;
156                 
157 MUTATOR_HOOKABLE(PlayerDamage_Calculate);
158         // called to adjust damage and force values which are applied to the player, used for e.g. strength damage/force multiplier
159         // i'm not sure if I should change this around slightly (Naming of the entities, and also how they're done in g_damage).
160         // INPUT:
161                 entity frag_attacker;
162                 entity frag_target;
163                 float frag_deathtype;
164         // INPUT, OUTPUT:
165                 float frag_damage;
166                 vector frag_force;
167
168 MUTATOR_HOOKABLE(PlayerPowerups);
169         // called at the end of player_powerups() in cl_client.qc, used for manipulating the values which are set by powerup items.
170         // INPUT
171         entity self;
172         float olditems; // also technically output, but since it is at the end of the function it's useless for that :P 
173
174 MUTATOR_HOOKABLE(PlayerUseKey);
175         // called when the use key is pressed
176         // if MUTATOR_RETURNVALUE is 1, don't do anything
177         // return 1 if the use key actually did something
178
179 MUTATOR_HOOKABLE(SV_ParseClientCommand);
180         // called when a client command is parsed
181         // NOTE: hooks MUST start with if(MUTATOR_RETURNVALUE) return 0;
182         // NOTE: return 1 if you handled the command, return 0 to continue handling
183         // NOTE: THESE HOOKS MUST NEVER EVER CALL tokenize()
184         // INPUT
185         string cmd_name; // command name
186         float cmd_argc; // also, argv() can be used
187         string cmd_string; // whole command, use only if you really have to
188         /*
189                 // example:
190                 MUTATOR_HOOKFUNCTION(foo_SV_ParseClientCommand)
191                 {
192                         if(MUTATOR_RETURNVALUE) // command was already handled?
193                                 return 0;
194                         if(cmd_name == "echocvar" && cmd_argc >= 2)
195                         {
196                                 print(cvar_string(argv(1)), "\n");
197                                 return 1;
198                         }
199                         if(cmd_name == "echostring" && cmd_argc >= 2)
200                         {
201                                 print(substring(cmd_string, argv_start_index(1), argv_end_index(-1) - argv_start_index(1)), "\n");
202                                 return 1;
203                         }
204                         return 0;
205                 }
206         */
207
208 MUTATOR_HOOKABLE(Spawn_Score);
209         // called when a spawnpoint is being evaluated
210         // return 1 to make the spawnpoint unusable
211         // INPUT
212         entity self; // player wanting to spawn
213         entity spawn_spot; // spot to be evaluated
214         // IN+OUT
215         vector spawn_score; // _x is priority, _y is "distance"
216
217 MUTATOR_HOOKABLE(SV_StartFrame);
218         // runs globally each server frame
219
220 MUTATOR_HOOKABLE(SetModname);
221         // OUT
222         string modname; // name of the mutator/mod if it warrants showing as such in the server browser
223         
224 MUTATOR_HOOKABLE(Item_Spawn);
225         // called for each item being spawned on a map, including dropped weapons
226         // return 1 to remove an item
227         // INPUT
228         entity self; // the item
229
230 MUTATOR_HOOKABLE(SetWeaponreplace);
231         // IN
232                 entity self; // map entity
233                 entity other; // weapon info
234         // IN+OUT
235                 string ret_string;
236
237 MUTATOR_HOOKABLE(PortalTeleport);
238         // called whenever a player goes through a portal gun teleport
239         // allows you to strip a player of an item if they go through the teleporter to help prevent cheating
240         // INPUT
241         entity self;
242         
243 MUTATOR_HOOKABLE(HelpMePing);
244         // called whenever a player uses impulse 33 (help me) in cl_impulse.qc
245         // normally help me ping uses self.waypointsprite_attachedforcarrier,
246         // but if your mutator uses something different then you can handle it
247         // in a special manner using this hook
248         // INPUT
249         entity self; // the player who pressed impulse 33
250         
251 MUTATOR_HOOKABLE(VehicleEnter);
252         // called when a player enters a vehicle
253         // allows mutators to set special settings in this event
254         // INPUT
255         entity vh_player; // player
256         entity vh_vehicle; // vehicle
257         
258 MUTATOR_HOOKABLE(VehicleExit);
259         // called when a player exits a vehicle
260         // allows mutators to set special settings in this event
261         // INPUT
262         entity vh_player; // player
263         entity vh_vehicle; // vehicle
264         
265 MUTATOR_HOOKABLE(AbortSpeedrun);
266         // called when a speedrun is aborted and the player is teleported back to start position
267         // INPUT
268         entity self; // player
269
270 MUTATOR_HOOKABLE(ItemTouch);
271         // called at when a item is touched. Called early, can edit item properties.
272         entity self;    // item
273         entity other;   // player
274
275 MUTATOR_HOOKABLE(ClientConnect);
276         // called at when a player connect
277         entity self;    // player
278
279 MUTATOR_HOOKABLE(HavocBot_ChooseRule);
280         entity self;