3 #include <common/mutators/base.qh>
5 // register all possible hooks here
7 /** called when a player becomes observer, after shared setup */
8 #define EV_MakePlayerObserver(i, o) \
9 /** player */ i(entity, MUTATOR_ARGV_0_entity) \
11 MUTATOR_HOOKABLE(MakePlayerObserver, EV_MakePlayerObserver)
14 #define EV_PutClientInServer(i, o) \
15 /** client wanting to spawn */ i(entity, MUTATOR_ARGV_0_entity) \
17 MUTATOR_HOOKABLE(PutClientInServer, EV_PutClientInServer);
19 /** called when a player spawns as player, after shared setup, before his weapon is chosen (so items may be changed in here) */
20 #define EV_PlayerSpawn(i, o) \
21 /** player spawning */ i(entity, MUTATOR_ARGV_0_entity) \
22 /** spot that was used, or world */ i(entity, MUTATOR_ARGV_1_entity) \
24 MUTATOR_HOOKABLE(PlayerSpawn, EV_PlayerSpawn);
26 /** called in reset_map */
27 #define EV_reset_map_global(i, o) \
29 MUTATOR_HOOKABLE(reset_map_global, EV_reset_map_global);
31 /** called in reset_map */
32 #define EV_reset_map_players(i, o) \
34 MUTATOR_HOOKABLE(reset_map_players, EV_reset_map_players);
36 /** returns 1 if clearing player score shall not be allowed */
37 #define EV_ForbidPlayerScore_Clear(i, o) \
39 MUTATOR_HOOKABLE(ForbidPlayerScore_Clear, EV_ForbidPlayerScore_Clear);
41 /** called when a player disconnects */
42 #define EV_ClientDisconnect(i, o) \
43 /** player */ i(entity, MUTATOR_ARGV_0_entity) \
45 MUTATOR_HOOKABLE(ClientDisconnect, EV_ClientDisconnect);
47 /** called when a player dies to e.g. remove stuff he was carrying. */
48 #define EV_PlayerDies(i, o) \
49 /** inflictor */ i(entity, MUTATOR_ARGV_0_entity) \
50 /** attacker */ i(entity, MUTATOR_ARGV_1_entity) \
51 /** target */ i(entity, MUTATOR_ARGV_2_entity) \
52 /** deathtype */ i(float, MUTATOR_ARGV_3_float) \
53 /** damage */ i(float, MUTATOR_ARGV_4_float) \
54 /** damage */ o(float, MUTATOR_ARGV_4_float) \
56 MUTATOR_HOOKABLE(PlayerDies, EV_PlayerDies);
58 /** called when a player dies to e.g. remove stuff he was carrying */
59 #define EV_PlayHitsound(i, o) \
60 /** victim */ i(entity, MUTATOR_ARGV_0_entity) \
62 MUTATOR_HOOKABLE(PlayHitsound, EV_PlayHitsound);
64 /** called when a weapon sound is about to be played, allows custom paths etc. */
65 #define EV_WeaponSound(i, o) \
66 /** sound */ i(string, MUTATOR_ARGV_0_string) \
67 /** output */ i(string, MUTATOR_ARGV_1_string) \
68 /**/ o(string, MUTATOR_ARGV_1_string) \
70 MUTATOR_HOOKABLE(WeaponSound, EV_WeaponSound);
72 /** called when an item model is about to be set, allows custom paths etc. */
73 #define EV_ItemModel(i, o) \
74 /** model */ i(string, MUTATOR_ARGV_0_string) \
75 /** output */ i(string, MUTATOR_ARGV_1_string) \
76 /**/ o(string, MUTATOR_ARGV_1_string) \
78 MUTATOR_HOOKABLE(ItemModel, EV_ItemModel);
80 /** called when someone was fragged by "self", and is expected to change frag_score to adjust scoring for the kill */
81 #define EV_GiveFragsForKill(i, o) \
82 /** attacker */ i(entity, MUTATOR_ARGV_0_entity) \
83 /** target */ i(entity, MUTATOR_ARGV_1_entity) \
84 /** frag score */ i(float, MUTATOR_ARGV_2_float) \
85 /** */ o(float, MUTATOR_ARGV_2_float) \
87 MUTATOR_HOOKABLE(GiveFragsForKill, EV_GiveFragsForKill);
89 /** called when the match ends */
90 MUTATOR_HOOKABLE(MatchEnd, EV_NO_ARGS);
92 /** should adjust number to contain the team count */
93 #define EV_GetTeamCount(i, o) \
94 /** number of teams */ i(float, MUTATOR_ARGV_0_float) \
95 /**/ o(float, MUTATOR_ARGV_0_float) \
96 /** team entity name */ i(string, MUTATOR_ARGV_1_string) \
97 /**/ o(string, MUTATOR_ARGV_1_string) \
99 MUTATOR_HOOKABLE(GetTeamCount, EV_GetTeamCount);
101 /** copies variables for spectating "other" to "self" */
102 #define EV_SpectateCopy(i, o) \
103 /** spectatee */ i(entity, MUTATOR_ARGV_0_entity) \
104 /** client */ i(entity, MUTATOR_ARGV_1_entity) \
106 MUTATOR_HOOKABLE(SpectateCopy, EV_SpectateCopy);
108 /** called when formatting a chat message to replace fancy functions */
109 #define EV_FormatMessage(i, o) \
110 /** player */ i(entity, MUTATOR_ARGV_0_entity) \
111 /** escape */ i(string, MUTATOR_ARGV_1_string) \
112 /** replacement */ i(string, MUTATOR_ARGV_2_string) \
113 /**/ o(string, MUTATOR_ARGV_2_string) \
114 /** message */ i(string, MUTATOR_ARGV_3_string) \
116 MUTATOR_HOOKABLE(FormatMessage, EV_FormatMessage);
118 /** returns true if throwing the current weapon shall not be allowed */
119 #define EV_ForbidThrowCurrentWeapon(i, o) \
120 /** player */ i(entity, MUTATOR_ARGV_0_entity) \
122 MUTATOR_HOOKABLE(ForbidThrowCurrentWeapon, EV_ForbidThrowCurrentWeapon);
124 /** returns true if dropping the current weapon shall not be allowed at any time including death */
125 #define EV_ForbidDropCurrentWeapon(i, o) \
126 /** player */ i(entity, MUTATOR_ARGV_0_entity) \
128 MUTATOR_HOOKABLE(ForbidDropCurrentWeapon, EV_ForbidDropCurrentWeapon);
131 MUTATOR_HOOKABLE(SetDefaultAlpha, EV_NO_ARGS);
133 /** allows changing attack rate */
134 #define EV_WeaponRateFactor(i, o) \
135 /** weapon rate */ i(float, MUTATOR_ARGV_0_float) \
136 /**/ o(float, MUTATOR_ARGV_0_float) \
137 /** player */ i(entity, MUTATOR_ARGV_1_entity) \
139 MUTATOR_HOOKABLE(WeaponRateFactor, EV_WeaponRateFactor);
141 /** allows changing weapon speed (projectiles mostly) */
142 #define EV_WeaponSpeedFactor(i, o) \
143 /** weapon speed */ i(float, MUTATOR_ARGV_0_float) \
144 /**/ o(float, MUTATOR_ARGV_0_float) \
145 /** player */ i(entity, MUTATOR_ARGV_1_entity) \
147 MUTATOR_HOOKABLE(WeaponSpeedFactor, EV_WeaponSpeedFactor);
149 /** adjusts {warmup_}start_{items,weapons,ammo_{cells,plasma,rockets,nails,shells,fuel}} */
150 MUTATOR_HOOKABLE(SetStartItems, EV_NO_ARGS);
152 /** called every frame. customizes the waypoint for spectators */
153 #define EV_CustomizeWaypoint(i, o) \
154 /** waypoint */ i(entity, MUTATOR_ARGV_0_entity) \
155 /** player; other.enemy = spectator */ i(entity, MUTATOR_ARGV_1_entity) \
157 MUTATOR_HOOKABLE(CustomizeWaypoint, EV_CustomizeWaypoint);
160 * 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)
161 * return error to request removal
163 #define EV_FilterItem(i, o) \
164 /** item */ i(entity, MUTATOR_ARGV_0_entity) \
166 MUTATOR_HOOKABLE(FilterItem, EV_FilterItem);
168 /** return error to request removal */
169 #define EV_TurretSpawn(i, o) \
170 /** turret */ i(entity, MUTATOR_ARGV_0_entity) \
172 MUTATOR_HOOKABLE(TurretSpawn, EV_TurretSpawn);
174 /** return error to not attack */
175 #define EV_TurretFire(i, o) \
176 /** turret */ i(entity, MUTATOR_ARGV_0_entity) \
178 MUTATOR_HOOKABLE(TurretFire, EV_TurretFire);
180 /** return error to not attack */
181 #define EV_Turret_CheckFire(i, o) \
182 /** turret */ i(entity, MUTATOR_ARGV_0_entity) \
183 /** to fire or not to fire */ o(bool, MUTATOR_ARGV_1_bool) \
185 MUTATOR_HOOKABLE(Turret_CheckFire, EV_Turret_CheckFire);
187 /** return error to prevent entity spawn, or modify the entity */
188 #define EV_OnEntityPreSpawn(i, o) \
189 /** entity */ i(entity, MUTATOR_ARGV_0_entity) \
191 MUTATOR_HOOKABLE(OnEntityPreSpawn, EV_OnEntityPreSpawn);
193 /** runs in the event loop for players; is called for ALL player entities, also bots, also the dead, or spectators */
194 MUTATOR_HOOKABLE(PlayerPreThink, EV_NO_ARGS);
196 /** TODO change this into a general PlayerPostThink hook? */
197 MUTATOR_HOOKABLE(GetPressedKeys, EV_NO_ARGS);
199 /** is meant to call GetCvars_handle*(get_cvars_s, get_cvars_f, cvarfield, "cvarname") for cvars this mutator needs from the client */
200 #define EV_GetCvars(i, o) \
201 /**/ i(float, get_cvars_f) \
202 /**/ i(string, get_cvars_s) \
206 MUTATOR_HOOKABLE(GetCvars, EV_NO_ARGS); // NOTE: Can't use EV_GetCvars because of `SZ_GetSpace: overflow`
208 /** can edit any "just fired" projectile */
209 #define EV_EditProjectile(i, o) \
210 /** projectile owner */ i(entity, MUTATOR_ARGV_0_entity) \
211 /** projectile */ i(entity, MUTATOR_ARGV_1_entity) \
213 MUTATOR_HOOKABLE(EditProjectile, EV_EditProjectile);
215 /** called when a monster spawns */
216 #define EV_MonsterSpawn(i, o) \
217 /** monster */ i(entity, MUTATOR_ARGV_0_entity) \
219 MUTATOR_HOOKABLE(MonsterSpawn, EV_MonsterSpawn);
221 /** called when a monster dies */
222 #define EV_MonsterDies(i, o) \
223 /** target */ i(entity, MUTATOR_ARGV_0_entity) \
224 /** attacker */ i(entity, MUTATOR_ARGV_1_entity) \
225 /** deathtype */ i(float, MUTATOR_ARGV_2_float) \
227 MUTATOR_HOOKABLE(MonsterDies, EV_MonsterDies);
229 /** called when a monster dies */
230 #define EV_MonsterRemove(i, o) \
231 /** monster */ i(entity, MUTATOR_ARGV_0_entity) \
233 MUTATOR_HOOKABLE(MonsterRemove, EV_MonsterRemove);
235 /** called when a monster wants to respawn */
236 #define EV_MonsterRespawn(i, o) \
237 /** monster */ i(entity, MUTATOR_ARGV_0_entity) \
239 MUTATOR_HOOKABLE(MonsterRespawn, EV_MonsterRespawn);
241 /** called when a monster is dropping loot */
242 #define EV_MonsterDropItem(i, o) \
243 /* monster */ i(entity, MUTATOR_ARGV_0_entity) \
244 /* item (can be removed or changed) */ i(entity, MUTATOR_ARGV_1_entity) \
245 /**/ o(entity, MUTATOR_ARGV_1_entity) \
246 /* attacker */ i(entity, MUTATOR_ARGV_2_entity) \
248 .void(entity this) monster_loot;
249 MUTATOR_HOOKABLE(MonsterDropItem, EV_MonsterDropItem);
252 * called when a monster moves
253 * returning true makes the monster stop
255 #define EV_MonsterMove(i, o) \
256 /** monster */ i(entity, MUTATOR_ARGV_0_entity) \
257 /** run speed */ i(float, MUTATOR_ARGV_1_float) \
258 /**/ o(float, MUTATOR_ARGV_1_float) \
259 /** walk speed */ i(float, MUTATOR_ARGV_2_float) \
260 /**/ o(float, MUTATOR_ARGV_2_float) \
261 /** move target */ i(entity, MUTATOR_ARGV_3_entity) \
263 MUTATOR_HOOKABLE(MonsterMove, EV_MonsterMove);
265 /** called when a monster looks for another target */
266 MUTATOR_HOOKABLE(MonsterFindTarget, EV_NO_ARGS);
268 /** called to change a random monster to a miniboss */
269 #define EV_MonsterCheckBossFlag(i, o) \
270 /** monster */ i(entity, MUTATOR_ARGV_0_entity) \
272 MUTATOR_HOOKABLE(MonsterCheckBossFlag, EV_MonsterCheckBossFlag);
275 * called when a player tries to spawn a monster
276 * return 1 to prevent spawning
277 * NOTE: requires reason if disallowed
279 #define EV_AllowMobSpawning(i, o) \
280 /** caller */ i(entity, MUTATOR_ARGV_0_entity) \
281 /** reason */ o(string, MUTATOR_ARGV_1_string) \
283 MUTATOR_HOOKABLE(AllowMobSpawning, EV_AllowMobSpawning);
285 /** called when a player gets damaged to e.g. remove stuff he was carrying. */
286 #define EV_PlayerDamage_SplitHealthArmor(i, o) \
287 /** inflictor */ i(entity, MUTATOR_ARGV_0_entity) \
288 /** attacker */ i(entity, MUTATOR_ARGV_1_entity) \
289 /** target */ i(entity, MUTATOR_ARGV_2_entity) \
290 /** force (no out) */ i(vector, MUTATOR_ARGV_3_vector) \
291 /** damage take */ i(float, MUTATOR_ARGV_4_float) \
292 /** damage take */ o(float, MUTATOR_ARGV_4_float) \
293 /** damage save */ i(float, MUTATOR_ARGV_5_float) \
294 /** damage save */ o(float, MUTATOR_ARGV_5_float) \
295 /** deathtype */ i(float, MUTATOR_ARGV_6_float) \
296 /** damage */ i(float, MUTATOR_ARGV_7_float) \
298 MUTATOR_HOOKABLE(PlayerDamage_SplitHealthArmor, EV_PlayerDamage_SplitHealthArmor);
301 * called to adjust damage and force values which are applied to the player, used for e.g. strength damage/force multiplier
302 * i'm not sure if I should change this around slightly (Naming of the entities, and also how they're done in g_damage).
304 #define EV_PlayerDamage_Calculate(i, o) \
305 /** inflictor */ i(entity, MUTATOR_ARGV_0_entity) \
306 /** attacker */ i(entity, MUTATOR_ARGV_1_entity) \
307 /** target */ i(entity, MUTATOR_ARGV_2_entity) \
308 /** deathtype */ i(float, MUTATOR_ARGV_3_float) \
309 /** damage */ i(float, MUTATOR_ARGV_4_float) \
310 /** damage */ o(float, MUTATOR_ARGV_4_float) \
311 /** mirrordamage */ i(float, MUTATOR_ARGV_5_float) \
312 /** mirrordamage */ o(float, MUTATOR_ARGV_5_float) \
313 /** force */ i(vector, MUTATOR_ARGV_6_vector) \
314 /** force */ o(vector, MUTATOR_ARGV_6_vector) \
316 MUTATOR_HOOKABLE(PlayerDamage_Calculate, EV_PlayerDamage_Calculate);
319 * Called when a player is damaged
321 #define EV_PlayerDamaged(i, o) \
322 /** attacker */ i(entity, MUTATOR_ARGV_0_entity) \
323 /** target */ i(entity, MUTATOR_ARGV_1_entity) \
324 /** health */ i(int, MUTATOR_ARGV_2_int) \
325 /** armor */ i(int, MUTATOR_ARGV_3_int) \
326 /** location */ i(vector, MUTATOR_ARGV_4_vector) \
327 /** deathtype */ i(int, MUTATOR_ARGV_5_int) \
329 MUTATOR_HOOKABLE(PlayerDamaged, EV_PlayerDamaged);
332 * Called by W_DecreaseAmmo
334 #define EV_W_DecreaseAmmo(i, o) \
335 /** actor */ i(entity, MUTATOR_ARGV_0_entity) \
337 MUTATOR_HOOKABLE(W_DecreaseAmmo, EV_W_DecreaseAmmo);
342 #define EV_W_Reload(i, o) \
343 /** actor */ i(entity, MUTATOR_ARGV_0_entity) \
345 MUTATOR_HOOKABLE(W_Reload, EV_W_Reload);
347 /** called at the end of player_powerups() in cl_client.qc, used for manipulating the values which are set by powerup items. */
348 #define EV_PlayerPowerups(i, o) \
349 /** player */ i(entity, MUTATOR_ARGV_0_entity) \
350 /** old items */ i(int, MUTATOR_ARGV_1_int) \
352 MUTATOR_HOOKABLE(PlayerPowerups, EV_PlayerPowerups);
355 * called every player think frame
356 * return 1 to disable regen
359 float regen_mod_regen;
361 float regen_mod_limit;
363 float regen_health_linear;
364 float regen_health_rot;
365 float regen_health_rotlinear;
366 float regen_health_stable;
367 float regen_health_rotstable;
368 MUTATOR_HOOKABLE(PlayerRegen, EV_NO_ARGS);
371 * called when the use key is pressed
372 * if MUTATOR_RETURNVALUE is 1, don't do anything
373 * return 1 if the use key actually did something
375 MUTATOR_HOOKABLE(PlayerUseKey, EV_NO_ARGS);
378 * called when a client command is parsed
379 * NOTE: hooks MUST start with if (MUTATOR_RETURNVALUE) return false;
380 * NOTE: return true if you handled the command, return false to continue handling
381 * NOTE: THESE HOOKS MUST NEVER EVER CALL tokenize()
383 * MUTATOR_HOOKFUNCTION(foo_SV_ParseClientCommand)
385 * if (MUTATOR_RETURNVALUE) // command was already handled?
387 * if (cmd_name == "echocvar" && cmd_argc >= 2)
389 * print(cvar_string(argv(1)), "\n");
392 * if (cmd_name == "echostring" && cmd_argc >= 2)
394 * print(substring(cmd_string, argv_start_index(1), argv_end_index(-1) - argv_start_index(1)), "\n");
400 #define EV_SV_ParseClientCommand(i, o) \
401 /** client sending the command */ i(entity, MUTATOR_ARGV_0_entity) \
402 /** command name */ i(string, MUTATOR_ARGV_1_string) \
403 /** argc (also, argv() can be used) */ i(int, MUTATOR_ARGV_2_int) \
404 /** whole command, use only if you really have to */ i(string, MUTATOR_ARGV_3_string) \
406 MUTATOR_HOOKABLE(SV_ParseClientCommand, EV_SV_ParseClientCommand);
408 /** please read EV_SV_ParseClientCommand description before using */
409 #define EV_SV_ParseServerCommand(i, o) \
410 /** command name */ i(string, MUTATOR_ARGV_0_string) \
411 /** argc (also, argv() can be used) */ i(int, MUTATOR_ARGV_1_int) \
412 /** whole command, use only if you really have to */ i(string, MUTATOR_ARGV_2_string) \
414 MUTATOR_HOOKABLE(SV_ParseServerCommand, EV_SV_ParseServerCommand);
417 * called when a spawnpoint is being evaluated
418 * return 1 to make the spawnpoint unusable
420 #define EV_Spawn_Score(i, o) \
421 /** player wanting to spawn */ i(entity, MUTATOR_ARGV_0_entity) \
422 /** spot to be evaluated */ i(entity, MUTATOR_ARGV_1_entity) \
423 /** spot score, _x is priority, _y is "distance" */ i(vector, MUTATOR_ARGV_0_vector) \
424 /**/ o(vector, MUTATOR_ARGV_0_vector) \
426 MUTATOR_HOOKABLE(Spawn_Score, EV_Spawn_Score);
428 /** runs globally each server frame */
429 MUTATOR_HOOKABLE(SV_StartFrame, EV_NO_ARGS);
431 #define EV_SetModname(i, o) \
432 /** name of the mutator/mod if it warrants showing as such in the server browser */ \
433 /**/ o(string, MUTATOR_ARGV_0_string) \
435 MUTATOR_HOOKABLE(SetModname, EV_SetModname);
438 * called for each item being spawned on a map, including dropped weapons
439 * return 1 to remove an item
441 #define EV_Item_Spawn(i, o) \
442 /** item */ i(entity, MUTATOR_ARGV_0_entity) \
444 MUTATOR_HOOKABLE(Item_Spawn, EV_Item_Spawn);
446 #define EV_SetWeaponreplace(i, o) \
447 /** map entity */ i(entity, MUTATOR_ARGV_0_entity) \
448 /** weapon info */ i(entity, MUTATOR_ARGV_1_entity) \
449 /** replacement */ i(string, MUTATOR_ARGV_2_string) \
450 /**/ o(string, MUTATOR_ARGV_2_string) \
452 MUTATOR_HOOKABLE(SetWeaponreplace, EV_SetWeaponreplace);
454 /** called when an item is about to respawn */
455 #define EV_Item_RespawnCountdown(i, o) \
456 /** item name */ i(string, MUTATOR_ARGV_0_string) \
457 /**/ o(string, MUTATOR_ARGV_0_string) \
458 /** item colour */ i(vector, MUTATOR_ARGV_1_vector) \
459 /**/ o(vector, MUTATOR_ARGV_1_vector) \
461 MUTATOR_HOOKABLE(Item_RespawnCountdown, EV_Item_RespawnCountdown);
463 /** called when a bot checks a target to attack */
464 #define EV_BotShouldAttack(i, o) \
465 /** bot */ i(entity, MUTATOR_ARGV_0_entity) \
466 /** target */ i(entity, MUTATOR_ARGV_1_entity) \
468 MUTATOR_HOOKABLE(BotShouldAttack, EV_BotShouldAttack);
471 * called whenever a player goes through a portal gun teleport
472 * allows you to strip a player of an item if they go through the teleporter to help prevent cheating
474 #define EV_PortalTeleport(i, o) \
475 /** player */ i(entity, MUTATOR_ARGV_0_entity) \
477 MUTATOR_HOOKABLE(PortalTeleport, EV_PortalTeleport);
480 * called whenever a player uses impulse 33 (help me) in cl_impulse.qc
481 * normally help me ping uses self.waypointsprite_attachedforcarrier,
482 * but if your mutator uses something different then you can handle it
483 * in a special manner using this hook
485 #define EV_HelpMePing(i, o) \
486 /** the player who pressed impulse 33 */ i(entity, MUTATOR_ARGV_0_entity) \
488 MUTATOR_HOOKABLE(HelpMePing, EV_HelpMePing);
491 * called when a vehicle initializes
492 * return true to remove the vehicle
494 #define EV_VehicleSpawn(i, o) \
495 /** vehicle */ i(entity, MUTATOR_ARGV_0_entity) \
497 MUTATOR_HOOKABLE(VehicleSpawn, EV_VehicleSpawn);
500 * called when a player enters a vehicle
501 * allows mutators to set special settings in this event
503 #define EV_VehicleEnter(i, o) \
504 /** player */ i(entity, MUTATOR_ARGV_0_entity) \
505 /** vehicle */ i(entity, MUTATOR_ARGV_1_entity) \
507 MUTATOR_HOOKABLE(VehicleEnter, EV_VehicleEnter);
510 * called when a player touches a vehicle
511 * return true to stop player from entering the vehicle
513 #define EV_VehicleTouch(i, o) \
514 /** vehicle */ i(entity, MUTATOR_ARGV_0_entity) \
515 /** player */ i(entity, MUTATOR_ARGV_1_entity) \
517 MUTATOR_HOOKABLE(VehicleTouch, EV_VehicleTouch);
520 * called when a player exits a vehicle
521 * allows mutators to set special settings in this event
523 #define EV_VehicleExit(i, o) \
524 /** player */ i(entity, MUTATOR_ARGV_0_entity) \
525 /** vehicle */ i(entity, MUTATOR_ARGV_1_entity) \
527 MUTATOR_HOOKABLE(VehicleExit, EV_VehicleExit);
529 /** called when a speedrun is aborted and the player is teleported back to start position */
530 #define EV_AbortSpeedrun(i, o) \
531 /** player */ i(entity, MUTATOR_ARGV_0_entity) \
533 MUTATOR_HOOKABLE(AbortSpeedrun, EV_AbortSpeedrun);
535 /** called at when a item is touched. Called early, can edit item properties. */
536 #define EV_ItemTouch(i, o) \
537 /** item */ i(entity, MUTATOR_ARGV_0_entity) \
538 /** toucher */ i(entity, MUTATOR_ARGV_1_entity) \
540 MUTATOR_HOOKABLE(ItemTouch, EV_ItemTouch);
543 MUT_ITEMTOUCH_CONTINUE, // return this flag to make the function continue as normal
544 MUT_ITEMTOUCH_RETURN, // return this flag to make the function return (handled entirely by mutator)
545 MUT_ITEMTOUCH_PICKUP // return this flag to have the item "picked up" and taken even after mutator handled it
548 /** called at when a player connect */
549 #define EV_ClientConnect(i, o) \
550 /** player */ i(entity, MUTATOR_ARGV_0_entity) \
552 MUTATOR_HOOKABLE(ClientConnect, EV_ClientConnect);
554 #define EV_HavocBot_ChooseRole(i, o) \
555 /** bot */ i(entity, MUTATOR_ARGV_0_entity) \
557 MUTATOR_HOOKABLE(HavocBot_ChooseRole, EV_HavocBot_ChooseRole);
559 /** called when a target is checked for accuracy */
560 #define EV_AccuracyTargetValid(i, o) \
561 /** attacker */ i(entity, MUTATOR_ARGV_0_entity) \
562 /** target */ i(entity, MUTATOR_ARGV_1_entity) \
564 MUTATOR_HOOKABLE(AccuracyTargetValid, EV_AccuracyTargetValid);
566 MUT_ACCADD_VALID, // return this flag to make the function continue if target is a client
567 MUT_ACCADD_INVALID, // return this flag to make the function always continue
568 MUT_ACCADD_INDIFFERENT // return this flag to make the function always return
571 /** Called when clearing the global parameters for a model */
572 MUTATOR_HOOKABLE(ClearModelParams, EV_NO_ARGS);
574 /** Called when getting the global parameters for a model */
575 #define EV_GetModelParams(i, o) \
576 /** input */ i(string, MUTATOR_ARGV_0_string) \
577 /** command */ i(string, MUTATOR_ARGV_1_string) \
579 MUTATOR_HOOKABLE(GetModelParams, EV_GetModelParams);
581 /** called when a bullet has hit a target */
582 #define EV_FireBullet_Hit(i, o) \
583 /** player */ i(entity, MUTATOR_ARGV_0_entity) \
584 /** targ */ i(entity, MUTATOR_ARGV_1_entity) \
585 /** start pos */ i(vector, MUTATOR_ARGV_2_vector) \
586 /** end pos */ i(vector, MUTATOR_ARGV_3_vector) \
587 /** damage */ i(float, MUTATOR_ARGV_4_float) \
588 /**/ o(float, MUTATOR_ARGV_4_float) \
590 MUTATOR_HOOKABLE(FireBullet_Hit, EV_FireBullet_Hit);
592 #define EV_FixPlayermodel(i, o) \
593 /** model */ i(string, MUTATOR_ARGV_0_string) \
594 /**/ o(string, MUTATOR_ARGV_0_string) \
595 /** skin */ i(int, MUTATOR_ARGV_1_int) \
596 /**/ o(int, MUTATOR_ARGV_1_int) \
598 MUTATOR_HOOKABLE(FixPlayermodel, EV_FixPlayermodel);
600 /** Return error to play frag remaining announcements */
601 MUTATOR_HOOKABLE(Scores_CountFragsRemaining, EV_NO_ARGS);
603 #define EV_GrappleHookThink(i, o) \
604 /** hook */ i(entity, MUTATOR_ARGV_0_entity) \
605 /** tarzan */ i(int, MUTATOR_ARGV_1_int) \
606 /**/ o(int, MUTATOR_ARGV_1_int) \
607 /** pulling entity */ i(entity, MUTATOR_ARGV_2_entity) \
608 /**/ o(entity, MUTATOR_ARGV_2_entity) \
609 /** velocity multiplier */ i(float, MUTATOR_ARGV_3_float) \
610 /**/ o(float, MUTATOR_ARGV_3_float) \
612 MUTATOR_HOOKABLE(GrappleHookThink, EV_GrappleHookThink);
614 #define EV_BuffModel_Customize(i, o) \
615 /** buff */ i(entity, MUTATOR_ARGV_0_entity) \
616 /** player */ i(entity, MUTATOR_ARGV_1_entity) \
618 MUTATOR_HOOKABLE(BuffModel_Customize, EV_BuffModel_Customize);
620 /** called at when a buff is touched. Called early, can edit buff properties. */
621 #define EV_BuffTouch(i, o) \
622 /** buff */ i(entity, MUTATOR_ARGV_0_entity) \
623 /** player */ i(entity, MUTATOR_ARGV_1_entity) \
625 MUTATOR_HOOKABLE(BuffTouch, EV_BuffTouch);
627 MUTATOR_HOOKABLE(SetNewParms, EV_NO_ARGS);
629 MUTATOR_HOOKABLE(SetChangeParms, EV_NO_ARGS);
631 MUTATOR_HOOKABLE(DecodeLevelParms, EV_NO_ARGS);
633 #define EV_GetRecords(i, o) \
634 /** page */ i(int, MUTATOR_ARGV_1_int) \
635 /** record list */ i(string, MUTATOR_ARGV_1_string) \
636 /**/ o(string, MUTATOR_ARGV_1_string) \
638 MUTATOR_HOOKABLE(GetRecords, EV_GetRecords);
640 #define EV_Race_FinalCheckpoint(i, o) \
641 /** player */ i(entity, MUTATOR_ARGV_0_entity) \
643 MUTATOR_HOOKABLE(Race_FinalCheckpoint, EV_Race_FinalCheckpoint);
645 /** called when player triggered kill (or is changing teams), return error to not do anything */
646 #define EV_ClientKill(i, o) \
647 /** player */ i(entity, MUTATOR_ARGV_0_entity) \
648 /** kill delay */ i(float, MUTATOR_ARGV_1_float) \
649 /**/ o(float, MUTATOR_ARGV_1_float) \
651 MUTATOR_HOOKABLE(ClientKill, EV_ClientKill);
653 #define EV_FixClientCvars(i, o) \
654 /** player */ i(entity, MUTATOR_ARGV_0_entity) \
656 MUTATOR_HOOKABLE(FixClientCvars, EV_FixClientCvars);
658 #define EV_SpectateSet(i, o) \
659 /** client */ i(entity, MUTATOR_ARGV_0_entity) \
660 /** target */ i(entity, MUTATOR_ARGV_1_entity) \
661 /**/ o(entity, MUTATOR_ARGV_1_entity) \
663 MUTATOR_HOOKABLE(SpectateSet, EV_SpectateSet);
665 #define EV_SpectateNext(i, o) \
666 /** client */ i(entity, MUTATOR_ARGV_0_entity) \
667 /** target */ i(entity, MUTATOR_ARGV_1_entity) \
668 /**/ o(entity, MUTATOR_ARGV_1_entity) \
670 MUTATOR_HOOKABLE(SpectateNext, EV_SpectateNext);
672 #define EV_SpectatePrev(i, o) \
673 /** client */ i(entity, MUTATOR_ARGV_0_entity) \
674 /** target */ i(entity, MUTATOR_ARGV_1_entity) \
675 /**/ o(entity, MUTATOR_ARGV_1_entity) \
676 /** first */ i(entity, MUTATOR_ARGV_2_entity) \
678 MUTATOR_HOOKABLE(SpectatePrev, EV_SpectatePrev);
681 MUT_SPECPREV_CONTINUE, // return this flag to make the function continue as normal
682 MUT_SPECPREV_RETURN, // return this flag to make the function return (handled entirely by mutator)
683 MUT_SPECPREV_FOUND // return this flag to make the function continue without default functions (handled mostly by mutator)
686 /** called when player triggered kill (or is changing teams), return error to not do anything */
687 #define EV_Bot_FixCount(i, o) \
688 /** active real players */ i(int, MUTATOR_ARGV_0_int) \
689 /**/ o(int, MUTATOR_ARGV_0_int) \
690 /** real players */ i(int, MUTATOR_ARGV_1_int) \
691 /**/ o(int, MUTATOR_ARGV_1_int) \
693 MUTATOR_HOOKABLE(Bot_FixCount, EV_Bot_FixCount);
695 #define EV_ClientCommand_Spectate(i, o) \
696 /** player */ i(entity, MUTATOR_ARGV_0_entity) \
698 MUTATOR_HOOKABLE(ClientCommand_Spectate, EV_ClientCommand_Spectate);
701 MUT_SPECCMD_CONTINUE, // return this flag to make the function continue as normal
702 MUT_SPECCMD_RETURN, // return this flag to make the function return (don't spectate)
703 MUT_SPECCMD_FORCE // return this flag to force the player to spectate, even if they're not a player
706 #define EV_CheckRules_World(i, o) \
707 /** status */ i(float, MUTATOR_ARGV_0_float) \
708 /**/ o(float, MUTATOR_ARGV_0_float) \
709 /* time limit */ i(float, MUTATOR_ARGV_1_float) \
710 /* frag limit */ i(float, MUTATOR_ARGV_2_float) \
712 MUTATOR_HOOKABLE(CheckRules_World, EV_CheckRules_World);
714 #define EV_WantWeapon(i, o) \
715 /** weapon info entity */ i(entity, MUTATOR_ARGV_0_entity) \
716 /** do want? */ i(float, MUTATOR_ARGV_1_float) \
717 /**/ o(float, MUTATOR_ARGV_1_float) \
718 /** want all guns */ i(bool, MUTATOR_ARGV_2_bool) \
719 /**/ o(bool, MUTATOR_ARGV_2_bool) \
720 /** want mutator blocked */ i(bool, MUTATOR_ARGV_3_bool) \
721 /**/ o(bool, MUTATOR_ARGV_3_bool) \
723 MUTATOR_HOOKABLE(WantWeapon, EV_WantWeapon);
725 #define EV_AddPlayerScore(i, o) \
726 /** score field */ i(int, MUTATOR_ARGV_0_int) \
727 /** score */ i(float, MUTATOR_ARGV_1_float) \
728 /**/ o(float, MUTATOR_ARGV_1_float) \
729 /** player */ i(entity, MUTATOR_ARGV_2_entity) \
731 MUTATOR_HOOKABLE(AddPlayerScore, EV_AddPlayerScore);
733 #define EV_GetPlayerStatus(i, o) \
734 /** player */ i(entity, MUTATOR_ARGV_0_entity) \
736 MUTATOR_HOOKABLE(GetPlayerStatus, EV_GetPlayerStatus);
738 #define EV_SetWeaponArena(i, o) \
739 /** arena */ i(string, MUTATOR_ARGV_0_string) \
740 /**/ o(string, MUTATOR_ARGV_0_string) \
742 MUTATOR_HOOKABLE(SetWeaponArena, EV_SetWeaponArena);
744 #define EV_DropSpecialItems(i, o) \
745 /** target */ i(entity, MUTATOR_ARGV_0_entity) \
747 MUTATOR_HOOKABLE(DropSpecialItems, EV_DropSpecialItems);
750 * called when an admin tries to kill all monsters
751 * return 1 to prevent spawning
753 #define EV_AllowMobButcher(i, o) \
754 /** reason */ o(string, MUTATOR_ARGV_0_string) \
756 MUTATOR_HOOKABLE(AllowMobButcher, EV_AllowMobButcher);
758 MUTATOR_HOOKABLE(ReadLevelCvars, EV_NO_ARGS);
760 #define EV_SendWaypoint(i, o) \
761 /** waypoint */ i(entity, MUTATOR_ARGV_0_entity) \
762 /** to */ i(entity, MUTATOR_ARGV_1_entity) \
763 /** send flags */ i(int, MUTATOR_ARGV_2_int) \
764 /**/ o(int, MUTATOR_ARGV_2_int) \
765 /** wp flag */ i(int, MUTATOR_ARGV_3_int) \
766 /**/ o(int, MUTATOR_ARGV_3_int) \
768 MUTATOR_HOOKABLE(SendWaypoint, EV_SendWaypoint);
770 #define EV_TurretValidateTarget(i, o) \
771 /** turret */ i(entity, MUTATOR_ARGV_0_entity) \
772 /** target */ i(entity, MUTATOR_ARGV_1_entity) \
773 /** validate flags */ i(int, MUTATOR_ARGV_2_int) \
774 /** target score */ o(float, MUTATOR_ARGV_3_float) \
776 MUTATOR_HOOKABLE(TurretValidateTarget, EV_TurretValidateTarget);
778 #define EV_TurretThink(i, o) \
779 /** turret */ i(entity, MUTATOR_ARGV_0_entity) \
781 MUTATOR_HOOKABLE(TurretThink, EV_TurretThink);
783 MUTATOR_HOOKABLE(Ent_Init, EV_NO_ARGS);
786 #define EV_PrepareExplosionByDamage(i, o) \
787 /** projectile */ i(entity, MUTATOR_ARGV_0_entity) \
788 /** attacker */ i(entity, MUTATOR_ARGV_1_entity) \
790 MUTATOR_HOOKABLE(PrepareExplosionByDamage, EV_PrepareExplosionByDamage);
792 /** called when a monster model is about to be set, allows custom paths etc. */
793 #define EV_MonsterModel(i, o) \
794 /** model */ i(string, MUTATOR_ARGV_0_string) \
795 /** output */ i(string, MUTATOR_ARGV_1_string) \
796 /**/ o(string, MUTATOR_ARGV_1_string) \
798 MUTATOR_HOOKABLE(MonsterModel, EV_MonsterModel);
801 #define EV_Player_ChangeTeam(i, o) \
802 /** player */ i(entity, MUTATOR_ARGV_0_entity) \
803 /** current team */ i(float, MUTATOR_ARGV_1_float) \
804 /** new team */ i(float, MUTATOR_ARGV_2_float) \
806 MUTATOR_HOOKABLE(Player_ChangeTeam, EV_Player_ChangeTeam);
809 #define EV_URI_GetCallback(i, o) \
810 /** id */ i(float, MUTATOR_ARGV_0_float) \
811 /** status */ i(float, MUTATOR_ARGV_1_float) \
812 /** data */ i(string, MUTATOR_ARGV_2_string) \
814 MUTATOR_HOOKABLE(URI_GetCallback, EV_URI_GetCallback);