qcsrc/server/mutators/events.qh

   1 #pragma once
   2
   3 #include <common/mutators/base.qh>
   4
   5 // register all possible hooks here
   6
   7 /** called when a player becomes observer, after shared setup */
   8 #define EV_MakePlayerObserver(i, o) \
   9     /** player */ i(entity, MUTATOR_ARGV_0_entity) \
  10     /**/
  11 MUTATOR_HOOKABLE(MakePlayerObserver, EV_MakePlayerObserver)
  12
  13 /** */
  14 #define EV_PutClientInServer(i, o) \
  15         /** client wanting to spawn */ i(entity, MUTATOR_ARGV_0_entity) \
  16     /**/
  17 MUTATOR_HOOKABLE(PutClientInServer, EV_PutClientInServer);
  18
  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) \
  23     /**/
  24 MUTATOR_HOOKABLE(PlayerSpawn, EV_PlayerSpawn);
  25
  26 /** called in reset_map */
  27 #define EV_reset_map_global(i, o) \
  28     /**/
  29 MUTATOR_HOOKABLE(reset_map_global, EV_reset_map_global);
  30
  31 /** called in reset_map */
  32 #define EV_reset_map_players(i, o) \
  33     /**/
  34 MUTATOR_HOOKABLE(reset_map_players, EV_reset_map_players);
  35
  36 /** returns 1 if clearing player score shall not be allowed */
  37 #define EV_ForbidPlayerScore_Clear(i, o) \
  38     /**/
  39 MUTATOR_HOOKABLE(ForbidPlayerScore_Clear, EV_ForbidPlayerScore_Clear);
  40
  41 /** called when a player disconnects */
  42 #define EV_ClientDisconnect(i, o) \
  43     /** player */ i(entity, MUTATOR_ARGV_0_entity) \
  44     /**/
  45 MUTATOR_HOOKABLE(ClientDisconnect, EV_ClientDisconnect);
  46
  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) \
  55     /**/
  56 MUTATOR_HOOKABLE(PlayerDies, EV_PlayerDies);
  57
  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) \
  61     /**/
  62 MUTATOR_HOOKABLE(PlayHitsound, EV_PlayHitsound);
  63
  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) \
  69     /**/
  70 MUTATOR_HOOKABLE(WeaponSound, EV_WeaponSound);
  71
  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) \
  77     /**/
  78 MUTATOR_HOOKABLE(ItemModel, EV_ItemModel);
  79
  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) \
  86     /**/
  87 MUTATOR_HOOKABLE(GiveFragsForKill, EV_GiveFragsForKill);
  88
  89 /** called when the match ends */
  90 MUTATOR_HOOKABLE(MatchEnd, EV_NO_ARGS);
  91
  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) \
  98     /**/
  99 MUTATOR_HOOKABLE(GetTeamCount, EV_GetTeamCount);
 100
 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) \
 105     /**/
 106 MUTATOR_HOOKABLE(SpectateCopy, EV_SpectateCopy);
 107
 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) \
 115     /**/
 116 MUTATOR_HOOKABLE(FormatMessage, EV_FormatMessage);
 117
 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) \
 121     /**/
 122 MUTATOR_HOOKABLE(ForbidThrowCurrentWeapon, EV_ForbidThrowCurrentWeapon);
 123
 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) \
 127     /**/
 128 MUTATOR_HOOKABLE(ForbidDropCurrentWeapon, EV_ForbidDropCurrentWeapon);
 129
 130 /**  */
 131 MUTATOR_HOOKABLE(SetDefaultAlpha, EV_NO_ARGS);
 132
 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) \
 138     /**/
 139 MUTATOR_HOOKABLE(WeaponRateFactor, EV_WeaponRateFactor);
 140
 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) \
 146     /**/
 147 MUTATOR_HOOKABLE(WeaponSpeedFactor, EV_WeaponSpeedFactor);
 148
 149 /** adjusts {warmup_}start_{items,weapons,ammo_{cells,plasma,rockets,nails,shells,fuel}} */
 150 MUTATOR_HOOKABLE(SetStartItems, EV_NO_ARGS);
 151
 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) \
 156     /**/
 157 MUTATOR_HOOKABLE(CustomizeWaypoint, EV_CustomizeWaypoint);
 158
 159 /**
 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
 162  */
 163 #define EV_FilterItem(i, o) \
 164     /** item        */ i(entity, MUTATOR_ARGV_0_entity) \
 165     /**/
 166 MUTATOR_HOOKABLE(FilterItem, EV_FilterItem);
 167
 168 /** return error to request removal */
 169 #define EV_TurretSpawn(i, o) \
 170     /** turret        */ i(entity, MUTATOR_ARGV_0_entity) \
 171     /**/
 172 MUTATOR_HOOKABLE(TurretSpawn, EV_TurretSpawn);
 173
 174 /** return error to not attack */
 175 #define EV_TurretFire(i, o) \
 176     /** turret        */ i(entity, MUTATOR_ARGV_0_entity) \
 177     /**/
 178 MUTATOR_HOOKABLE(TurretFire, EV_TurretFire);
 179
 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) \
 184     /**/
 185 MUTATOR_HOOKABLE(Turret_CheckFire, EV_Turret_CheckFire);
 186
 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) \
 190     /**/
 191 MUTATOR_HOOKABLE(OnEntityPreSpawn, EV_OnEntityPreSpawn);
 192
 193 /** runs in the event loop for players; is called for ALL player entities, also bots, also the dead, or spectators */
 194 #define EV_PlayerPreThink(i, o) \
 195     /** player */ i(entity, MUTATOR_ARGV_0_entity) \
 196     /**/
 197 MUTATOR_HOOKABLE(PlayerPreThink, EV_PlayerPreThink);
 198
 199 /** TODO change this into a general PlayerPostThink hook? */
 200 MUTATOR_HOOKABLE(GetPressedKeys, EV_NO_ARGS);
 201
 202 /** is meant to call GetCvars_handle*(get_cvars_s, get_cvars_f, cvarfield, "cvarname") for cvars this mutator needs from the client */
 203 #define EV_GetCvars(i, o) \
 204     /**/ i(float, get_cvars_f) \
 205     /**/ i(string, get_cvars_s) \
 206     /**/
 207 float get_cvars_f;
 208 string get_cvars_s;
 209 MUTATOR_HOOKABLE(GetCvars, EV_NO_ARGS); // NOTE: Can't use EV_GetCvars because of `SZ_GetSpace: overflow`
 210
 211 /** can edit any "just fired" projectile */
 212 #define EV_EditProjectile(i, o) \
 213     /** projectile owner */ i(entity, MUTATOR_ARGV_0_entity) \
 214     /** projectile */ i(entity, MUTATOR_ARGV_1_entity) \
 215     /**/
 216 MUTATOR_HOOKABLE(EditProjectile, EV_EditProjectile);
 217
 218 /** called when a monster spawns */
 219 #define EV_MonsterSpawn(i, o) \
 220     /** monster */ i(entity, MUTATOR_ARGV_0_entity) \
 221     /**/
 222 MUTATOR_HOOKABLE(MonsterSpawn, EV_MonsterSpawn);
 223
 224 /** called when a monster dies */
 225 #define EV_MonsterDies(i, o) \
 226     /** target       */ i(entity, MUTATOR_ARGV_0_entity) \
 227     /** attacker     */ i(entity, MUTATOR_ARGV_1_entity) \
 228     /** deathtype    */ i(float, MUTATOR_ARGV_2_float) \
 229     /**/
 230 MUTATOR_HOOKABLE(MonsterDies, EV_MonsterDies);
 231
 232 /** called when a monster dies */
 233 #define EV_MonsterRemove(i, o) \
 234     /** monster */ i(entity, MUTATOR_ARGV_0_entity) \
 235     /**/
 236 MUTATOR_HOOKABLE(MonsterRemove, EV_MonsterRemove);
 237
 238 /** called when a monster wants to respawn */
 239 #define EV_MonsterRespawn(i, o) \
 240     /** monster */ i(entity, MUTATOR_ARGV_0_entity) \
 241     /**/
 242 MUTATOR_HOOKABLE(MonsterRespawn, EV_MonsterRespawn);
 243
 244 /** called when a monster is dropping loot */
 245 #define EV_MonsterDropItem(i, o) \
 246     /* monster */                          i(entity, MUTATOR_ARGV_0_entity) \
 247     /* item (can be removed or changed) */ i(entity, MUTATOR_ARGV_1_entity) \
 248     /**/                                   o(entity, MUTATOR_ARGV_1_entity) \
 249     /* attacker */                         i(entity, MUTATOR_ARGV_2_entity) \
 250     /**/
 251 .void(entity this) monster_loot;
 252 MUTATOR_HOOKABLE(MonsterDropItem, EV_MonsterDropItem);
 253
 254 /**
 255  * called when a monster moves
 256  * returning true makes the monster stop
 257  */
 258 #define EV_MonsterMove(i, o) \
 259     /** monster */       i(entity, MUTATOR_ARGV_0_entity) \
 260     /** run speed */     i(float, MUTATOR_ARGV_1_float) \
 261     /**/                 o(float, MUTATOR_ARGV_1_float) \
 262     /** walk speed */    i(float, MUTATOR_ARGV_2_float) \
 263     /**/                 o(float, MUTATOR_ARGV_2_float) \
 264     /** move target */   i(entity, MUTATOR_ARGV_3_entity) \
 265     /**/
 266 MUTATOR_HOOKABLE(MonsterMove, EV_MonsterMove);
 267
 268 /** called when a monster looks for another target */
 269 MUTATOR_HOOKABLE(MonsterFindTarget, EV_NO_ARGS);
 270
 271 /** called to change a random monster to a miniboss */
 272 #define EV_MonsterCheckBossFlag(i, o) \
 273     /** monster */ i(entity, MUTATOR_ARGV_0_entity) \
 274     /**/
 275 MUTATOR_HOOKABLE(MonsterCheckBossFlag, EV_MonsterCheckBossFlag);
 276
 277 /**
 278  * called when a player tries to spawn a monster
 279  * return 1 to prevent spawning
 280  * NOTE: requires reason if disallowed
 281  */
 282  #define EV_AllowMobSpawning(i, o) \
 283     /** caller */ i(entity, MUTATOR_ARGV_0_entity) \
 284     /** reason */ o(string, MUTATOR_ARGV_1_string) \
 285     /**/
 286 MUTATOR_HOOKABLE(AllowMobSpawning, EV_AllowMobSpawning);
 287
 288 /** called when a player gets damaged to e.g. remove stuff he was carrying. */
 289 #define EV_PlayerDamage_SplitHealthArmor(i, o) \
 290         /** inflictor           */ i(entity, MUTATOR_ARGV_0_entity) \
 291     /** attacker        */ i(entity, MUTATOR_ARGV_1_entity) \
 292     /** target                  */ i(entity, MUTATOR_ARGV_2_entity) \
 293     /** force (no out)  */ i(vector, MUTATOR_ARGV_3_vector) \
 294     /** damage take     */ i(float,  MUTATOR_ARGV_4_float) \
 295     /** damage take     */ o(float,  MUTATOR_ARGV_4_float) \
 296     /** damage save     */ i(float,  MUTATOR_ARGV_5_float) \
 297     /** damage save     */ o(float,  MUTATOR_ARGV_5_float) \
 298     /** deathtype               */ i(float,  MUTATOR_ARGV_6_float) \
 299     /** damage              */ i(float,  MUTATOR_ARGV_7_float) \
 300     /**/
 301 MUTATOR_HOOKABLE(PlayerDamage_SplitHealthArmor, EV_PlayerDamage_SplitHealthArmor);
 302
 303 /**
 304  * called to adjust damage and force values which are applied to the player, used for e.g. strength damage/force multiplier
 305  * i'm not sure if I should change this around slightly (Naming of the entities, and also how they're done in g_damage).
 306  */
 307 #define EV_PlayerDamage_Calculate(i, o) \
 308     /** inflictor               */ i(entity, MUTATOR_ARGV_0_entity) \
 309     /** attacker        */ i(entity, MUTATOR_ARGV_1_entity) \
 310     /** target                  */ i(entity, MUTATOR_ARGV_2_entity) \
 311     /** deathtype       */ i(float,  MUTATOR_ARGV_3_float) \
 312     /** damage          */ i(float,  MUTATOR_ARGV_4_float) \
 313     /** damage                  */ o(float,  MUTATOR_ARGV_4_float) \
 314     /** mirrordamage    */ i(float,  MUTATOR_ARGV_5_float) \
 315     /** mirrordamage    */ o(float,  MUTATOR_ARGV_5_float) \
 316     /** force           */ i(vector, MUTATOR_ARGV_6_vector) \
 317     /** force                   */ o(vector, MUTATOR_ARGV_6_vector) \
 318     /**/
 319 MUTATOR_HOOKABLE(PlayerDamage_Calculate, EV_PlayerDamage_Calculate);
 320
 321 /**
 322  * Called when a player is damaged
 323  */
 324 #define EV_PlayerDamaged(i, o) \
 325     /** attacker  */ i(entity, MUTATOR_ARGV_0_entity) \
 326     /** target    */ i(entity, MUTATOR_ARGV_1_entity) \
 327     /** health    */ i(int,    MUTATOR_ARGV_2_int) \
 328     /** armor     */ i(int,    MUTATOR_ARGV_3_int) \
 329     /** location  */ i(vector, MUTATOR_ARGV_4_vector) \
 330     /** deathtype */ i(int,    MUTATOR_ARGV_5_int) \
 331     /**/
 332 MUTATOR_HOOKABLE(PlayerDamaged, EV_PlayerDamaged);
 333
 334 /**
 335  * Called by W_DecreaseAmmo
 336  */
 337 #define EV_W_DecreaseAmmo(i, o) \
 338     /** actor */ i(entity, MUTATOR_ARGV_0_entity) \
 339     /**/
 340 MUTATOR_HOOKABLE(W_DecreaseAmmo, EV_W_DecreaseAmmo);
 341
 342 /**
 343  * Called by W_Reload
 344  */
 345 #define EV_W_Reload(i, o) \
 346     /** actor */ i(entity, MUTATOR_ARGV_0_entity) \
 347     /**/
 348 MUTATOR_HOOKABLE(W_Reload, EV_W_Reload);
 349
 350 /** called at the end of player_powerups() in cl_client.qc, used for manipulating the values which are set by powerup items. */
 351 #define EV_PlayerPowerups(i, o) \
 352     /** player */    i(entity, MUTATOR_ARGV_0_entity) \
 353     /** old items */ i(int, MUTATOR_ARGV_1_int) \
 354     /**/
 355 MUTATOR_HOOKABLE(PlayerPowerups, EV_PlayerPowerups);
 356
 357 /**
 358  * called every player think frame
 359  * return 1 to disable regen
 360  */
 361 float regen_mod_max;
 362 float regen_mod_regen;
 363 float regen_mod_rot;
 364 float regen_mod_limit;
 365 float regen_health;
 366 float regen_health_linear;
 367 float regen_health_rot;
 368 float regen_health_rotlinear;
 369 float regen_health_stable;
 370 float regen_health_rotstable;
 371 MUTATOR_HOOKABLE(PlayerRegen, EV_NO_ARGS);
 372
 373 /**
 374  * called when the use key is pressed
 375  * if MUTATOR_RETURNVALUE is 1, don't do anything
 376  * return 1 if the use key actually did something
 377  */
 378  #define EV_PlayerUseKey(i, o) \
 379     /** player */ i(entity, MUTATOR_ARGV_0_entity) \
 380     /**/
 381 MUTATOR_HOOKABLE(PlayerUseKey, EV_PlayerUseKey);
 382
 383 /**
 384  * called when a client command is parsed
 385  * NOTE: hooks MUST start with if (MUTATOR_RETURNVALUE) return false;
 386  * NOTE: return true if you handled the command, return false to continue handling
 387  * NOTE: THESE HOOKS MUST NEVER EVER CALL tokenize()
 388  * // example:
 389  * MUTATOR_HOOKFUNCTION(foo_SV_ParseClientCommand)
 390  * {
 391  *     if (MUTATOR_RETURNVALUE) // command was already handled?
 392  *         return false;
 393  *     if (cmd_name == "echocvar" && cmd_argc >= 2)
 394  *     {
 395  *         print(cvar_string(argv(1)), "\n");
 396  *         return true;
 397  *     }
 398  *     if (cmd_name == "echostring" && cmd_argc >= 2)
 399  *     {
 400  *         print(substring(cmd_string, argv_start_index(1), argv_end_index(-1) - argv_start_index(1)), "\n");
 401  *         return true;
 402  *     }
 403  *     return false;
 404  * }
 405  */
 406 #define EV_SV_ParseClientCommand(i, o) \
 407         /** client sending the command */       i(entity, MUTATOR_ARGV_0_entity) \
 408     /** command name */                     i(string, MUTATOR_ARGV_1_string) \
 409         /** argc (also, argv() can be used) */  i(int, MUTATOR_ARGV_2_int) \
 410         /** whole command, use only if you really have to */ i(string, MUTATOR_ARGV_3_string) \
 411     /**/
 412 MUTATOR_HOOKABLE(SV_ParseClientCommand, EV_SV_ParseClientCommand);
 413
 414 /** please read EV_SV_ParseClientCommand description before using */
 415 #define EV_SV_ParseServerCommand(i, o) \
 416    /** command name */ i(string, MUTATOR_ARGV_0_string) \
 417         /** argc (also, argv() can be used) */ i(int, MUTATOR_ARGV_1_int) \
 418         /** whole command, use only if you really have to */ i(string, MUTATOR_ARGV_2_string) \
 419     /**/
 420 MUTATOR_HOOKABLE(SV_ParseServerCommand, EV_SV_ParseServerCommand);
 421
 422 /**
 423  * called when a spawnpoint is being evaluated
 424  * return 1 to make the spawnpoint unusable
 425  */
 426 #define EV_Spawn_Score(i, o) \
 427     /** player wanting to spawn */ i(entity, MUTATOR_ARGV_0_entity) \
 428     /** spot to be evaluated */ i(entity, MUTATOR_ARGV_1_entity) \
 429     /** spot score, _x is priority, _y is "distance" */ i(vector, MUTATOR_ARGV_0_vector) \
 430     /**/ o(vector, MUTATOR_ARGV_0_vector) \
 431     /**/
 432 MUTATOR_HOOKABLE(Spawn_Score, EV_Spawn_Score);
 433
 434 /** runs globally each server frame */
 435 MUTATOR_HOOKABLE(SV_StartFrame, EV_NO_ARGS);
 436
 437 #define EV_SetModname(i, o) \
 438     /** name of the mutator/mod if it warrants showing as such in the server browser */ \
 439     /**/ o(string, MUTATOR_ARGV_0_string) \
 440     /**/
 441 MUTATOR_HOOKABLE(SetModname, EV_SetModname);
 442
 443 /**
 444  * called for each item being spawned on a map, including dropped weapons
 445  * return 1 to remove an item
 446  */
 447 #define EV_Item_Spawn(i, o) \
 448     /** item */ i(entity, MUTATOR_ARGV_0_entity) \
 449     /**/
 450 MUTATOR_HOOKABLE(Item_Spawn, EV_Item_Spawn);
 451
 452 #define EV_SetWeaponreplace(i, o) \
 453     /** map entity */  i(entity, MUTATOR_ARGV_0_entity) \
 454     /** weapon info */ i(entity, MUTATOR_ARGV_1_entity) \
 455     /** replacement */ i(string, MUTATOR_ARGV_2_string) \
 456     /**/               o(string, MUTATOR_ARGV_2_string) \
 457     /**/
 458 MUTATOR_HOOKABLE(SetWeaponreplace, EV_SetWeaponreplace);
 459
 460 /** called when an item is about to respawn */
 461 #define EV_Item_RespawnCountdown(i, o) \
 462     /** item name */   i(string, MUTATOR_ARGV_0_string) \
 463     /**/               o(string, MUTATOR_ARGV_0_string) \
 464     /** item colour */ i(vector, MUTATOR_ARGV_1_vector) \
 465     /**/               o(vector, MUTATOR_ARGV_1_vector) \
 466     /**/
 467 MUTATOR_HOOKABLE(Item_RespawnCountdown, EV_Item_RespawnCountdown);
 468
 469 /** called when a bot checks a target to attack */
 470 #define EV_BotShouldAttack(i, o) \
 471     /** bot */    i(entity, MUTATOR_ARGV_0_entity) \
 472     /** target */ i(entity, MUTATOR_ARGV_1_entity) \
 473     /**/
 474 MUTATOR_HOOKABLE(BotShouldAttack, EV_BotShouldAttack);
 475
 476 /**
 477  * called whenever a player goes through a portal gun teleport
 478  * allows you to strip a player of an item if they go through the teleporter to help prevent cheating
 479  */
 480 #define EV_PortalTeleport(i, o) \
 481     /** player */ i(entity, MUTATOR_ARGV_0_entity) \
 482     /**/
 483 MUTATOR_HOOKABLE(PortalTeleport, EV_PortalTeleport);
 484
 485 /**
 486  * called whenever a player uses impulse 33 (help me) in cl_impulse.qc
 487  * normally help me ping uses self.waypointsprite_attachedforcarrier,
 488  * but if your mutator uses something different then you can handle it
 489  * in a special manner using this hook
 490  */
 491 #define EV_HelpMePing(i, o) \
 492     /** the player who pressed impulse 33 */ i(entity, MUTATOR_ARGV_0_entity) \
 493     /**/
 494 MUTATOR_HOOKABLE(HelpMePing, EV_HelpMePing);
 495
 496 /**
 497  * called when a vehicle initializes
 498  * return true to remove the vehicle
 499  */
 500 #define EV_VehicleSpawn(i, o) \
 501     /** vehicle */ i(entity, MUTATOR_ARGV_0_entity) \
 502     /**/
 503 MUTATOR_HOOKABLE(VehicleSpawn, EV_VehicleSpawn);
 504
 505 /**
 506  * called when a player enters a vehicle
 507  * allows mutators to set special settings in this event
 508  */
 509 #define EV_VehicleEnter(i, o) \
 510     /** player */ i(entity, MUTATOR_ARGV_0_entity) \
 511     /** vehicle */ i(entity, MUTATOR_ARGV_1_entity) \
 512     /**/
 513 MUTATOR_HOOKABLE(VehicleEnter, EV_VehicleEnter);
 514
 515 /**
 516  * called when a player touches a vehicle
 517  * return true to stop player from entering the vehicle
 518  */
 519 #define EV_VehicleTouch(i, o) \
 520     /** vehicle */ i(entity, MUTATOR_ARGV_0_entity) \
 521     /** player */ i(entity, MUTATOR_ARGV_1_entity) \
 522     /**/
 523 MUTATOR_HOOKABLE(VehicleTouch, EV_VehicleTouch);
 524
 525 /**
 526  * called when a player exits a vehicle
 527  * allows mutators to set special settings in this event
 528  */
 529 #define EV_VehicleExit(i, o) \
 530     /** player */ i(entity, MUTATOR_ARGV_0_entity) \
 531     /** vehicle */ i(entity, MUTATOR_ARGV_1_entity) \
 532     /**/
 533 MUTATOR_HOOKABLE(VehicleExit, EV_VehicleExit);
 534
 535 /** called when a speedrun is aborted and the player is teleported back to start position */
 536 #define EV_AbortSpeedrun(i, o) \
 537     /** player */ i(entity, MUTATOR_ARGV_0_entity) \
 538     /**/
 539 MUTATOR_HOOKABLE(AbortSpeedrun, EV_AbortSpeedrun);
 540
 541 /** called at when a item is touched. Called early, can edit item properties. */
 542 #define EV_ItemTouch(i, o) \
 543     /** item */    i(entity, MUTATOR_ARGV_0_entity) \
 544     /** toucher */ i(entity, MUTATOR_ARGV_1_entity) \
 545     /**/
 546 MUTATOR_HOOKABLE(ItemTouch, EV_ItemTouch);
 547
 548 enum {
 549         MUT_ITEMTOUCH_CONTINUE, // return this flag to make the function continue as normal
 550         MUT_ITEMTOUCH_RETURN, // return this flag to make the function return (handled entirely by mutator)
 551         MUT_ITEMTOUCH_PICKUP // return this flag to have the item "picked up" and taken even after mutator handled it
 552 };
 553
 554 /** called at when a player connect */
 555 #define EV_ClientConnect(i, o) \
 556     /** player */ i(entity, MUTATOR_ARGV_0_entity) \
 557     /**/
 558 MUTATOR_HOOKABLE(ClientConnect, EV_ClientConnect);
 559
 560 #define EV_HavocBot_ChooseRole(i, o) \
 561     /** bot */ i(entity, MUTATOR_ARGV_0_entity) \
 562     /**/
 563 MUTATOR_HOOKABLE(HavocBot_ChooseRole, EV_HavocBot_ChooseRole);
 564
 565 /** called when a target is checked for accuracy */
 566 #define EV_AccuracyTargetValid(i, o) \
 567     /** attacker */ i(entity, MUTATOR_ARGV_0_entity) \
 568     /** target */ i(entity, MUTATOR_ARGV_1_entity) \
 569     /**/
 570 MUTATOR_HOOKABLE(AccuracyTargetValid, EV_AccuracyTargetValid);
 571 enum {
 572         MUT_ACCADD_VALID, // return this flag to make the function continue if target is a client
 573         MUT_ACCADD_INVALID, // return this flag to make the function always continue
 574         MUT_ACCADD_INDIFFERENT // return this flag to make the function always return
 575 };
 576
 577 /** Called when clearing the global parameters for a model */
 578 MUTATOR_HOOKABLE(ClearModelParams, EV_NO_ARGS);
 579
 580 /** Called when getting the global parameters for a model */
 581 #define EV_GetModelParams(i, o) \
 582     /** input */   i(string, MUTATOR_ARGV_0_string) \
 583     /** command */ i(string, MUTATOR_ARGV_1_string) \
 584     /**/
 585 MUTATOR_HOOKABLE(GetModelParams, EV_GetModelParams);
 586
 587 /** called when a bullet has hit a target */
 588 #define EV_FireBullet_Hit(i, o) \
 589     /** player */       i(entity, MUTATOR_ARGV_0_entity) \
 590     /** targ */         i(entity, MUTATOR_ARGV_1_entity) \
 591     /** start pos */    i(vector, MUTATOR_ARGV_2_vector) \
 592     /** end pos */      i(vector, MUTATOR_ARGV_3_vector) \
 593     /** damage */       i(float, MUTATOR_ARGV_4_float) \
 594     /**/                o(float, MUTATOR_ARGV_4_float) \
 595     /**/
 596 MUTATOR_HOOKABLE(FireBullet_Hit, EV_FireBullet_Hit);
 597
 598 #define EV_FixPlayermodel(i, o) \
 599     /** model */    i(string, MUTATOR_ARGV_0_string) \
 600     /**/            o(string, MUTATOR_ARGV_0_string) \
 601     /** skin */     i(int, MUTATOR_ARGV_1_int) \
 602     /**/            o(int, MUTATOR_ARGV_1_int) \
 603     /**/
 604 MUTATOR_HOOKABLE(FixPlayermodel, EV_FixPlayermodel);
 605
 606 /** Return error to play frag remaining announcements */
 607 MUTATOR_HOOKABLE(Scores_CountFragsRemaining, EV_NO_ARGS);
 608
 609 #define EV_GrappleHookThink(i, o) \
 610     /** hook */                i(entity, MUTATOR_ARGV_0_entity) \
 611     /** tarzan */              i(int, MUTATOR_ARGV_1_int) \
 612     /**/                       o(int, MUTATOR_ARGV_1_int) \
 613     /** pulling entity */      i(entity, MUTATOR_ARGV_2_entity) \
 614     /**/                       o(entity, MUTATOR_ARGV_2_entity) \
 615     /** velocity multiplier */ i(float, MUTATOR_ARGV_3_float) \
 616     /**/                       o(float, MUTATOR_ARGV_3_float) \
 617     /**/
 618 MUTATOR_HOOKABLE(GrappleHookThink, EV_GrappleHookThink);
 619
 620 #define EV_BuffModel_Customize(i, o) \
 621     /** buff */    i(entity, MUTATOR_ARGV_0_entity) \
 622     /** player */  i(entity, MUTATOR_ARGV_1_entity) \
 623     /**/
 624 MUTATOR_HOOKABLE(BuffModel_Customize, EV_BuffModel_Customize);
 625
 626 /** called at when a buff is touched. Called early, can edit buff properties. */
 627 #define EV_BuffTouch(i, o) \
 628     /** buff */    i(entity, MUTATOR_ARGV_0_entity) \
 629     /** player */  i(entity, MUTATOR_ARGV_1_entity) \
 630     /**/
 631 MUTATOR_HOOKABLE(BuffTouch, EV_BuffTouch);
 632
 633 MUTATOR_HOOKABLE(SetNewParms, EV_NO_ARGS);
 634
 635 MUTATOR_HOOKABLE(SetChangeParms, EV_NO_ARGS);
 636
 637 MUTATOR_HOOKABLE(DecodeLevelParms, EV_NO_ARGS);
 638
 639 #define EV_GetRecords(i, o) \
 640     /** page */           i(int, MUTATOR_ARGV_1_int) \
 641     /** record list */    i(string, MUTATOR_ARGV_1_string) \
 642     /**/                  o(string, MUTATOR_ARGV_1_string) \
 643     /**/
 644 MUTATOR_HOOKABLE(GetRecords, EV_GetRecords);
 645
 646 #define EV_Race_FinalCheckpoint(i, o) \
 647     /** player */ i(entity, MUTATOR_ARGV_0_entity) \
 648     /**/
 649 MUTATOR_HOOKABLE(Race_FinalCheckpoint, EV_Race_FinalCheckpoint);
 650
 651 /** called when player triggered kill (or is changing teams), return error to not do anything */
 652 #define EV_ClientKill(i, o) \
 653     /** player */        i(entity, MUTATOR_ARGV_0_entity) \
 654     /** kill delay */    i(float, MUTATOR_ARGV_1_float) \
 655     /**/                 o(float, MUTATOR_ARGV_1_float) \
 656     /**/
 657 MUTATOR_HOOKABLE(ClientKill, EV_ClientKill);
 658
 659 #define EV_FixClientCvars(i, o) \
 660     /** player */        i(entity, MUTATOR_ARGV_0_entity) \
 661     /**/
 662 MUTATOR_HOOKABLE(FixClientCvars, EV_FixClientCvars);
 663
 664 #define EV_SpectateSet(i, o) \
 665     /** client */    i(entity, MUTATOR_ARGV_0_entity) \
 666     /** target */    i(entity, MUTATOR_ARGV_1_entity) \
 667     /**/             o(entity, MUTATOR_ARGV_1_entity) \
 668     /**/
 669 MUTATOR_HOOKABLE(SpectateSet, EV_SpectateSet);
 670
 671 #define EV_SpectateNext(i, o) \
 672     /** client */    i(entity, MUTATOR_ARGV_0_entity) \
 673     /** target */    i(entity, MUTATOR_ARGV_1_entity) \
 674     /**/             o(entity, MUTATOR_ARGV_1_entity) \
 675     /**/
 676 MUTATOR_HOOKABLE(SpectateNext, EV_SpectateNext);
 677
 678 #define EV_SpectatePrev(i, o) \
 679     /** client */    i(entity, MUTATOR_ARGV_0_entity) \
 680     /** target */    i(entity, MUTATOR_ARGV_1_entity) \
 681     /**/             o(entity, MUTATOR_ARGV_1_entity) \
 682         /** first */     i(entity, MUTATOR_ARGV_2_entity) \
 683     /**/
 684 MUTATOR_HOOKABLE(SpectatePrev, EV_SpectatePrev);
 685
 686 enum {
 687     MUT_SPECPREV_CONTINUE, // return this flag to make the function continue as normal
 688     MUT_SPECPREV_RETURN, // return this flag to make the function return (handled entirely by mutator)
 689     MUT_SPECPREV_FOUND // return this flag to make the function continue without default functions (handled mostly by mutator)
 690 };
 691
 692 /** called when player triggered kill (or is changing teams), return error to not do anything */
 693 #define EV_Bot_FixCount(i, o) \
 694         /** active real players */  i(int, MUTATOR_ARGV_0_int) \
 695         /**/                                            o(int, MUTATOR_ARGV_0_int) \
 696     /** real players */                 i(int, MUTATOR_ARGV_1_int) \
 697     /**/                                        o(int, MUTATOR_ARGV_1_int) \
 698     /**/
 699 MUTATOR_HOOKABLE(Bot_FixCount, EV_Bot_FixCount);
 700
 701 #define EV_ClientCommand_Spectate(i, o) \
 702     /** player */ i(entity, MUTATOR_ARGV_0_entity) \
 703     /**/
 704 MUTATOR_HOOKABLE(ClientCommand_Spectate, EV_ClientCommand_Spectate);
 705
 706 enum {
 707     MUT_SPECCMD_CONTINUE, // return this flag to make the function continue as normal
 708     MUT_SPECCMD_RETURN, // return this flag to make the function return (don't spectate)
 709     MUT_SPECCMD_FORCE // return this flag to force the player to spectate, even if they're not a player
 710 };
 711
 712 #define EV_CheckRules_World(i, o) \
 713     /** status */    i(float, MUTATOR_ARGV_0_float) \
 714     /**/             o(float, MUTATOR_ARGV_0_float) \
 715     /* time limit */ i(float, MUTATOR_ARGV_1_float) \
 716     /* frag limit */ i(float, MUTATOR_ARGV_2_float) \
 717     /**/
 718 MUTATOR_HOOKABLE(CheckRules_World, EV_CheckRules_World);
 719
 720 #define EV_WantWeapon(i, o) \
 721     /** weapon info entity */    i(entity, MUTATOR_ARGV_0_entity) \
 722     /** do want? */              i(float, MUTATOR_ARGV_1_float) \
 723     /**/                         o(float, MUTATOR_ARGV_1_float) \
 724     /** want all guns */         i(bool, MUTATOR_ARGV_2_bool) \
 725     /**/                         o(bool, MUTATOR_ARGV_2_bool) \
 726     /** want mutator blocked */  i(bool, MUTATOR_ARGV_3_bool) \
 727     /**/                         o(bool, MUTATOR_ARGV_3_bool) \
 728     /**/
 729 MUTATOR_HOOKABLE(WantWeapon, EV_WantWeapon);
 730
 731 #define EV_AddPlayerScore(i, o) \
 732     /** score field */  i(int, MUTATOR_ARGV_0_int) \
 733     /** score */        i(float, MUTATOR_ARGV_1_float) \
 734     /**/                o(float, MUTATOR_ARGV_1_float) \
 735     /** player */       i(entity, MUTATOR_ARGV_2_entity) \
 736     /**/
 737 MUTATOR_HOOKABLE(AddPlayerScore, EV_AddPlayerScore);
 738
 739 #define EV_GetPlayerStatus(i, o) \
 740     /** player */    i(entity, MUTATOR_ARGV_0_entity) \
 741     /**/
 742 MUTATOR_HOOKABLE(GetPlayerStatus, EV_GetPlayerStatus);
 743
 744 #define EV_SetWeaponArena(i, o) \
 745     /** arena */     i(string, MUTATOR_ARGV_0_string) \
 746     /**/             o(string, MUTATOR_ARGV_0_string) \
 747     /**/
 748 MUTATOR_HOOKABLE(SetWeaponArena, EV_SetWeaponArena);
 749
 750 #define EV_DropSpecialItems(i, o) \
 751     /** target */ i(entity, MUTATOR_ARGV_0_entity) \
 752     /**/
 753 MUTATOR_HOOKABLE(DropSpecialItems, EV_DropSpecialItems);
 754
 755 /**
 756  * called when an admin tries to kill all monsters
 757  * return 1 to prevent spawning
 758  */
 759 #define EV_AllowMobButcher(i, o) \
 760     /** reason */ o(string, MUTATOR_ARGV_0_string) \
 761     /**/
 762 MUTATOR_HOOKABLE(AllowMobButcher, EV_AllowMobButcher);
 763
 764 MUTATOR_HOOKABLE(ReadLevelCvars, EV_NO_ARGS);
 765
 766 #define EV_SendWaypoint(i, o) \
 767         /** waypoint */     i(entity, MUTATOR_ARGV_0_entity) \
 768         /** to */               i(entity, MUTATOR_ARGV_1_entity) \
 769         /** send flags */   i(int, MUTATOR_ARGV_2_int) \
 770         /**/                            o(int, MUTATOR_ARGV_2_int) \
 771         /** wp flag */      i(int, MUTATOR_ARGV_3_int) \
 772         /**/                            o(int, MUTATOR_ARGV_3_int) \
 773     /**/
 774 MUTATOR_HOOKABLE(SendWaypoint, EV_SendWaypoint);
 775
 776 #define EV_TurretValidateTarget(i, o) \
 777     /** turret */          i(entity, MUTATOR_ARGV_0_entity) \
 778     /** target */          i(entity, MUTATOR_ARGV_1_entity) \
 779     /** validate flags */  i(int, MUTATOR_ARGV_2_int) \
 780     /** target score */    o(float, MUTATOR_ARGV_3_float) \
 781     /**/
 782 MUTATOR_HOOKABLE(TurretValidateTarget, EV_TurretValidateTarget);
 783
 784 #define EV_TurretThink(i, o) \
 785     /** turret */ i(entity, MUTATOR_ARGV_0_entity) \
 786     /**/
 787 MUTATOR_HOOKABLE(TurretThink, EV_TurretThink);
 788
 789 MUTATOR_HOOKABLE(Ent_Init, EV_NO_ARGS);
 790
 791 /** */
 792 #define EV_PrepareExplosionByDamage(i, o) \
 793     /** projectile */ i(entity, MUTATOR_ARGV_0_entity) \
 794     /** attacker */   i(entity, MUTATOR_ARGV_1_entity) \
 795     /**/
 796 MUTATOR_HOOKABLE(PrepareExplosionByDamage, EV_PrepareExplosionByDamage);
 797
 798 /** called when a monster model is about to be set, allows custom paths etc. */
 799 #define EV_MonsterModel(i, o) \
 800         /** model */  i(string, MUTATOR_ARGV_0_string) \
 801         /** output */ i(string, MUTATOR_ARGV_1_string) \
 802         /**/              o(string, MUTATOR_ARGV_1_string) \
 803     /**/
 804 MUTATOR_HOOKABLE(MonsterModel, EV_MonsterModel);
 805
 806 /**/
 807 #define EV_Player_ChangeTeam(i, o) \
 808     /** player */         i(entity, MUTATOR_ARGV_0_entity) \
 809         /** current team */   i(float, MUTATOR_ARGV_1_float) \
 810         /** new team */       i(float, MUTATOR_ARGV_2_float) \
 811     /**/
 812 MUTATOR_HOOKABLE(Player_ChangeTeam, EV_Player_ChangeTeam);
 813
 814 /**/
 815 #define EV_URI_GetCallback(i, o) \
 816         /** id */       i(float, MUTATOR_ARGV_0_float) \
 817         /** status */   i(float, MUTATOR_ARGV_1_float) \
 818         /** data */     i(string, MUTATOR_ARGV_2_string) \
 819     /**/
 820 MUTATOR_HOOKABLE(URI_GetCallback, EV_URI_GetCallback);