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