1 #ifndef MUTATORS_BASE_H
2 #define MUTATORS_BASE_H
3 const int CBC_ORDER_FIRST = 1;
4 const int CBC_ORDER_LAST = 2;
5 const int CBC_ORDER_EXCLUSIVE = 3;
6 const int CBC_ORDER_ANY = 4;
8 bool CallbackChain_ReturnValue; // read-only field of the current return value
10 entity CallbackChain_New(string name);
11 bool CallbackChain_Add(entity cb, bool() func, int order);
12 int CallbackChain_Remove(entity cb, bool() func);
13 // a callback function is like this:
14 // bool mycallback(entity me)
19 bool CallbackChain_Call(entity cb);
26 typedef bool(int) mutatorfunc_t;
27 bool Mutator_Add(mutatorfunc_t func, string name);
28 void Mutator_Remove(mutatorfunc_t func, string name); // calls error() on fail
30 #define MUTATOR_ADD(name) Mutator_Add(MUTATOR_##name, #name)
31 #define MUTATOR_REMOVE(name) Mutator_Remove(MUTATOR_##name, #name)
32 #define MUTATOR_DEFINITION(name) bool MUTATOR_##name(int mode)
33 #define MUTATOR_DECLARATION(name) bool MUTATOR_##name(int mode)
34 #define MUTATOR_HOOKFUNCTION(name) bool HOOKFUNCTION_##name()
35 #define MUTATOR_HOOK(cb, func, order) do { \
37 if (!HOOK_##cb) HOOK_##cb = CallbackChain_New(#cb); \
38 if (!CallbackChain_Add(HOOK_##cb, HOOKFUNCTION_##func, order)) { \
39 print("HOOK FAILED: ", #func, "\n"); \
43 MUTATOR_ONROLLBACK_OR_REMOVE { \
44 if (HOOK_##cb) CallbackChain_Remove(HOOK_##cb, HOOKFUNCTION_##func); \
47 #define MUTATOR_ONADD if (mode == MUTATOR_ADDING)
48 #define MUTATOR_ONREMOVE if (mode == MUTATOR_REMOVING)
49 #define MUTATOR_ONROLLBACK_OR_REMOVE if (mode == MUTATOR_REMOVING || mode == MUTATOR_ROLLING_BACK)
51 #define _MUTATOR_HOOKABLE(id, ...) entity HOOK_##id; bool __Mutator_Send_##id(__VA_ARGS__)
52 #define MUTATOR_CALLHOOK(id, ...) APPLY(__Mutator_Send_##id, 0, ##__VA_ARGS__)
54 #define MUTATOR_RETURNVALUE CallbackChain_ReturnValue
56 #define HANDLE_NOP(type, id)
57 #define HANDLE_PARAMS(type, id) , type in_##id
58 #define HANDLE_PREPARE(type, id) id = in_##id;
59 #define HANDLE_PUSHTMP(type, id) type tmp_##id = id;
60 #define HANDLE_PUSHOUT(type, id) type out_##id = id;
61 #define HANDLE_POPTMP(type, id) id = tmp_##id;
62 #define HANDLE_POPOUT(type, id) id = out_##id;
64 #define MUTATOR_HOOKABLE(id, params) \
65 _MUTATOR_HOOKABLE(id, int params(HANDLE_PARAMS, HANDLE_NOP)) { \
66 params(HANDLE_PUSHTMP, HANDLE_NOP) \
67 params(HANDLE_PREPARE, HANDLE_NOP) \
68 bool ret = CallbackChain_Call(HOOK_##id); \
69 params(HANDLE_NOP, HANDLE_PUSHOUT) \
70 params(HANDLE_POPTMP, HANDLE_NOP) \
71 params(HANDLE_NOP, HANDLE_POPOUT) \
77 // register all possible hooks here
78 // some parameters are commented to avoid duplicate declarations
80 #define EV_NO_ARGS(i, o)
82 /** called when a player becomes observer, after shared setup */
83 #define EV_MakePlayerObserver(i, o) \
85 MUTATOR_HOOKABLE(MakePlayerObserver, EV_MakePlayerObserver)
88 #define EV_PutClientInServer(i, o) \
89 /** client wanting to spawn */ i(entity, self) \
91 MUTATOR_HOOKABLE(PutClientInServer, EV_PutClientInServer);
93 /** called when a player spawns as player, after shared setup, before his weapon is chosen (so items may be changed in here) */
94 #define EV_PlayerSpawn(i, o) \
95 /** spot that was used, or world */ i(entity, spawn_spot) \
98 MUTATOR_HOOKABLE(PlayerSpawn, EV_PlayerSpawn);
100 /** called in reset_map */
101 #define EV_reset_map_global(i, o) \
103 MUTATOR_HOOKABLE(reset_map_global, EV_reset_map_global);
105 /** called in reset_map */
106 #define EV_reset_map_players(i, o) \
108 MUTATOR_HOOKABLE(reset_map_players, EV_reset_map_players);
110 /** returns 1 if clearing player score shall not be allowed */
111 #define EV_ForbidPlayerScore_Clear(i, o) \
113 MUTATOR_HOOKABLE(ForbidPlayerScore_Clear, EV_ForbidPlayerScore_Clear);
115 /** called when a player disconnects */
116 #define EV_ClientDisconnect(i, o) \
118 MUTATOR_HOOKABLE(ClientDisconnect, EV_ClientDisconnect);
120 /** called when a player dies to e.g. remove stuff he was carrying. */
121 #define EV_PlayerDies(i, o) \
122 /**/ i(entity, frag_inflictor) \
123 /**/ i(entity, frag_attacker) \
124 /** same as self */ i(entity, frag_target) \
125 /**/ i(int, frag_deathtype) \
127 entity frag_inflictor;
128 entity frag_attacker;
131 MUTATOR_HOOKABLE(PlayerDies, EV_PlayerDies);
133 /** called when a player presses the jump key */
134 #define EV_PlayerJump(i, o) \
135 /**/ i(float, player_multijump) \
136 /**/ i(float, player_jumpheight) \
137 /**/ o(float, player_multijump) \
138 /**/ o(float, player_jumpheight) \
140 float player_multijump;
141 float player_jumpheight;
142 MUTATOR_HOOKABLE(PlayerJump, EV_PlayerJump);
144 /** called when someone was fragged by "self", and is expected to change frag_score to adjust scoring for the kill */
145 #define EV_GiveFragsForKill(i, o) \
146 /** same as self */ i(entity, frag_attacker) \
147 /**/ i(entity, frag_target) \
148 /**/ i(float, frag_score) \
149 /**/ o(float, frag_score) \
152 MUTATOR_HOOKABLE(GiveFragsForKill, EV_GiveFragsForKill);
154 MUTATOR_HOOKABLE(MatchEnd, EV_NO_ARGS);
155 // called when the match ends
157 MUTATOR_HOOKABLE(GetTeamCount, EV_NO_ARGS);
158 // should adjust ret_float to contain the team count
162 MUTATOR_HOOKABLE(SpectateCopy, EV_NO_ARGS);
163 // copies variables for spectating "other" to "self"
167 MUTATOR_HOOKABLE(ForbidThrowCurrentWeapon, EV_NO_ARGS);
168 // returns 1 if throwing the current weapon shall not be allowed
170 MUTATOR_HOOKABLE(WeaponRateFactor, EV_NO_ARGS);
171 // allows changing attack rate
175 MUTATOR_HOOKABLE(WeaponSpeedFactor, EV_NO_ARGS);
176 // allows changing weapon speed (projectiles mostly)
180 MUTATOR_HOOKABLE(SetStartItems, EV_NO_ARGS);
181 // adjusts {warmup_}start_{items,weapons,ammo_{cells,plasma,rockets,nails,shells,fuel}}
183 MUTATOR_HOOKABLE(BuildMutatorsString, EV_NO_ARGS);
184 // appends ":mutatorname" to ret_string for logging
188 MUTATOR_HOOKABLE(BuildMutatorsPrettyString, EV_NO_ARGS);
189 // appends ", Mutator name" to ret_string for display
191 // string ret_string;
193 MUTATOR_HOOKABLE(CustomizeWaypoint, EV_NO_ARGS);
194 // called every frame
195 // customizes the waypoint for spectators
196 // INPUT: self = waypoint, other = player, other.enemy = spectator
198 MUTATOR_HOOKABLE(FilterItem, EV_NO_ARGS);
199 // 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)
200 // return error to request removal
202 MUTATOR_HOOKABLE(TurretSpawn, EV_NO_ARGS);
203 // return error to request removal
204 // INPUT: self - turret
206 MUTATOR_HOOKABLE(OnEntityPreSpawn, EV_NO_ARGS);
207 // return error to prevent entity spawn, or modify the entity
209 MUTATOR_HOOKABLE(PlayerPreThink, EV_NO_ARGS);
210 // runs in the event loop for players; is called for ALL player entities, also bots, also the dead, or spectators
212 MUTATOR_HOOKABLE(GetPressedKeys, EV_NO_ARGS);
213 // TODO change this into a general PlayerPostThink hook?
215 MUTATOR_HOOKABLE(PlayerPhysics, EV_NO_ARGS);
216 // called before any player physics, may adjust variables for movement,
217 // is run AFTER bot code and idle checking
219 MUTATOR_HOOKABLE(GetCvars, EV_NO_ARGS);
220 // is meant to call GetCvars_handle*(get_cvars_s, get_cvars_f, cvarfield, "cvarname") for cvars this mutator needs from the client
225 MUTATOR_HOOKABLE(EditProjectile, EV_NO_ARGS);
226 // can edit any "just fired" projectile
231 MUTATOR_HOOKABLE(MonsterSpawn, EV_NO_ARGS);
232 // called when a monster spawns
234 MUTATOR_HOOKABLE(MonsterDies, EV_NO_ARGS);
235 // called when a monster dies
237 // entity frag_attacker;
239 MUTATOR_HOOKABLE(MonsterRespawn, EV_NO_ARGS);
240 // called when a monster wants to respawn
244 MUTATOR_HOOKABLE(MonsterDropItem, EV_NO_ARGS);
245 // called when a monster is dropping loot
247 .void() monster_loot;
250 MUTATOR_HOOKABLE(MonsterMove, EV_NO_ARGS);
251 // called when a monster moves
252 // returning true makes the monster stop
254 float monster_speed_run;
255 float monster_speed_walk;
256 entity monster_target;
258 MUTATOR_HOOKABLE(MonsterFindTarget, EV_NO_ARGS);
259 // called when a monster looks for another target
261 MUTATOR_HOOKABLE(MonsterCheckBossFlag, EV_NO_ARGS);
262 // called to change a random monster to a miniboss
264 MUTATOR_HOOKABLE(AllowMobSpawning, EV_NO_ARGS);
265 // called when a player tries to spawn a monster
266 // return 1 to prevent spawning
268 MUTATOR_HOOKABLE(PlayerDamage_SplitHealthArmor, EV_NO_ARGS);
269 // called when a player gets damaged to e.g. remove stuff he was carrying.
271 // entity frag_inflictor;
272 // entity frag_attacker;
273 // entity frag_target; // same as self
274 vector damage_force; // NOTE: this force already HAS been applied
279 MUTATOR_HOOKABLE(PlayerDamage_Calculate, EV_NO_ARGS);
280 // called to adjust damage and force values which are applied to the player, used for e.g. strength damage/force multiplier
281 // i'm not sure if I should change this around slightly (Naming of the entities, and also how they're done in g_damage).
283 // entity frag_attacker;
284 // entity frag_target;
285 // float frag_deathtype;
288 float frag_mirrordamage;
291 MUTATOR_HOOKABLE(PlayerPowerups, EV_NO_ARGS);
292 // called at the end of player_powerups() in cl_client.qc, used for manipulating the values which are set by powerup items.
295 int olditems; // also technically output, but since it is at the end of the function it's useless for that :P
297 MUTATOR_HOOKABLE(PlayerRegen, EV_NO_ARGS);
298 // called every player think frame
299 // return 1 to disable regen
302 float regen_mod_regen;
304 float regen_mod_limit;
306 MUTATOR_HOOKABLE(PlayerUseKey, EV_NO_ARGS);
307 // called when the use key is pressed
308 // if MUTATOR_RETURNVALUE is 1, don't do anything
309 // return 1 if the use key actually did something
311 MUTATOR_HOOKABLE(SV_ParseClientCommand, EV_NO_ARGS);
312 // called when a client command is parsed
313 // NOTE: hooks MUST start with if(MUTATOR_RETURNVALUE) return 0;
314 // NOTE: return 1 if you handled the command, return 0 to continue handling
315 // NOTE: THESE HOOKS MUST NEVER EVER CALL tokenize()
317 string cmd_name; // command name
318 int cmd_argc; // also, argv() can be used
319 string cmd_string; // whole command, use only if you really have to
322 MUTATOR_HOOKFUNCTION(foo_SV_ParseClientCommand)
324 if(MUTATOR_RETURNVALUE) // command was already handled?
326 if(cmd_name == "echocvar" && cmd_argc >= 2)
328 print(cvar_string(argv(1)), "\n");
331 if(cmd_name == "echostring" && cmd_argc >= 2)
333 print(substring(cmd_string, argv_start_index(1), argv_end_index(-1) - argv_start_index(1)), "\n");
340 MUTATOR_HOOKABLE(Spawn_Score, EV_NO_ARGS);
341 // called when a spawnpoint is being evaluated
342 // return 1 to make the spawnpoint unusable
344 // entity self; // player wanting to spawn
345 // entity spawn_spot; // spot to be evaluated
347 vector spawn_score; // _x is priority, _y is "distance"
349 MUTATOR_HOOKABLE(SV_StartFrame, EV_NO_ARGS);
350 // runs globally each server frame
352 MUTATOR_HOOKABLE(SetModname, EV_NO_ARGS);
354 // string modname; // name of the mutator/mod if it warrants showing as such in the server browser
356 MUTATOR_HOOKABLE(Item_Spawn, EV_NO_ARGS);
357 // called for each item being spawned on a map, including dropped weapons
358 // return 1 to remove an item
360 // entity self; // the item
362 MUTATOR_HOOKABLE(SetWeaponreplace, EV_NO_ARGS);
364 // entity self; // map entity
365 // entity other; // weapon info
367 // string ret_string;
369 MUTATOR_HOOKABLE(Item_RespawnCountdown, EV_NO_ARGS);
370 // called when an item is about to respawn
375 MUTATOR_HOOKABLE(BotShouldAttack, EV_NO_ARGS);
376 // called when a bot checks a target to attack
380 MUTATOR_HOOKABLE(PortalTeleport, EV_NO_ARGS);
381 // called whenever a player goes through a portal gun teleport
382 // allows you to strip a player of an item if they go through the teleporter to help prevent cheating
386 MUTATOR_HOOKABLE(HelpMePing, EV_NO_ARGS);
387 // called whenever a player uses impulse 33 (help me) in cl_impulse.qc
388 // normally help me ping uses self.waypointsprite_attachedforcarrier,
389 // but if your mutator uses something different then you can handle it
390 // in a special manner using this hook
392 // entity self; // the player who pressed impulse 33
394 MUTATOR_HOOKABLE(VehicleSpawn, EV_NO_ARGS);
395 // called when a vehicle initializes
396 // return true to remove the vehicle
398 MUTATOR_HOOKABLE(VehicleEnter, EV_NO_ARGS);
399 // called when a player enters a vehicle
400 // allows mutators to set special settings in this event
402 entity vh_player; // player
403 entity vh_vehicle; // vehicle
405 MUTATOR_HOOKABLE(VehicleTouch, EV_NO_ARGS);
406 // called when a player touches a vehicle
407 // return true to stop player from entering the vehicle
409 // entity self; // vehicle
410 // entity other; // player
412 MUTATOR_HOOKABLE(VehicleExit, EV_NO_ARGS);
413 // called when a player exits a vehicle
414 // allows mutators to set special settings in this event
416 // entity vh_player; // player
417 // entity vh_vehicle; // vehicle
419 MUTATOR_HOOKABLE(AbortSpeedrun, EV_NO_ARGS);
420 // called when a speedrun is aborted and the player is teleported back to start position
422 // entity self; // player
424 MUTATOR_HOOKABLE(ItemTouch, EV_NO_ARGS);
425 // called at when a item is touched. Called early, can edit item properties.
426 // entity self; // item
427 // entity other; // player
429 MUT_ITEMTOUCH_CONTINUE, // return this flag to make the function continue as normal
430 MUT_ITEMTOUCH_RETURN, // return this flag to make the function return (handled entirely by mutator)
431 MUT_ITEMTOUCH_PICKUP // return this flag to have the item "picked up" and taken even after mutator handled it
434 MUTATOR_HOOKABLE(ClientConnect, EV_NO_ARGS);
435 // called at when a player connect
436 // entity self; // player
438 MUTATOR_HOOKABLE(HavocBot_ChooseRole, EV_NO_ARGS);
441 MUTATOR_HOOKABLE(AccuracyTargetValid, EV_NO_ARGS);
442 // called when a target is checked for accuracy
443 // entity frag_attacker; // attacker
444 // entity frag_target; // target
446 MUT_ACCADD_VALID, // return this flag to make the function continue if target is a client
447 MUT_ACCADD_INVALID, // return this flag to make the function always continue
448 MUT_ACCADD_INDIFFERENT // return this flag to make the function always return