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