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);
20 * return true to prevent a spectator/observer to spawn as player
22 #define EV_ForbidSpawn(i, o) \
23 /** player */ i(entity, MUTATOR_ARGV_0_entity) \
25 MUTATOR_HOOKABLE(ForbidSpawn, EV_ForbidSpawn);
27 /** called when a player spawns as player, after shared setup, before his weapon is chosen (so items may be changed in here) */
28 #define EV_PlayerSpawn(i, o) \
29 /** player spawning */ i(entity, MUTATOR_ARGV_0_entity) \
30 /** spot that was used, or NULL */ i(entity, MUTATOR_ARGV_1_entity) \
32 MUTATOR_HOOKABLE(PlayerSpawn, EV_PlayerSpawn);
34 /** called after a player's weapon is chosen so it can be overriden here */
35 #define EV_PlayerWeaponSelect(i, o) \
36 /** player spawning */ i(entity, MUTATOR_ARGV_0_entity) \
38 MUTATOR_HOOKABLE(PlayerWeaponSelect, EV_PlayerWeaponSelect);
40 /** called in reset_map */
41 #define EV_reset_map_global(i, o) \
43 MUTATOR_HOOKABLE(reset_map_global, EV_reset_map_global);
45 /** called in reset_map */
46 #define EV_reset_map_players(i, o) \
48 MUTATOR_HOOKABLE(reset_map_players, EV_reset_map_players);
50 /** returns 1 if clearing player score shall not be allowed */
51 #define EV_ForbidPlayerScore_Clear(i, o) \
53 MUTATOR_HOOKABLE(ForbidPlayerScore_Clear, EV_ForbidPlayerScore_Clear);
55 /** called when a player disconnects */
56 #define EV_ClientDisconnect(i, o) \
57 /** player */ i(entity, MUTATOR_ARGV_0_entity) \
59 MUTATOR_HOOKABLE(ClientDisconnect, EV_ClientDisconnect);
61 /** called when a player dies to e.g. remove stuff he was carrying. */
62 #define EV_PlayerDies(i, o) \
63 /** inflictor */ i(entity, MUTATOR_ARGV_0_entity) \
64 /** attacker */ i(entity, MUTATOR_ARGV_1_entity) \
65 /** target */ i(entity, MUTATOR_ARGV_2_entity) \
66 /** deathtype */ i(float, MUTATOR_ARGV_3_float) \
67 /** damage */ i(float, MUTATOR_ARGV_4_float) \
68 /** damage */ o(float, MUTATOR_ARGV_4_float) \
70 MUTATOR_HOOKABLE(PlayerDies, EV_PlayerDies);
72 /** allows overriding the frag centerprint messages */
73 #define EV_FragCenterMessage(i, o) \
74 /** attacker */ i(entity, MUTATOR_ARGV_0_entity) \
75 /** target */ i(entity, MUTATOR_ARGV_1_entity) \
76 /** deathtype */ i(float, MUTATOR_ARGV_2_float) \
77 /** attacker kcount*/ i(int, MUTATOR_ARGV_3_int) \
78 /** targ killcount */ i(int, MUTATOR_ARGV_4_int) \
80 MUTATOR_HOOKABLE(FragCenterMessage, EV_FragCenterMessage);
82 /** called when a player dies to e.g. remove stuff he was carrying */
83 #define EV_PlayHitsound(i, o) \
84 /** victim */ i(entity, MUTATOR_ARGV_0_entity) \
85 /** attacker */ i(entity, MUTATOR_ARGV_1_entity) \
87 MUTATOR_HOOKABLE(PlayHitsound, EV_PlayHitsound);
89 /** called when a weapon sound is about to be played, allows custom paths etc. */
90 #define EV_WeaponSound(i, o) \
91 /** sound */ i(string, MUTATOR_ARGV_0_string) \
92 /** output */ i(string, MUTATOR_ARGV_1_string) \
93 /**/ o(string, MUTATOR_ARGV_1_string) \
95 MUTATOR_HOOKABLE(WeaponSound, EV_WeaponSound);
97 /** called when an item model is about to be set, allows custom paths etc. */
98 #define EV_ItemModel(i, o) \
99 /** model */ i(string, MUTATOR_ARGV_0_string) \
100 /** output */ i(string, MUTATOR_ARGV_1_string) \
101 /**/ o(string, MUTATOR_ARGV_1_string) \
103 MUTATOR_HOOKABLE(ItemModel, EV_ItemModel);
105 /** called when an item sound is about to be played, allows custom paths etc. */
106 #define EV_ItemSound(i, o) \
107 /** sound */ i(string, MUTATOR_ARGV_0_string) \
108 /** output */ i(string, MUTATOR_ARGV_1_string) \
109 /**/ o(string, MUTATOR_ARGV_1_string) \
111 MUTATOR_HOOKABLE(ItemSound, EV_ItemSound);
113 /** called when someone was fragged by "self", and is expected to change frag_score to adjust scoring for the kill */
114 #define EV_GiveFragsForKill(i, o) \
115 /** attacker */ i(entity, MUTATOR_ARGV_0_entity) \
116 /** target */ i(entity, MUTATOR_ARGV_1_entity) \
117 /** frag score */ i(float, MUTATOR_ARGV_2_float) \
118 /** */ o(float, MUTATOR_ARGV_2_float) \
120 MUTATOR_HOOKABLE(GiveFragsForKill, EV_GiveFragsForKill);
122 /** called when the match ends */
123 MUTATOR_HOOKABLE(MatchEnd, EV_NO_ARGS);
125 /** allows adjusting allowed teams */
126 #define EV_CheckAllowedTeams(i, o) \
127 /** mask of teams */ i(float, MUTATOR_ARGV_0_float) \
128 /**/ o(float, MUTATOR_ARGV_0_float) \
129 /** team entity name */ i(string, MUTATOR_ARGV_1_string) \
130 /**/ o(string, MUTATOR_ARGV_1_string) \
132 MUTATOR_HOOKABLE(CheckAllowedTeams, EV_CheckAllowedTeams);
134 /** copies variables for spectating "spectatee" to "this" */
135 #define EV_SpectateCopy(i, o) \
136 /** spectatee */ i(entity, MUTATOR_ARGV_0_entity) \
137 /** client */ i(entity, MUTATOR_ARGV_1_entity) \
139 MUTATOR_HOOKABLE(SpectateCopy, EV_SpectateCopy);
141 /** called when formatting a chat message to replace fancy functions */
142 #define EV_FormatMessage(i, o) \
143 /** player */ i(entity, MUTATOR_ARGV_0_entity) \
144 /** escape */ i(string, MUTATOR_ARGV_1_string) \
145 /** replacement */ i(string, MUTATOR_ARGV_2_string) \
146 /**/ o(string, MUTATOR_ARGV_2_string) \
147 /** message */ i(string, MUTATOR_ARGV_3_string) \
149 MUTATOR_HOOKABLE(FormatMessage, EV_FormatMessage);
151 /** called before any formatting is applied, handy for tweaking the message before scripts get ahold of it */
152 #define EV_PreFormatMessage(i, o) \
153 /** player */ i(entity, MUTATOR_ARGV_0_entity) \
154 /** message */ i(string, MUTATOR_ARGV_1_string) \
155 /**/ o(string, MUTATOR_ARGV_1_string) \
157 MUTATOR_HOOKABLE(PreFormatMessage, EV_PreFormatMessage);
159 /** returns true if throwing the current weapon shall not be allowed */
160 #define EV_ForbidThrowCurrentWeapon(i, o) \
161 /** player */ i(entity, MUTATOR_ARGV_0_entity) \
162 /** weapon entity */ i(entity, MUTATOR_ARGV_1_entity) \
164 MUTATOR_HOOKABLE(ForbidThrowCurrentWeapon, EV_ForbidThrowCurrentWeapon);
166 /** returns true if dropping the current weapon shall not be allowed at any time including death */
167 #define EV_ForbidDropCurrentWeapon(i, o) \
168 /** player */ i(entity, MUTATOR_ARGV_0_entity) \
169 /** weapon id */ i(int, MUTATOR_ARGV_1_int) \
171 MUTATOR_HOOKABLE(ForbidDropCurrentWeapon, EV_ForbidDropCurrentWeapon);
174 MUTATOR_HOOKABLE(SetDefaultAlpha, EV_NO_ARGS);
176 /** allows changing attack rate */
177 #define EV_WeaponRateFactor(i, o) \
178 /** weapon rate */ i(float, MUTATOR_ARGV_0_float) \
179 /**/ o(float, MUTATOR_ARGV_0_float) \
180 /** player */ i(entity, MUTATOR_ARGV_1_entity) \
182 MUTATOR_HOOKABLE(WeaponRateFactor, EV_WeaponRateFactor);
184 /** allows changing weapon speed (projectiles mostly) */
185 #define EV_WeaponSpeedFactor(i, o) \
186 /** weapon speed */ i(float, MUTATOR_ARGV_0_float) \
187 /**/ o(float, MUTATOR_ARGV_0_float) \
188 /** player */ i(entity, MUTATOR_ARGV_1_entity) \
190 MUTATOR_HOOKABLE(WeaponSpeedFactor, EV_WeaponSpeedFactor);
192 /** adjusts {warmup_}start_{items,weapons,ammo_{cells,plasma,rockets,nails,shells,fuel}} */
193 MUTATOR_HOOKABLE(SetStartItems, EV_NO_ARGS);
195 /** called every frame. customizes the waypoint for spectators */
196 #define EV_CustomizeWaypoint(i, o) \
197 /** waypoint */ i(entity, MUTATOR_ARGV_0_entity) \
198 /** player; other.enemy = spectator */ i(entity, MUTATOR_ARGV_1_entity) \
200 MUTATOR_HOOKABLE(CustomizeWaypoint, EV_CustomizeWaypoint);
203 * checks if the current item may be spawned (.items and .weapons may be read and written to, as well as the ammo_ fields)
204 * return error to request removal
206 #define EV_FilterItem(i, o) \
207 /** item */ i(entity, MUTATOR_ARGV_0_entity) \
209 MUTATOR_HOOKABLE(FilterItem, EV_FilterItem);
211 /** return error to request removal */
212 #define EV_TurretSpawn(i, o) \
213 /** turret */ i(entity, MUTATOR_ARGV_0_entity) \
215 MUTATOR_HOOKABLE(TurretSpawn, EV_TurretSpawn);
217 /** return error to not attack */
218 #define EV_TurretFire(i, o) \
219 /** turret */ i(entity, MUTATOR_ARGV_0_entity) \
221 MUTATOR_HOOKABLE(TurretFire, EV_TurretFire);
223 /** return error to not attack */
224 #define EV_Turret_CheckFire(i, o) \
225 /** turret */ i(entity, MUTATOR_ARGV_0_entity) \
226 /** to fire or not to fire */ o(bool, MUTATOR_ARGV_1_bool) \
228 MUTATOR_HOOKABLE(Turret_CheckFire, EV_Turret_CheckFire);
230 /** return error to prevent entity spawn, or modify the entity */
231 #define EV_OnEntityPreSpawn(i, o) \
232 /** entity */ i(entity, MUTATOR_ARGV_0_entity) \
234 MUTATOR_HOOKABLE(OnEntityPreSpawn, EV_OnEntityPreSpawn);
236 /** runs in the event loop for players; is called for ALL player entities, also bots, also the dead, or spectators */
237 #define EV_PlayerPreThink(i, o) \
238 /** player */ i(entity, MUTATOR_ARGV_0_entity) \
240 MUTATOR_HOOKABLE(PlayerPreThink, EV_PlayerPreThink);
242 /** TODO change this into a general PlayerPostThink hook? */
243 #define EV_GetPressedKeys(i, o) \
244 /** player */ i(entity, MUTATOR_ARGV_0_entity) \
246 MUTATOR_HOOKABLE(GetPressedKeys, EV_GetPressedKeys);
248 /** is meant to call GetCvars_handle*(get_cvars_s, get_cvars_f, cvarfield, "cvarname") for cvars this mutator needs from the client */
249 #define EV_GetCvars(i, o) \
250 /**/ i(float, get_cvars_f) \
251 /**/ i(string, get_cvars_s) \
255 MUTATOR_HOOKABLE(GetCvars, EV_NO_ARGS); // NOTE: Can't use EV_GetCvars because of `SZ_GetSpace: overflow`
257 /** can edit any "just fired" projectile */
258 #define EV_EditProjectile(i, o) \
259 /** projectile owner */ i(entity, MUTATOR_ARGV_0_entity) \
260 /** projectile */ i(entity, MUTATOR_ARGV_1_entity) \
262 MUTATOR_HOOKABLE(EditProjectile, EV_EditProjectile);
264 /** called when a monster spawns */
265 #define EV_MonsterSpawn(i, o) \
266 /** monster */ i(entity, MUTATOR_ARGV_0_entity) \
268 MUTATOR_HOOKABLE(MonsterSpawn, EV_MonsterSpawn);
270 /** called when a monster dies */
271 #define EV_MonsterDies(i, o) \
272 /** target */ i(entity, MUTATOR_ARGV_0_entity) \
273 /** attacker */ i(entity, MUTATOR_ARGV_1_entity) \
274 /** deathtype */ i(float, MUTATOR_ARGV_2_float) \
276 MUTATOR_HOOKABLE(MonsterDies, EV_MonsterDies);
278 /** called when a monster dies */
279 #define EV_MonsterRemove(i, o) \
280 /** monster */ i(entity, MUTATOR_ARGV_0_entity) \
282 MUTATOR_HOOKABLE(MonsterRemove, EV_MonsterRemove);
284 /** called when a monster wants to respawn */
285 #define EV_MonsterRespawn(i, o) \
286 /** monster */ i(entity, MUTATOR_ARGV_0_entity) \
288 MUTATOR_HOOKABLE(MonsterRespawn, EV_MonsterRespawn);
290 /** called when a monster is dropping loot */
291 #define EV_MonsterDropItem(i, o) \
292 /* monster */ i(entity, MUTATOR_ARGV_0_entity) \
293 /* item (can be removed or changed) */ i(entity, MUTATOR_ARGV_1_entity) \
294 /**/ o(entity, MUTATOR_ARGV_1_entity) \
295 /* attacker */ i(entity, MUTATOR_ARGV_2_entity) \
297 .void(entity this) monster_loot;
298 MUTATOR_HOOKABLE(MonsterDropItem, EV_MonsterDropItem);
301 * called when a monster moves
302 * returning true makes the monster stop
304 #define EV_MonsterMove(i, o) \
305 /** monster */ i(entity, MUTATOR_ARGV_0_entity) \
306 /** run speed */ i(float, MUTATOR_ARGV_1_float) \
307 /**/ o(float, MUTATOR_ARGV_1_float) \
308 /** walk speed */ i(float, MUTATOR_ARGV_2_float) \
309 /**/ o(float, MUTATOR_ARGV_2_float) \
310 /** move target */ i(entity, MUTATOR_ARGV_3_entity) \
312 MUTATOR_HOOKABLE(MonsterMove, EV_MonsterMove);
314 /** called when a monster looks for another target */
315 MUTATOR_HOOKABLE(MonsterFindTarget, EV_NO_ARGS);
318 * called when validating a monster's target
320 #define EV_MonsterValidTarget(i, o) \
321 /** monster */ i(entity, MUTATOR_ARGV_0_entity) \
322 /** target */ i(entity, MUTATOR_ARGV_1_entity) \
324 MUTATOR_HOOKABLE(MonsterValidTarget, EV_MonsterValidTarget);
326 /** called to change a random monster to a miniboss */
327 #define EV_MonsterCheckBossFlag(i, o) \
328 /** monster */ i(entity, MUTATOR_ARGV_0_entity) \
330 MUTATOR_HOOKABLE(MonsterCheckBossFlag, EV_MonsterCheckBossFlag);
333 * called when a player tries to spawn a monster
334 * return 1 to prevent spawning
335 * NOTE: requires reason if disallowed
337 #define EV_AllowMobSpawning(i, o) \
338 /** caller */ i(entity, MUTATOR_ARGV_0_entity) \
339 /** reason */ o(string, MUTATOR_ARGV_1_string) \
341 MUTATOR_HOOKABLE(AllowMobSpawning, EV_AllowMobSpawning);
343 /** called when a player gets damaged to e.g. remove stuff he was carrying. */
344 #define EV_PlayerDamage_SplitHealthArmor(i, o) \
345 /** inflictor */ i(entity, MUTATOR_ARGV_0_entity) \
346 /** attacker */ i(entity, MUTATOR_ARGV_1_entity) \
347 /** target */ i(entity, MUTATOR_ARGV_2_entity) \
348 /** force (no out) */ i(vector, MUTATOR_ARGV_3_vector) \
349 /** damage take */ i(float, MUTATOR_ARGV_4_float) \
350 /** damage take */ o(float, MUTATOR_ARGV_4_float) \
351 /** damage save */ i(float, MUTATOR_ARGV_5_float) \
352 /** damage save */ o(float, MUTATOR_ARGV_5_float) \
353 /** deathtype */ i(float, MUTATOR_ARGV_6_float) \
354 /** damage */ i(float, MUTATOR_ARGV_7_float) \
356 MUTATOR_HOOKABLE(PlayerDamage_SplitHealthArmor, EV_PlayerDamage_SplitHealthArmor);
359 * called to adjust damage and force values which are applied to the player, used for e.g. strength damage/force multiplier
360 * i'm not sure if I should change this around slightly (Naming of the entities, and also how they're done in g_damage).
362 #define EV_Damage_Calculate(i, o) \
363 /** inflictor */ i(entity, MUTATOR_ARGV_0_entity) \
364 /** attacker */ i(entity, MUTATOR_ARGV_1_entity) \
365 /** target */ i(entity, MUTATOR_ARGV_2_entity) \
366 /** deathtype */ i(float, MUTATOR_ARGV_3_float) \
367 /** damage */ i(float, MUTATOR_ARGV_4_float) \
368 /** damage */ o(float, MUTATOR_ARGV_4_float) \
369 /** mirrordamage */ i(float, MUTATOR_ARGV_5_float) \
370 /** mirrordamage */ o(float, MUTATOR_ARGV_5_float) \
371 /** force */ i(vector, MUTATOR_ARGV_6_vector) \
372 /** force */ o(vector, MUTATOR_ARGV_6_vector) \
374 MUTATOR_HOOKABLE(Damage_Calculate, EV_Damage_Calculate);
377 * Called when a player is damaged
379 #define EV_PlayerDamaged(i, o) \
380 /** attacker */ i(entity, MUTATOR_ARGV_0_entity) \
381 /** target */ i(entity, MUTATOR_ARGV_1_entity) \
382 /** health */ i(float, MUTATOR_ARGV_2_float) \
383 /** armor */ i(float, MUTATOR_ARGV_3_float) \
384 /** location */ i(vector, MUTATOR_ARGV_4_vector) \
385 /** deathtype */ i(int, MUTATOR_ARGV_5_int) \
386 /** potential_damage */ i(float, MUTATOR_ARGV_6_float) \
388 MUTATOR_HOOKABLE(PlayerDamaged, EV_PlayerDamaged);
391 * Called by W_DecreaseAmmo
393 #define EV_W_DecreaseAmmo(i, o) \
394 /** actor */ i(entity, MUTATOR_ARGV_0_entity) \
395 /** weapon entity */ i(entity, MUTATOR_ARGV_1_entity) \
397 MUTATOR_HOOKABLE(W_DecreaseAmmo, EV_W_DecreaseAmmo);
402 #define EV_W_Reload(i, o) \
403 /** actor */ i(entity, MUTATOR_ARGV_0_entity) \
405 MUTATOR_HOOKABLE(W_Reload, EV_W_Reload);
407 /** called at the end of player_powerups() in client.qc, used for manipulating the values which are set by powerup items. */
408 #define EV_PlayerPowerups(i, o) \
409 /** player */ i(entity, MUTATOR_ARGV_0_entity) \
410 /** old items */ i(int, MUTATOR_ARGV_1_int) \
412 MUTATOR_HOOKABLE(PlayerPowerups, EV_PlayerPowerups);
415 * called every player think frame
416 * return 1 to disable regen
418 #define EV_PlayerRegen(i, o) \
419 /** player */ i(entity, MUTATOR_ARGV_0_entity) \
420 /** max_mod */ i(float, MUTATOR_ARGV_1_float) \
421 /**/ o(float, MUTATOR_ARGV_1_float) \
422 /** regen_mod */ i(float, MUTATOR_ARGV_2_float) \
423 /**/ o(float, MUTATOR_ARGV_2_float) \
424 /** rot_mod */ i(float, MUTATOR_ARGV_3_float) \
425 /**/ o(float, MUTATOR_ARGV_3_float) \
426 /** limit_mod */ i(float, MUTATOR_ARGV_4_float) \
427 /**/ o(float, MUTATOR_ARGV_4_float) \
428 /** health_regen */ i(float, MUTATOR_ARGV_5_float) \
429 /**/ o(float, MUTATOR_ARGV_5_float) \
430 /** health_regenlinear */ i(float, MUTATOR_ARGV_6_float) \
431 /**/ o(float, MUTATOR_ARGV_6_float) \
432 /** health_rot */ i(float, MUTATOR_ARGV_7_float) \
433 /**/ o(float, MUTATOR_ARGV_7_float) \
434 /** health_rotlinear */ i(float, MUTATOR_ARGV_8_float) \
435 /**/ o(float, MUTATOR_ARGV_8_float) \
436 /** health_stable */ i(float, MUTATOR_ARGV_9_float) \
437 /**/ o(float, MUTATOR_ARGV_9_float) \
438 /** health_rotstable */ i(float, MUTATOR_ARGV_10_float) \
439 /**/ o(float, MUTATOR_ARGV_10_float) \
441 MUTATOR_HOOKABLE(PlayerRegen, EV_PlayerRegen);
444 * called when the use key is pressed
445 * if MUTATOR_RETURNVALUE is 1, don't do anything
446 * return 1 if the use key actually did something
448 #define EV_PlayerUseKey(i, o) \
449 /** player */ i(entity, MUTATOR_ARGV_0_entity) \
451 MUTATOR_HOOKABLE(PlayerUseKey, EV_PlayerUseKey);
454 * called when a client command is parsed
455 * NOTE: hooks MUST start with if (MUTATOR_RETURNVALUE) return false;
456 * NOTE: return true if you handled the command, return false to continue handling
457 * NOTE: THESE HOOKS MUST NEVER EVER CALL tokenize()
459 * MUTATOR_HOOKFUNCTION(foo_SV_ParseClientCommand)
461 * if (MUTATOR_RETURNVALUE) // command was already handled?
463 * if (cmd_name == "echocvar" && cmd_argc >= 2)
465 * print(cvar_string(argv(1)), "\n");
468 * if (cmd_name == "echostring" && cmd_argc >= 2)
470 * print(substring(cmd_string, argv_start_index(1), argv_end_index(-1) - argv_start_index(1)), "\n");
476 #define EV_SV_ParseClientCommand(i, o) \
477 /** client sending the command */ i(entity, MUTATOR_ARGV_0_entity) \
478 /** command name */ i(string, MUTATOR_ARGV_1_string) \
479 /** argc (also, argv() can be used) */ i(int, MUTATOR_ARGV_2_int) \
480 /** whole command, use only if you really have to */ i(string, MUTATOR_ARGV_3_string) \
482 MUTATOR_HOOKABLE(SV_ParseClientCommand, EV_SV_ParseClientCommand);
484 /** please read EV_SV_ParseClientCommand description before using */
485 #define EV_SV_ParseServerCommand(i, o) \
486 /** command name */ i(string, MUTATOR_ARGV_0_string) \
487 /** argc (also, argv() can be used) */ i(int, MUTATOR_ARGV_1_int) \
488 /** whole command, use only if you really have to */ i(string, MUTATOR_ARGV_2_string) \
490 MUTATOR_HOOKABLE(SV_ParseServerCommand, EV_SV_ParseServerCommand);
493 * called when a spawnpoint is being evaluated
494 * return 1 to make the spawnpoint unusable
496 #define EV_Spawn_Score(i, o) \
497 /** player wanting to spawn */ i(entity, MUTATOR_ARGV_0_entity) \
498 /** spot to be evaluated */ i(entity, MUTATOR_ARGV_1_entity) \
499 /** spot score, _x is priority, _y is "distance" */ i(vector, MUTATOR_ARGV_2_vector) \
500 /**/ o(vector, MUTATOR_ARGV_2_vector) \
502 MUTATOR_HOOKABLE(Spawn_Score, EV_Spawn_Score);
504 /** runs globally each server frame */
505 MUTATOR_HOOKABLE(SV_StartFrame, EV_NO_ARGS);
507 #define EV_SetModname(i, o) \
508 /** name of the mutator/mod if it warrants showing as such in the server browser */ \
509 /**/ i(string, MUTATOR_ARGV_0_string) \
510 /**/ o(string, MUTATOR_ARGV_0_string) \
512 MUTATOR_HOOKABLE(SetModname, EV_SetModname);
515 * called for each item being spawned on a map, including dropped weapons
516 * return 1 to remove an item
518 #define EV_Item_Spawn(i, o) \
519 /** item */ i(entity, MUTATOR_ARGV_0_entity) \
521 MUTATOR_HOOKABLE(Item_Spawn, EV_Item_Spawn);
523 #define EV_SetWeaponreplace(i, o) \
524 /** map entity */ i(entity, MUTATOR_ARGV_0_entity) \
525 /** weapon info */ i(entity, MUTATOR_ARGV_1_entity) \
526 /** replacement */ i(string, MUTATOR_ARGV_2_string) \
527 /**/ o(string, MUTATOR_ARGV_2_string) \
529 MUTATOR_HOOKABLE(SetWeaponreplace, EV_SetWeaponreplace);
531 /** called when an item is about to respawn */
532 #define EV_Item_RespawnCountdown(i, o) \
533 /** item name */ i(string, MUTATOR_ARGV_0_string) \
534 /**/ o(string, MUTATOR_ARGV_0_string) \
535 /** item colour */ i(vector, MUTATOR_ARGV_1_vector) \
536 /**/ o(vector, MUTATOR_ARGV_1_vector) \
538 MUTATOR_HOOKABLE(Item_RespawnCountdown, EV_Item_RespawnCountdown);
540 /** called when a bot checks a target to attack */
541 #define EV_BotShouldAttack(i, o) \
542 /** bot */ i(entity, MUTATOR_ARGV_0_entity) \
543 /** target */ i(entity, MUTATOR_ARGV_1_entity) \
545 MUTATOR_HOOKABLE(BotShouldAttack, EV_BotShouldAttack);
548 * called whenever a player goes through a portal gun teleport
549 * allows you to strip a player of an item if they go through the teleporter to help prevent cheating
551 #define EV_PortalTeleport(i, o) \
552 /** player */ i(entity, MUTATOR_ARGV_0_entity) \
554 MUTATOR_HOOKABLE(PortalTeleport, EV_PortalTeleport);
557 * called whenever a player uses impulse 33 (help me) in impulse.qc
558 * normally help me ping uses .waypointsprite_attachedforcarrier,
559 * but if your mutator uses something different then you can handle it
560 * in a special manner using this hook
562 #define EV_HelpMePing(i, o) \
563 /** the player who pressed impulse 33 */ i(entity, MUTATOR_ARGV_0_entity) \
565 MUTATOR_HOOKABLE(HelpMePing, EV_HelpMePing);
568 * called when a vehicle initializes
569 * return true to remove the vehicle
571 #define EV_VehicleInit(i, o) \
572 /** vehicle */ i(entity, MUTATOR_ARGV_0_entity) \
574 MUTATOR_HOOKABLE(VehicleInit, EV_VehicleInit);
577 * called when a player enters a vehicle
578 * allows mutators to set special settings in this event
580 #define EV_VehicleEnter(i, o) \
581 /** player */ i(entity, MUTATOR_ARGV_0_entity) \
582 /** vehicle */ i(entity, MUTATOR_ARGV_1_entity) \
584 MUTATOR_HOOKABLE(VehicleEnter, EV_VehicleEnter);
587 * called when a player touches a vehicle
588 * return true to stop player from entering the vehicle
590 #define EV_VehicleTouch(i, o) \
591 /** vehicle */ i(entity, MUTATOR_ARGV_0_entity) \
592 /** player */ i(entity, MUTATOR_ARGV_1_entity) \
594 MUTATOR_HOOKABLE(VehicleTouch, EV_VehicleTouch);
597 * called when a player exits a vehicle
598 * allows mutators to set special settings in this event
600 #define EV_VehicleExit(i, o) \
601 /** player */ i(entity, MUTATOR_ARGV_0_entity) \
602 /** vehicle */ i(entity, MUTATOR_ARGV_1_entity) \
604 MUTATOR_HOOKABLE(VehicleExit, EV_VehicleExit);
606 /** called when a speedrun is aborted and the player is teleported back to start position */
607 #define EV_AbortSpeedrun(i, o) \
608 /** player */ i(entity, MUTATOR_ARGV_0_entity) \
610 MUTATOR_HOOKABLE(AbortSpeedrun, EV_AbortSpeedrun);
612 /** called at when a item is touched. Called early, can edit item properties. */
613 #define EV_ItemTouch(i, o) \
614 /** item */ i(entity, MUTATOR_ARGV_0_entity) \
615 /** toucher */ i(entity, MUTATOR_ARGV_1_entity) \
616 /**/ o(entity, MUTATOR_ARGV_1_entity) \
618 MUTATOR_HOOKABLE(ItemTouch, EV_ItemTouch);
621 MUT_ITEMTOUCH_CONTINUE, // return this flag to make the function continue as normal
622 MUT_ITEMTOUCH_RETURN, // return this flag to make the function return (handled entirely by mutator)
623 MUT_ITEMTOUCH_PICKUP // return this flag to have the item "picked up" and taken even after mutator handled it
626 /** called at when a player connect */
627 #define EV_ClientConnect(i, o) \
628 /** player */ i(entity, MUTATOR_ARGV_0_entity) \
630 MUTATOR_HOOKABLE(ClientConnect, EV_ClientConnect);
632 #define EV_HavocBot_ChooseRole(i, o) \
633 /** bot */ i(entity, MUTATOR_ARGV_0_entity) \
635 MUTATOR_HOOKABLE(HavocBot_ChooseRole, EV_HavocBot_ChooseRole);
637 /** called when a target is checked for accuracy */
638 #define EV_AccuracyTargetValid(i, o) \
639 /** attacker */ i(entity, MUTATOR_ARGV_0_entity) \
640 /** target */ i(entity, MUTATOR_ARGV_1_entity) \
642 MUTATOR_HOOKABLE(AccuracyTargetValid, EV_AccuracyTargetValid);
644 MUT_ACCADD_VALID, // return this flag to make the function continue if target is a client
645 MUT_ACCADD_INVALID, // return this flag to make the function always continue
646 MUT_ACCADD_INDIFFERENT // return this flag to make the function always return
649 /** Called when clearing the global parameters for a model */
650 MUTATOR_HOOKABLE(ClearModelParams, EV_NO_ARGS);
652 /** Called when getting the global parameters for a model */
653 #define EV_GetModelParams(i, o) \
654 /** input */ i(string, MUTATOR_ARGV_0_string) \
655 /** command */ i(string, MUTATOR_ARGV_1_string) \
657 MUTATOR_HOOKABLE(GetModelParams, EV_GetModelParams);
659 /** called when a bullet has hit a target */
660 #define EV_FireBullet_Hit(i, o) \
661 /** player */ i(entity, MUTATOR_ARGV_0_entity) \
662 /** targ */ i(entity, MUTATOR_ARGV_1_entity) \
663 /** start pos */ i(vector, MUTATOR_ARGV_2_vector) \
664 /** end pos */ i(vector, MUTATOR_ARGV_3_vector) \
665 /** damage */ i(float, MUTATOR_ARGV_4_float) \
666 /**/ o(float, MUTATOR_ARGV_4_float) \
667 /** wep entity */ i(entity, MUTATOR_ARGV_5_entity) \
669 MUTATOR_HOOKABLE(FireBullet_Hit, EV_FireBullet_Hit);
671 #define EV_FixPlayermodel(i, o) \
672 /** model */ i(string, MUTATOR_ARGV_0_string) \
673 /**/ o(string, MUTATOR_ARGV_0_string) \
674 /** skin */ i(int, MUTATOR_ARGV_1_int) \
675 /**/ o(int, MUTATOR_ARGV_1_int) \
676 /** player */ i(entity, MUTATOR_ARGV_2_entity) \
678 MUTATOR_HOOKABLE(FixPlayermodel, EV_FixPlayermodel);
680 /** Return error to play frag remaining announcements */
681 MUTATOR_HOOKABLE(Scores_CountFragsRemaining, EV_NO_ARGS);
683 #define EV_GrappleHookThink(i, o) \
684 /** hook */ i(entity, MUTATOR_ARGV_0_entity) \
685 /** tarzan */ i(int, MUTATOR_ARGV_1_int) \
686 /**/ o(int, MUTATOR_ARGV_1_int) \
687 /** pulling entity */ i(entity, MUTATOR_ARGV_2_entity) \
688 /**/ o(entity, MUTATOR_ARGV_2_entity) \
689 /** velocity multiplier */ i(float, MUTATOR_ARGV_3_float) \
690 /**/ o(float, MUTATOR_ARGV_3_float) \
692 MUTATOR_HOOKABLE(GrappleHookThink, EV_GrappleHookThink);
694 #define EV_BuffModel_Customize(i, o) \
695 /** buff */ i(entity, MUTATOR_ARGV_0_entity) \
696 /** player */ i(entity, MUTATOR_ARGV_1_entity) \
698 MUTATOR_HOOKABLE(BuffModel_Customize, EV_BuffModel_Customize);
700 /** called at when a buff is touched. Called early, can edit buff properties. */
701 #define EV_BuffTouch(i, o) \
702 /** buff */ i(entity, MUTATOR_ARGV_0_entity) \
703 /** player */ i(entity, MUTATOR_ARGV_1_entity) \
704 /**/ o(entity, MUTATOR_ARGV_1_entity) \
706 MUTATOR_HOOKABLE(BuffTouch, EV_BuffTouch);
708 MUTATOR_HOOKABLE(SetNewParms, EV_NO_ARGS);
710 MUTATOR_HOOKABLE(SetChangeParms, EV_NO_ARGS);
712 MUTATOR_HOOKABLE(DecodeLevelParms, EV_NO_ARGS);
714 #define EV_GetRecords(i, o) \
715 /** page */ i(int, MUTATOR_ARGV_0_int) \
716 /** record list */ i(string, MUTATOR_ARGV_1_string) \
717 /**/ o(string, MUTATOR_ARGV_1_string) \
719 MUTATOR_HOOKABLE(GetRecords, EV_GetRecords);
721 #define EV_Race_FinalCheckpoint(i, o) \
722 /** player */ i(entity, MUTATOR_ARGV_0_entity) \
724 MUTATOR_HOOKABLE(Race_FinalCheckpoint, EV_Race_FinalCheckpoint);
726 /** called when player triggered kill (or is changing teams), return error to not do anything */
727 #define EV_ClientKill(i, o) \
728 /** player */ i(entity, MUTATOR_ARGV_0_entity) \
729 /** kill delay */ i(float, MUTATOR_ARGV_1_float) \
730 /**/ o(float, MUTATOR_ARGV_1_float) \
732 MUTATOR_HOOKABLE(ClientKill, EV_ClientKill);
734 #define EV_FixClientCvars(i, o) \
735 /** player */ i(entity, MUTATOR_ARGV_0_entity) \
737 MUTATOR_HOOKABLE(FixClientCvars, EV_FixClientCvars);
739 #define EV_SpectateSet(i, o) \
740 /** client */ i(entity, MUTATOR_ARGV_0_entity) \
741 /** target */ i(entity, MUTATOR_ARGV_1_entity) \
742 /**/ o(entity, MUTATOR_ARGV_1_entity) \
744 MUTATOR_HOOKABLE(SpectateSet, EV_SpectateSet);
746 #define EV_SpectateNext(i, o) \
747 /** client */ i(entity, MUTATOR_ARGV_0_entity) \
748 /** target */ i(entity, MUTATOR_ARGV_1_entity) \
749 /**/ o(entity, MUTATOR_ARGV_1_entity) \
751 MUTATOR_HOOKABLE(SpectateNext, EV_SpectateNext);
753 #define EV_SpectatePrev(i, o) \
754 /** client */ i(entity, MUTATOR_ARGV_0_entity) \
755 /** target */ i(entity, MUTATOR_ARGV_1_entity) \
756 /**/ o(entity, MUTATOR_ARGV_1_entity) \
757 /** first */ i(entity, MUTATOR_ARGV_2_entity) \
759 MUTATOR_HOOKABLE(SpectatePrev, EV_SpectatePrev);
762 MUT_SPECPREV_CONTINUE, // return this flag to make the function continue as normal
763 MUT_SPECPREV_RETURN, // return this flag to make the function return (handled entirely by mutator)
764 MUT_SPECPREV_FOUND // return this flag to make the function continue without default functions (handled mostly by mutator)
767 /** called when player triggered kill (or is changing teams), return error to not do anything */
768 #define EV_Bot_FixCount(i, o) \
769 /** active real players */ i(int, MUTATOR_ARGV_0_int) \
770 /**/ o(int, MUTATOR_ARGV_0_int) \
771 /** real players */ i(int, MUTATOR_ARGV_1_int) \
772 /**/ o(int, MUTATOR_ARGV_1_int) \
774 MUTATOR_HOOKABLE(Bot_FixCount, EV_Bot_FixCount);
776 #define EV_ClientCommand_Spectate(i, o) \
777 /** player */ i(entity, MUTATOR_ARGV_0_entity) \
779 MUTATOR_HOOKABLE(ClientCommand_Spectate, EV_ClientCommand_Spectate);
782 MUT_SPECCMD_CONTINUE, // return this flag to make the function continue as normal
783 MUT_SPECCMD_RETURN, // return this flag to make the function return (don't spectate)
784 MUT_SPECCMD_FORCE // return this flag to force the player to spectate, even if they're not a player
787 #define EV_CheckRules_World(i, o) \
788 /** status */ i(float, MUTATOR_ARGV_0_float) \
789 /**/ o(float, MUTATOR_ARGV_0_float) \
790 /* time limit */ i(float, MUTATOR_ARGV_1_float) \
791 /* frag limit */ i(float, MUTATOR_ARGV_2_float) \
793 MUTATOR_HOOKABLE(CheckRules_World, EV_CheckRules_World);
795 #define EV_WantWeapon(i, o) \
796 /** weapon info entity */ i(entity, MUTATOR_ARGV_0_entity) \
797 /** do want? */ i(float, MUTATOR_ARGV_1_float) \
798 /**/ o(float, MUTATOR_ARGV_1_float) \
799 /** want all guns */ i(bool, MUTATOR_ARGV_2_bool) \
800 /**/ o(bool, MUTATOR_ARGV_2_bool) \
801 /** want mutator blocked */ i(bool, MUTATOR_ARGV_3_bool) \
802 /**/ o(bool, MUTATOR_ARGV_3_bool) \
804 MUTATOR_HOOKABLE(WantWeapon, EV_WantWeapon);
806 #define EV_AddPlayerScore(i, o) \
807 /** score field */ i(PlayerScoreField, MUTATOR_ARGV_0_entity) \
808 /** score */ i(float, MUTATOR_ARGV_1_float) \
809 /**/ o(float, MUTATOR_ARGV_1_float) \
810 /** player */ i(entity, MUTATOR_ARGV_2_entity) \
812 MUTATOR_HOOKABLE(AddPlayerScore, EV_AddPlayerScore);
814 #define EV_GetPlayerStatus(i, o) \
815 /** player */ i(entity, MUTATOR_ARGV_0_entity) \
817 MUTATOR_HOOKABLE(GetPlayerStatus, EV_GetPlayerStatus);
819 #define EV_SetWeaponArena(i, o) \
820 /** arena */ i(string, MUTATOR_ARGV_0_string) \
821 /**/ o(string, MUTATOR_ARGV_0_string) \
823 MUTATOR_HOOKABLE(SetWeaponArena, EV_SetWeaponArena);
825 #define EV_DropSpecialItems(i, o) \
826 /** target */ i(entity, MUTATOR_ARGV_0_entity) \
828 MUTATOR_HOOKABLE(DropSpecialItems, EV_DropSpecialItems);
831 * called when an admin tries to kill all monsters
832 * return 1 to prevent spawning
834 #define EV_AllowMobButcher(i, o) \
835 /** reason */ o(string, MUTATOR_ARGV_0_string) \
837 MUTATOR_HOOKABLE(AllowMobButcher, EV_AllowMobButcher);
839 MUTATOR_HOOKABLE(ReadLevelCvars, EV_NO_ARGS);
841 #define EV_SendWaypoint(i, o) \
842 /** waypoint */ i(entity, MUTATOR_ARGV_0_entity) \
843 /** to */ i(entity, MUTATOR_ARGV_1_entity) \
844 /** send flags */ i(int, MUTATOR_ARGV_2_int) \
845 /**/ o(int, MUTATOR_ARGV_2_int) \
846 /** wp flag */ i(int, MUTATOR_ARGV_3_int) \
847 /**/ o(int, MUTATOR_ARGV_3_int) \
849 MUTATOR_HOOKABLE(SendWaypoint, EV_SendWaypoint);
851 #define EV_TurretValidateTarget(i, o) \
852 /** turret */ i(entity, MUTATOR_ARGV_0_entity) \
853 /** target */ i(entity, MUTATOR_ARGV_1_entity) \
854 /** validate flags */ i(int, MUTATOR_ARGV_2_int) \
855 /** target score */ o(float, MUTATOR_ARGV_3_float) \
857 MUTATOR_HOOKABLE(TurretValidateTarget, EV_TurretValidateTarget);
859 #define EV_TurretThink(i, o) \
860 /** turret */ i(entity, MUTATOR_ARGV_0_entity) \
862 MUTATOR_HOOKABLE(TurretThink, EV_TurretThink);
864 MUTATOR_HOOKABLE(Ent_Init, EV_NO_ARGS);
867 #define EV_PrepareExplosionByDamage(i, o) \
868 /** projectile */ i(entity, MUTATOR_ARGV_0_entity) \
869 /** attacker */ i(entity, MUTATOR_ARGV_1_entity) \
871 MUTATOR_HOOKABLE(PrepareExplosionByDamage, EV_PrepareExplosionByDamage);
873 /** called when a monster model is about to be set, allows custom paths etc. */
874 #define EV_MonsterModel(i, o) \
875 /** model */ i(string, MUTATOR_ARGV_0_string) \
876 /** output */ i(string, MUTATOR_ARGV_1_string) \
877 /**/ o(string, MUTATOR_ARGV_1_string) \
879 MUTATOR_HOOKABLE(MonsterModel, EV_MonsterModel);
882 #define EV_Player_ChangeTeam(i, o) \
883 /** player */ i(entity, MUTATOR_ARGV_0_entity) \
884 /** current team */ i(float, MUTATOR_ARGV_1_float) \
885 /** new team */ i(float, MUTATOR_ARGV_2_float) \
887 MUTATOR_HOOKABLE(Player_ChangeTeam, EV_Player_ChangeTeam);
890 #define EV_URI_GetCallback(i, o) \
891 /** id */ i(float, MUTATOR_ARGV_0_float) \
892 /** status */ i(float, MUTATOR_ARGV_1_float) \
893 /** data */ i(string, MUTATOR_ARGV_2_string) \
895 MUTATOR_HOOKABLE(URI_GetCallback, EV_URI_GetCallback);
898 * return true to prevent weapon use for a player
900 #define EV_ForbidWeaponUse(i, o) \
901 /** player */ i(entity, MUTATOR_ARGV_0_entity) \
903 MUTATOR_HOOKABLE(ForbidWeaponUse, EV_ForbidWeaponUse);
905 /** called when creating a clone of the player (usually for corpses that stay after the player has re-spawned) */
906 #define EV_CopyBody(i, o) \
907 /** player */ i(entity, MUTATOR_ARGV_0_entity) \
908 /** newly created clone */ i(entity, MUTATOR_ARGV_1_entity) \
909 /** keepvelocity? */ i(bool, MUTATOR_ARGV_2_bool) \
911 MUTATOR_HOOKABLE(CopyBody, EV_CopyBody);
913 /** called when sending a chat message, ret argument can be changed to prevent the message */
914 #define EV_ChatMessage(i, o) \
915 /** sender */ i(entity, MUTATOR_ARGV_0_entity) \
916 /** ret */ i(int, MUTATOR_ARGV_1_int) \
917 /**/ o(int, MUTATOR_ARGV_1_int) \
919 MUTATOR_HOOKABLE(ChatMessage, EV_ChatMessage);
921 /** return true to prevent sending a chat (private, team or regular) message from reaching a certain player */
922 #define EV_ChatMessageTo(i, o) \
923 /** destination player */ i(entity, MUTATOR_ARGV_0_entity) \
924 /** sender */ i(entity, MUTATOR_ARGV_1_entity) \
926 MUTATOR_HOOKABLE(ChatMessageTo, EV_ChatMessageTo);
928 /** return true to just restart the match, for modes that don't support readyrestart */
929 MUTATOR_HOOKABLE(ReadyRestart_Deny, EV_NO_ARGS);