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) \
10 MUTATOR_HOOKABLE(MakePlayerObserver, EV_MakePlayerObserver)
13 #define EV_PutClientInServer(i, o) \
14 /** client wanting to spawn */ i(entity, __self) \
16 MUTATOR_HOOKABLE(PutClientInServer, EV_PutClientInServer);
18 /** called when a player spawns as player, after shared setup, before his weapon is chosen (so items may be changed in here) */
19 #define EV_PlayerSpawn(i, o) \
20 /** spot that was used, or world */ i(entity, spawn_spot) \
23 MUTATOR_HOOKABLE(PlayerSpawn, EV_PlayerSpawn);
25 /** called in reset_map */
26 #define EV_reset_map_global(i, o) \
28 MUTATOR_HOOKABLE(reset_map_global, EV_reset_map_global);
30 /** called in reset_map */
31 #define EV_reset_map_players(i, o) \
33 MUTATOR_HOOKABLE(reset_map_players, EV_reset_map_players);
35 /** returns 1 if clearing player score shall not be allowed */
36 #define EV_ForbidPlayerScore_Clear(i, o) \
38 MUTATOR_HOOKABLE(ForbidPlayerScore_Clear, EV_ForbidPlayerScore_Clear);
40 /** called when a player disconnects */
41 #define EV_ClientDisconnect(i, o) \
43 MUTATOR_HOOKABLE(ClientDisconnect, EV_ClientDisconnect);
45 /** called when a player dies to e.g. remove stuff he was carrying. */
46 #define EV_PlayerDies(i, o) \
47 /**/ i(entity, frag_inflictor) \
48 /**/ i(entity, frag_attacker) \
49 /** same as self */ i(entity, frag_target) \
50 /**/ i(int, frag_deathtype) \
52 entity frag_inflictor;
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 /**/ i(entity, frag_victim) \
63 MUTATOR_HOOKABLE(PlayHitsound, EV_PlayHitsound);
65 /** called when a weapon sound is about to be played, allows custom paths etc. */
66 #define EV_WeaponSound(i, o) \
67 /**/ i(string, weapon_sound) \
68 /**/ i(string, weapon_sound_output) \
69 /**/ o(string, weapon_sound_output) \
72 string weapon_sound_output;
73 MUTATOR_HOOKABLE(WeaponSound, EV_WeaponSound);
75 /** called when an item model is about to be set, allows custom paths etc. */
76 #define EV_ItemModel(i, o) \
77 /**/ i(string, item_model) \
78 /**/ i(string, item_model_output) \
79 /**/ o(string, item_model_output) \
82 string item_model_output;
83 MUTATOR_HOOKABLE(ItemModel, EV_ItemModel);
85 /** called when someone was fragged by "self", and is expected to change frag_score to adjust scoring for the kill */
86 #define EV_GiveFragsForKill(i, o) \
87 /**/ i(entity, __self) \
88 /** same as self */ i(entity, frag_attacker) \
89 /**/ i(entity, frag_target) \
90 /**/ i(float, frag_score) \
91 /**/ o(float, frag_score) \
94 MUTATOR_HOOKABLE(GiveFragsForKill, EV_GiveFragsForKill);
96 /** called when the match ends */
97 MUTATOR_HOOKABLE(MatchEnd, EV_NO_ARGS);
99 /** should adjust ret_float to contain the team count */
100 #define EV_GetTeamCount(i, o) \
101 /**/ i(float, ret_float) \
102 /**/ o(float, ret_float) \
103 /**/ i(string, ret_string) \
104 /**/ o(string, ret_string) \
107 MUTATOR_HOOKABLE(GetTeamCount, EV_GetTeamCount);
109 /** copies variables for spectating "other" to "self" */
110 #define EV_SpectateCopy(i, o) \
111 /**/ i(entity, other) \
112 /**/ i(entity, __self) \
114 MUTATOR_HOOKABLE(SpectateCopy, EV_SpectateCopy);
116 /** called when formatting a chat message to replace fancy functions */
117 #define EV_FormatMessage(i, o) \
118 /**/ i(string, format_escape) \
119 /**/ i(string, format_replacement) \
120 /**/ o(string, format_replacement) \
121 /**/ i(string, format_message) \
123 string format_escape;
124 string format_replacement;
125 string format_message;
126 MUTATOR_HOOKABLE(FormatMessage, EV_FormatMessage);
128 /** returns true if throwing the current weapon shall not be allowed */
129 MUTATOR_HOOKABLE(ForbidThrowCurrentWeapon, EV_NO_ARGS);
131 /** returns true if dropping the current weapon shall not be allowed at any time including death */
132 MUTATOR_HOOKABLE(ForbidDropCurrentWeapon, EV_NO_ARGS);
135 MUTATOR_HOOKABLE(SetDefaultAlpha, EV_NO_ARGS);
137 /** allows changing attack rate */
138 #define EV_WeaponRateFactor(i, o) \
139 /**/ i(float, weapon_rate) \
140 /**/ o(float, weapon_rate) \
143 MUTATOR_HOOKABLE(WeaponRateFactor, EV_WeaponRateFactor);
145 /** allows changing weapon speed (projectiles mostly) */
146 #define EV_WeaponSpeedFactor(i, o) \
147 /**/ i(float, ret_float) \
148 /**/ o(float, ret_float) \
150 MUTATOR_HOOKABLE(WeaponSpeedFactor, EV_WeaponSpeedFactor);
152 /** adjusts {warmup_}start_{items,weapons,ammo_{cells,plasma,rockets,nails,shells,fuel}} */
153 MUTATOR_HOOKABLE(SetStartItems, EV_NO_ARGS);
155 /** called every frame. customizes the waypoint for spectators */
156 #define EV_CustomizeWaypoint(i, o) \
157 /** waypoint */ i(entity, __self) \
158 /** player; other.enemy = spectator */ i(entity, other) \
160 MUTATOR_HOOKABLE(CustomizeWaypoint, EV_CustomizeWaypoint);
163 * 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)
164 * return error to request removal
166 #define EV_FilterItem(i, o) \
167 /** the current item */ i(entity, __self) \
169 MUTATOR_HOOKABLE(FilterItem, EV_FilterItem);
171 /** return error to request removal */
172 #define EV_TurretSpawn(i, o) \
173 /** turret */ i(entity, __self) \
175 MUTATOR_HOOKABLE(TurretSpawn, EV_TurretSpawn);
177 /** return error to not attack */
178 #define EV_TurretFire(i, o) \
179 /** turret */ i(entity, __self) \
181 MUTATOR_HOOKABLE(TurretFire, EV_TurretFire);
183 /** return error to not attack */
184 #define EV_Turret_CheckFire(i, o) \
185 /**/ i(bool, ret_bool) \
186 /**/ o(bool, ret_bool) \
189 MUTATOR_HOOKABLE(Turret_CheckFire, EV_Turret_CheckFire);
191 /** return error to prevent entity spawn, or modify the entity */
192 MUTATOR_HOOKABLE(OnEntityPreSpawn, EV_NO_ARGS);
194 /** runs in the event loop for players; is called for ALL player entities, also bots, also the dead, or spectators */
195 MUTATOR_HOOKABLE(PlayerPreThink, EV_NO_ARGS);
197 /** TODO change this into a general PlayerPostThink hook? */
198 MUTATOR_HOOKABLE(GetPressedKeys, EV_NO_ARGS);
200 /** is meant to call GetCvars_handle*(get_cvars_s, get_cvars_f, cvarfield, "cvarname") for cvars this mutator needs from the client */
201 #define EV_GetCvars(i, o) \
202 /**/ i(float, get_cvars_f) \
203 /**/ i(string, get_cvars_s) \
207 MUTATOR_HOOKABLE(GetCvars, EV_NO_ARGS); // NOTE: Can't use EV_GetCvars because of `SZ_GetSpace: overflow`
209 /** can edit any "just fired" projectile */
210 #define EV_EditProjectile(i, o) \
211 /**/ i(entity, __self) \
212 /**/ i(entity, other) \
214 MUTATOR_HOOKABLE(EditProjectile, EV_EditProjectile);
216 /** called when a monster spawns */
217 #define EV_MonsterSpawn(i, o) \
218 /**/ i(entity, __self) \
220 MUTATOR_HOOKABLE(MonsterSpawn, EV_MonsterSpawn);
222 /** called when a monster dies */
223 #define EV_MonsterDies(i, o) \
224 /**/ i(entity, frag_target) \
225 /**/ i(entity, frag_attacker) \
227 MUTATOR_HOOKABLE(MonsterDies, EV_MonsterDies);
229 /** called when a monster dies */
230 #define EV_MonsterRemove(i, o) \
231 /**/ i(entity, rem_mon) \
233 entity rem_mon; // avoiding ovewriting self & other
234 MUTATOR_HOOKABLE(MonsterRemove, EV_MonsterRemove);
236 /** called when a monster wants to respawn */
237 #define EV_MonsterRespawn(i, o) \
238 /**/ i(entity, other) \
240 MUTATOR_HOOKABLE(MonsterRespawn, EV_MonsterRespawn);
242 /** called when a monster is dropping loot */
243 #define EV_MonsterDropItem(i, o) \
244 /**/ i(entity, other) \
245 /**/ o(entity, other) \
247 .void(entity this) monster_loot;
248 MUTATOR_HOOKABLE(MonsterDropItem, EV_MonsterDropItem);
251 * called when a monster moves
252 * returning true makes the monster stop
254 #define EV_MonsterMove(i, o) \
255 /**/ i(entity, __self) \
256 /**/ i(float, monster_speed_run) \
257 /**/ o(float, monster_speed_run) \
258 /**/ i(float, monster_speed_walk) \
259 /**/ o(float, monster_speed_walk) \
260 /**/ i(entity, monster_target) \
262 float monster_speed_run;
263 float monster_speed_walk;
264 entity monster_target;
265 MUTATOR_HOOKABLE(MonsterMove, EV_MonsterMove);
267 /** called when a monster looks for another target */
268 MUTATOR_HOOKABLE(MonsterFindTarget, EV_NO_ARGS);
270 /** called to change a random monster to a miniboss */
271 #define EV_MonsterCheckBossFlag(i, o) \
272 /**/ i(entity, __self) \
274 MUTATOR_HOOKABLE(MonsterCheckBossFlag, EV_MonsterCheckBossFlag);
277 * called when a player tries to spawn a monster
278 * return 1 to prevent spawning
280 MUTATOR_HOOKABLE(AllowMobSpawning, EV_NO_ARGS);
282 /** called when a player gets damaged to e.g. remove stuff he was carrying. */
283 #define EV_PlayerDamage_SplitHealthArmor(i, o) \
284 /**/ i(entity, frag_inflictor) \
285 /**/ i(entity, frag_attacker) \
286 /** same as self */ i(entity, frag_target) \
287 /** NOTE: this force already HAS been applied */ i(vector, damage_force) \
288 /**/ i(float, damage_take) \
289 /**/ o(float, damage_take) \
290 /**/ i(float, damage_save) \
291 /**/ o(float, damage_save) \
296 MUTATOR_HOOKABLE(PlayerDamage_SplitHealthArmor, EV_PlayerDamage_SplitHealthArmor);
299 * called to adjust damage and force values which are applied to the player, used for e.g. strength damage/force multiplier
300 * i'm not sure if I should change this around slightly (Naming of the entities, and also how they're done in g_damage).
302 #define EV_PlayerDamage_Calculate(i, o) \
303 /**/ i(entity, frag_inflictor) \
304 /**/ i(entity, frag_attacker) \
305 /**/ i(entity, frag_target) \
306 /**/ i(float, frag_deathtype) \
307 /**/ i(float, frag_damage) \
308 /**/ o(float, frag_damage) \
309 /**/ i(float, frag_mirrordamage) \
310 /**/ o(float, frag_mirrordamage) \
311 /**/ i(vector, frag_force) \
312 /**/ o(vector, frag_force) \
315 float frag_mirrordamage;
317 MUTATOR_HOOKABLE(PlayerDamage_Calculate, EV_PlayerDamage_Calculate);
320 * Called when a player is damaged
322 #define EV_PlayerDamaged(i, o) \
323 /** attacker */ i(entity, MUTATOR_ARGV_0_entity) \
324 /** target */ i(entity, MUTATOR_ARGV_1_entity) \
325 /** health */ i(int, MUTATOR_ARGV_0_int) \
326 /** armor */ i(int, MUTATOR_ARGV_1_int) \
327 /** location */ i(vector, MUTATOR_ARGV_0_vector) \
328 /** deathtype */ i(int, MUTATOR_ARGV_2_int) \
330 MUTATOR_HOOKABLE(PlayerDamaged, EV_PlayerDamaged);
333 * Called by W_DecreaseAmmo
335 #define EV_W_DecreaseAmmo(i, o) \
336 /** actor */ i(entity, MUTATOR_ARGV_0_entity) \
338 MUTATOR_HOOKABLE(W_DecreaseAmmo, EV_W_DecreaseAmmo);
343 #define EV_W_Reload(i, o) \
344 /** actor */ i(entity, MUTATOR_ARGV_0_entity) \
346 MUTATOR_HOOKABLE(W_Reload, EV_W_Reload);
348 /** called at the end of player_powerups() in cl_client.qc, used for manipulating the values which are set by powerup items. */
349 #define EV_PlayerPowerups(i, o) \
350 /**/ i(entity, __self) \
351 /**/ i(int, olditems) \
354 MUTATOR_HOOKABLE(PlayerPowerups, EV_PlayerPowerups);
357 * called every player think frame
358 * return 1 to disable regen
361 float regen_mod_regen;
363 float regen_mod_limit;
365 float regen_health_linear;
366 float regen_health_rot;
367 float regen_health_rotlinear;
368 float regen_health_stable;
369 float regen_health_rotstable;
370 MUTATOR_HOOKABLE(PlayerRegen, EV_NO_ARGS);
373 * called when the use key is pressed
374 * if MUTATOR_RETURNVALUE is 1, don't do anything
375 * return 1 if the use key actually did something
377 MUTATOR_HOOKABLE(PlayerUseKey, EV_NO_ARGS);
380 * called when a client command is parsed
381 * NOTE: hooks MUST start with if (MUTATOR_RETURNVALUE) return false;
382 * NOTE: return true if you handled the command, return false to continue handling
383 * NOTE: THESE HOOKS MUST NEVER EVER CALL tokenize()
385 * MUTATOR_HOOKFUNCTION(foo_SV_ParseClientCommand)
387 * if (MUTATOR_RETURNVALUE) // command was already handled?
389 * if (cmd_name == "echocvar" && cmd_argc >= 2)
391 * print(cvar_string(argv(1)), "\n");
394 * if (cmd_name == "echostring" && cmd_argc >= 2)
396 * print(substring(cmd_string, argv_start_index(1), argv_end_index(-1) - argv_start_index(1)), "\n");
402 #define EV_SV_ParseClientCommand(i, o) \
403 /** command name */ i(string, cmd_name) \
404 /** also, argv() can be used */ i(int, cmd_argc) \
405 /** whole command, use only if you really have to */ i(string, cmd_string) \
410 MUTATOR_HOOKABLE(SV_ParseClientCommand, EV_SV_ParseClientCommand);
412 /** please read EV_SV_ParseClientCommand description before using */
413 #define EV_SV_ParseServerCommand(i, o) \
414 /** command name */ i(string, cmd_name) \
415 /** also, argv() can be used */ i(int, cmd_argc) \
416 /** whole command, use only if you really have to */ i(string, cmd_string) \
421 MUTATOR_HOOKABLE(SV_ParseServerCommand, EV_SV_ParseServerCommand);
424 * called when a spawnpoint is being evaluated
425 * return 1 to make the spawnpoint unusable
427 #define EV_Spawn_Score(i, o) \
428 /** player wanting to spawn */ i(entity, __self) \
429 /** spot to be evaluated */ i(entity, spawn_spot) \
430 /** _x is priority, _y is "distance" */ i(vector, spawn_score) \
431 /**/ o(vector, spawn_score) \
434 MUTATOR_HOOKABLE(Spawn_Score, EV_Spawn_Score);
436 /** runs globally each server frame */
437 MUTATOR_HOOKABLE(SV_StartFrame, EV_NO_ARGS);
439 #define EV_SetModname(i, o) \
440 /** name of the mutator/mod if it warrants showing as such in the server browser */ \
443 MUTATOR_HOOKABLE(SetModname, EV_SetModname);
446 * called for each item being spawned on a map, including dropped weapons
447 * return 1 to remove an item
449 #define EV_Item_Spawn(i, o) \
450 /** the item */ i(entity, __self) \
452 MUTATOR_HOOKABLE(Item_Spawn, EV_Item_Spawn);
454 #define EV_SetWeaponreplace(i, o) \
455 /** map entity */ i(entity, __self) \
456 /** weapon info */ i(entity, other) \
457 /**/ i(string, ret_string) \
458 /**/ o(string, ret_string) \
460 MUTATOR_HOOKABLE(SetWeaponreplace, EV_SetWeaponreplace);
462 /** called when an item is about to respawn */
463 #define EV_Item_RespawnCountdown(i, o) \
464 /**/ i(string, item_name) \
465 /**/ o(string, item_name) \
466 /**/ i(vector, item_color) \
467 /**/ o(vector, item_color) \
471 MUTATOR_HOOKABLE(Item_RespawnCountdown, EV_Item_RespawnCountdown);
473 /** called when a bot checks a target to attack */
474 #define EV_BotShouldAttack(i, o) \
475 /**/ i(entity, checkentity) \
478 MUTATOR_HOOKABLE(BotShouldAttack, EV_BotShouldAttack);
481 * called whenever a player goes through a portal gun teleport
482 * allows you to strip a player of an item if they go through the teleporter to help prevent cheating
484 #define EV_PortalTeleport(i, o) \
485 /**/ i(entity, __self) \
487 MUTATOR_HOOKABLE(PortalTeleport, EV_PortalTeleport);
490 * called whenever a player uses impulse 33 (help me) in cl_impulse.qc
491 * normally help me ping uses self.waypointsprite_attachedforcarrier,
492 * but if your mutator uses something different then you can handle it
493 * in a special manner using this hook
495 #define EV_HelpMePing(i, o) \
496 /** the player who pressed impulse 33 */ i(entity, __self) \
498 MUTATOR_HOOKABLE(HelpMePing, EV_HelpMePing);
501 * called when a vehicle initializes
502 * return true to remove the vehicle
504 MUTATOR_HOOKABLE(VehicleSpawn, EV_NO_ARGS);
507 * called when a player enters a vehicle
508 * allows mutators to set special settings in this event
510 #define EV_VehicleEnter(i, o) \
511 /** player */ i(entity, vh_player) \
512 /** vehicle */ i(entity, vh_vehicle) \
516 MUTATOR_HOOKABLE(VehicleEnter, EV_VehicleEnter);
519 * called when a player touches a vehicle
520 * return true to stop player from entering the vehicle
522 #define EV_VehicleTouch(i, o) \
523 /** vehicle */ i(entity, __self) \
524 /** player */ i(entity, other) \
526 MUTATOR_HOOKABLE(VehicleTouch, EV_VehicleTouch);
529 * called when a player exits a vehicle
530 * allows mutators to set special settings in this event
532 #define EV_VehicleExit(i, o) \
533 /** player */ i(entity, vh_player) \
534 /** vehicle */ i(entity, vh_vehicle) \
536 MUTATOR_HOOKABLE(VehicleExit, EV_VehicleExit);
538 /** called when a speedrun is aborted and the player is teleported back to start position */
539 #define EV_AbortSpeedrun(i, o) \
540 /** player */ i(entity, __self) \
542 MUTATOR_HOOKABLE(AbortSpeedrun, EV_AbortSpeedrun);
544 /** called at when a item is touched. Called early, can edit item properties. */
545 #define EV_ItemTouch(i, o) \
546 /** item */ i(entity, __self) \
547 /** player */ i(entity, other) \
549 MUTATOR_HOOKABLE(ItemTouch, EV_ItemTouch);
552 MUT_ITEMTOUCH_CONTINUE, // return this flag to make the function continue as normal
553 MUT_ITEMTOUCH_RETURN, // return this flag to make the function return (handled entirely by mutator)
554 MUT_ITEMTOUCH_PICKUP // return this flag to have the item "picked up" and taken even after mutator handled it
557 /** called at when a player connect */
558 #define EV_ClientConnect(i, o) \
559 /** player */ i(entity, __self) \
561 MUTATOR_HOOKABLE(ClientConnect, EV_ClientConnect);
563 #define EV_HavocBot_ChooseRole(i, o) \
564 /**/ i(entity, __self) \
566 MUTATOR_HOOKABLE(HavocBot_ChooseRole, EV_HavocBot_ChooseRole);
568 /** called when a target is checked for accuracy */
569 #define EV_AccuracyTargetValid(i, o) \
570 /** attacker */ i(entity, frag_attacker) \
571 /** target */ i(entity, frag_target) \
573 MUTATOR_HOOKABLE(AccuracyTargetValid, EV_AccuracyTargetValid);
575 MUT_ACCADD_VALID, // return this flag to make the function continue if target is a client
576 MUT_ACCADD_INVALID, // return this flag to make the function always continue
577 MUT_ACCADD_INDIFFERENT // return this flag to make the function always return
580 /** Called when clearing the global parameters for a model */
581 MUTATOR_HOOKABLE(ClearModelParams, EV_NO_ARGS);
583 /** Called when getting the global parameters for a model */
584 #define EV_GetModelParams(i, o) \
585 /** entity id */ i(string, checkmodel_input) \
586 /** entity id */ i(string, checkmodel_command) \
588 string checkmodel_input, checkmodel_command;
589 MUTATOR_HOOKABLE(GetModelParams, EV_GetModelParams);
591 /** called when a bullet has hit a target */
592 #define EV_FireBullet_Hit(i, o) \
593 /**/ i(entity, __self) \
594 /**/ i(entity, bullet_hit) \
595 /**/ i(vector, bullet_startpos) \
596 /**/ i(vector, bullet_endpos) \
597 /**/ i(float, frag_damage) \
598 /**/ o(float, frag_damage) \
601 //vector bullet_hitloc; // the end pos matches the hit location, apparently
602 vector bullet_startpos;
603 vector bullet_endpos;
605 MUTATOR_HOOKABLE(FireBullet_Hit, EV_FireBullet_Hit);
607 #define EV_FixPlayermodel(i, o) \
608 /**/ i(string, ret_string) \
609 /**/ o(string, ret_string) \
610 /**/ i(int, ret_int) \
611 /**/ o(int, ret_int) \
614 MUTATOR_HOOKABLE(FixPlayermodel, EV_FixPlayermodel);
616 /** Return error to play frag remaining announcements */
617 MUTATOR_HOOKABLE(Scores_CountFragsRemaining, EV_NO_ARGS);
619 #define EV_GrappleHookThink(i, o) \
620 /**/ i(entity, __self) \
621 /**/ i(int, hook_tarzan) \
622 /**/ o(int, hook_tarzan) \
623 /**/ i(entity, hook_pullentity) \
624 /**/ o(entity, hook_pullentity) \
625 /**/ i(float, hook_velmultiplier) \
626 /**/ o(float, hook_velmultiplier) \
629 entity hook_pullentity;
630 float hook_velmultiplier;
631 MUTATOR_HOOKABLE(GrappleHookThink, EV_GrappleHookThink);
633 #define EV_BuffModel_Customize(i, o) \
634 /**/ i(entity, __self) \
635 /**/ i(entity, buff_player) \
638 MUTATOR_HOOKABLE(BuffModel_Customize, EV_BuffModel_Customize);
640 /** called at when a buff is touched. Called early, can edit buff properties. */
641 #define EV_BuffTouch(i, o) \
642 /** item */ i(entity, __self) \
643 /** player */ i(entity, other) \
645 MUTATOR_HOOKABLE(BuffTouch, EV_BuffTouch);
647 MUTATOR_HOOKABLE(SetNewParms, EV_NO_ARGS);
649 MUTATOR_HOOKABLE(SetChangeParms, EV_NO_ARGS);
651 MUTATOR_HOOKABLE(DecodeLevelParms, EV_NO_ARGS);
653 #define EV_GetRecords(i, o) \
654 /**/ i(int, record_page) \
655 /**/ i(string, ret_string) \
656 /**/ o(string, ret_string) \
659 MUTATOR_HOOKABLE(GetRecords, EV_GetRecords);
661 #define EV_Race_FinalCheckpoint(i, o) \
662 /**/ i(entity, race_player) \
665 MUTATOR_HOOKABLE(Race_FinalCheckpoint, EV_Race_FinalCheckpoint);
667 /** called when player triggered kill (or is changing teams), return error to not do anything */
668 #define EV_ClientKill(i, o) \
669 /** player */ i(entity, __self) \
670 /* kill delay */ i(float, ret_float) \
671 /* kill delay */ o(float, ret_float) \
673 MUTATOR_HOOKABLE(ClientKill, EV_ClientKill);
675 #define EV_FixClientCvars(i, o) \
676 /**/ i(entity, fix_client) \
679 MUTATOR_HOOKABLE(FixClientCvars, EV_FixClientCvars);
681 #define EV_SpectateSet(i, o) \
682 /**/ i(entity, __self) \
683 /**/ i(entity, spec_player) \
684 /**/ o(entity, spec_player) \
687 MUTATOR_HOOKABLE(SpectateSet, EV_SpectateSet);
689 #define EV_SpectateNext(i, o) \
690 /**/ i(entity, __self) \
691 /**/ i(entity, spec_player) \
692 /**/ o(entity, spec_player) \
694 MUTATOR_HOOKABLE(SpectateNext, EV_SpectateNext);
696 #define EV_SpectatePrev(i, o) \
697 /**/ i(entity, __self) \
698 /**/ i(entity, spec_player) \
699 /**/ o(entity, spec_player) \
700 /**/ i(entity, spec_first) \
703 MUTATOR_HOOKABLE(SpectatePrev, EV_SpectatePrev);
706 MUT_SPECPREV_CONTINUE, // return this flag to make the function continue as normal
707 MUT_SPECPREV_RETURN, // return this flag to make the function return (handled entirely by mutator)
708 MUT_SPECPREV_FOUND // return this flag to make the function continue without default functions (handled mostly by mutator)
711 /** called when player triggered kill (or is changing teams), return error to not do anything */
712 #define EV_Bot_FixCount(i, o) \
713 /**/ i(int, bot_activerealplayers) \
714 /**/ o(int, bot_activerealplayers) \
715 /**/ i(int, bot_realplayers) \
716 /**/ o(int, bot_realplayers) \
718 int bot_activerealplayers;
720 MUTATOR_HOOKABLE(Bot_FixCount, EV_Bot_FixCount);
722 #define EV_ClientCommand_Spectate(i, o) \
723 /**/ i(entity, __self) \
725 MUTATOR_HOOKABLE(ClientCommand_Spectate, EV_ClientCommand_Spectate);
728 MUT_SPECCMD_CONTINUE, // return this flag to make the function continue as normal
729 MUT_SPECCMD_RETURN, // return this flag to make the function return (don't spectate)
730 MUT_SPECCMD_FORCE // return this flag to force the player to spectate, even if they're not a player
733 #define EV_CheckRules_World(i, o) \
734 /* status */ i(float, ret_float) \
735 /* status */ o(float, ret_float) \
736 /* time limit */ i(float, checkrules_timelimit) \
737 /* frag limit */ i(int, checkrules_fraglimit) \
739 float checkrules_timelimit;
740 int checkrules_fraglimit;
741 MUTATOR_HOOKABLE(CheckRules_World, EV_CheckRules_World);
743 #define EV_WantWeapon(i, o) \
744 /**/ i(entity, want_weaponinfo) \
745 /**/ i(float, ret_float) \
746 /**/ o(float, ret_float) \
747 /**/ i(bool, want_allguns) \
748 /**/ o(bool, want_allguns) \
749 /**/ i(bool, want_mutatorblocked) \
750 /**/ o(bool, want_mutatorblocked) \
752 entity want_weaponinfo;
754 bool want_mutatorblocked;
755 MUTATOR_HOOKABLE(WantWeapon, EV_WantWeapon);
757 #define EV_AddPlayerScore(i, o) \
758 /**/ i(int, score_field) \
759 /**/ i(float, ret_float) \
760 /**/ o(float, ret_float) \
763 MUTATOR_HOOKABLE(AddPlayerScore, EV_AddPlayerScore);
765 #define EV_GetPlayerStatus(i, o) \
766 /**/ i(entity, set_player) \
767 /**/ i(string, ret_string) \
768 /**/ o(string, ret_string) \
771 MUTATOR_HOOKABLE(GetPlayerStatus, EV_GetPlayerStatus);
773 #define EV_SetWeaponArena(i, o) \
774 /**/ i(string, ret_string) \
775 /**/ o(string, ret_string) \
777 MUTATOR_HOOKABLE(SetWeaponArena, EV_SetWeaponArena);
779 #define EV_DropSpecialItems(i, o) \
780 /**/ i(entity, frag_target) \
782 MUTATOR_HOOKABLE(DropSpecialItems, EV_DropSpecialItems);
785 * called when an admin tries to kill all monsters
786 * return 1 to prevent spawning
788 MUTATOR_HOOKABLE(AllowMobButcher, EV_NO_ARGS);
790 MUTATOR_HOOKABLE(ReadLevelCvars, EV_NO_ARGS);
792 #define EV_SendWaypoint(i, o) \
793 /**/ i(entity, __self) \
794 /**/ i(entity, wp_sendto) \
795 /**/ i(int, wp_sendflags) \
796 /**/ o(int, wp_sendflags) \
797 /**/ i(int, wp_flag) \
798 /**/ o(int, wp_flag) \
803 MUTATOR_HOOKABLE(SendWaypoint, EV_SendWaypoint);
805 #define EV_TurretValidateTarget(i, o) \
806 /**/ i(entity, turret_this) \
807 /**/ i(entity, turret_target) \
808 /**/ i(int, turret_vflags) \
811 entity turret_target;
813 MUTATOR_HOOKABLE(TurretValidateTarget, EV_TurretValidateTarget);
815 #define EV_TurretThink(i, o) \
816 /**/ i(entity, __self) \
818 MUTATOR_HOOKABLE(TurretThink, EV_TurretThink);
820 MUTATOR_HOOKABLE(Ent_Init, EV_NO_ARGS);
823 #define EV_PrepareExplosionByDamage(i, o) \
824 /**/ i(entity, __self) \
825 /**/ i(entity, frag_attacker) \
827 MUTATOR_HOOKABLE(PrepareExplosionByDamage, EV_PrepareExplosionByDamage);
829 /** called when a monster model is about to be set, allows custom paths etc. */
830 #define EV_MonsterModel(i, o) \
831 /**/ i(string, monster_model) \
832 /**/ i(string, monster_model_output) \
833 /**/ o(string, monster_model_output) \
835 string monster_model;
836 string monster_model_output;
837 MUTATOR_HOOKABLE(MonsterModel, EV_MonsterModel);
840 #define EV_Player_ChangeTeam(i, o) \
841 /**/ i(entity, __self) \
842 /**/ i(float, pct_curteam) \
843 /**/ i(float, pct_newteam) \
847 MUTATOR_HOOKABLE(Player_ChangeTeam, EV_Player_ChangeTeam);
850 #define EV_URI_GetCallback(i, o) \
851 /**/ i(float, uricb_id) \
852 /**/ i(float, uricb_status) \
853 /**/ i(string, uricb_data) \
858 MUTATOR_HOOKABLE(URI_GetCallback, EV_URI_GetCallback);