qcsrc/server/mutators/events.qh

   1 #ifndef SERVER_MUTATORS_EVENTS_H
   2 #define SERVER_MUTATORS_EVENTS_H
   3
   4 #include "../../common/mutators/base.qh"
   5
   6 // register all possible hooks here
   7
   8 /** called when a player becomes observer, after shared setup */
   9 #define EV_MakePlayerObserver(i, o) \
  10     /**/
  11 MUTATOR_HOOKABLE(MakePlayerObserver, EV_MakePlayerObserver)
  12
  13 /** */
  14 #define EV_PutClientInServer(i, o) \
  15     /** client wanting to spawn */ i(entity, self) \
  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     /** spot that was used, or world */ i(entity, spawn_spot) \
  22     /**/
  23 entity spawn_spot;
  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     /**/
  44 MUTATOR_HOOKABLE(ClientDisconnect, EV_ClientDisconnect);
  45
  46 /** called when a player dies to e.g. remove stuff he was carrying. */
  47 #define EV_PlayerDies(i, o) \
  48     /**/ i(entity, frag_inflictor) \
  49     /**/ i(entity, frag_attacker) \
  50     /** same as self */ i(entity, frag_target) \
  51     /**/ i(int, frag_deathtype) \
  52     /**/
  53 entity frag_inflictor;
  54 entity frag_attacker;
  55 entity frag_target;
  56 int frag_deathtype;
  57 MUTATOR_HOOKABLE(PlayerDies, EV_PlayerDies);
  58
  59 /** called when a player dies to e.g. remove stuff he was carrying */
  60 #define EV_PlayHitsound(i, o) \
  61     /**/ i(entity, frag_victim) \
  62     /**/
  63 entity frag_victim;
  64 MUTATOR_HOOKABLE(PlayHitsound, EV_PlayHitsound);
  65
  66 /** called when a weapon sound is about to be played, allows custom paths etc. */
  67 #define EV_WeaponSound(i, o) \
  68     /**/ i(string, weapon_sound) \
  69     /**/ i(string, weapon_sound_output) \
  70     /**/ o(string, weapon_sound_output) \
  71     /**/
  72 string weapon_sound;
  73 string weapon_sound_output;
  74 MUTATOR_HOOKABLE(WeaponSound, EV_WeaponSound);
  75
  76 /** called when a weapon model is about to be set, allows custom paths etc. */
  77 #define EV_WeaponModel(i, o) \
  78     /**/ i(string, weapon_model) \
  79     /**/ i(string, weapon_model_output) \
  80     /**/ o(string, weapon_model_output) \
  81     /**/
  82 string weapon_model;
  83 string weapon_model_output;
  84 MUTATOR_HOOKABLE(WeaponModel, EV_WeaponModel);
  85
  86 /** called when an item model is about to be set, allows custom paths etc. */
  87 #define EV_ItemModel(i, o) \
  88     /**/ i(string, item_model) \
  89     /**/ i(string, item_model_output) \
  90     /**/ o(string, item_model_output) \
  91     /**/
  92 string item_model;
  93 string item_model_output;
  94 MUTATOR_HOOKABLE(ItemModel, EV_ItemModel);
  95
  96 /** called when a player presses the jump key */
  97 #define EV_PlayerJump(i, o) \
  98     /**/ i(float, player_multijump) \
  99     /**/ i(float, player_jumpheight) \
 100     /**/ o(float, player_multijump) \
 101     /**/ o(float, player_jumpheight) \
 102     /**/
 103 float player_multijump;
 104 float player_jumpheight;
 105 MUTATOR_HOOKABLE(PlayerJump, EV_PlayerJump);
 106
 107 /** called when someone was fragged by "self", and is expected to change frag_score to adjust scoring for the kill */
 108 #define EV_GiveFragsForKill(i, o) \
 109     /** same as self */ i(entity, frag_attacker) \
 110     /**/ i(entity, frag_target) \
 111     /**/ i(float, frag_score) \
 112     /**/ o(float, frag_score) \
 113     /**/
 114 float frag_score;
 115 MUTATOR_HOOKABLE(GiveFragsForKill, EV_GiveFragsForKill);
 116
 117 /** called when the match ends */
 118 MUTATOR_HOOKABLE(MatchEnd, EV_NO_ARGS);
 119
 120 /** should adjust ret_float to contain the team count */
 121 #define EV_GetTeamCount(i, o) \
 122     /**/ i(float, ret_float) \
 123     /**/ o(float, ret_float) \
 124     /**/
 125 float ret_float;
 126 MUTATOR_HOOKABLE(GetTeamCount, EV_GetTeamCount);
 127
 128 /** copies variables for spectating "other" to "self" */
 129 #define EV_SpectateCopy(i, o) \
 130     /**/ i(entity, other) \
 131     /**/ i(entity, self) \
 132     /**/
 133 MUTATOR_HOOKABLE(SpectateCopy, EV_SpectateCopy);
 134
 135 /** called when formatting a chat message to replace fancy functions */
 136 #define EV_FormatMessage(i, o) \
 137     /**/ i(string, format_escape) \
 138     /**/ i(string, format_replacement) \
 139     /**/ o(string, format_replacement) \
 140     /**/
 141 string format_escape;
 142 string format_replacement;
 143 MUTATOR_HOOKABLE(FormatMessage, EV_FormatMessage);
 144
 145 /** returns 1 if throwing the current weapon shall not be allowed */
 146 MUTATOR_HOOKABLE(ForbidThrowCurrentWeapon, EV_NO_ARGS);
 147
 148 /** allows changing attack rate */
 149 #define EV_WeaponRateFactor(i, o) \
 150     /**/ i(float, weapon_rate) \
 151     /**/ o(float, weapon_rate) \
 152     /**/
 153 float weapon_rate;
 154 MUTATOR_HOOKABLE(WeaponRateFactor, EV_WeaponRateFactor);
 155
 156 /** allows changing weapon speed (projectiles mostly) */
 157 #define EV_WeaponSpeedFactor(i, o) \
 158     /**/ i(float, ret_float) \
 159     /**/ o(float, ret_float) \
 160     /**/
 161 MUTATOR_HOOKABLE(WeaponSpeedFactor, EV_WeaponSpeedFactor);
 162
 163 /** adjusts {warmup_}start_{items,weapons,ammo_{cells,plasma,rockets,nails,shells,fuel}} */
 164 MUTATOR_HOOKABLE(SetStartItems, EV_NO_ARGS);
 165
 166 /** called every frame. customizes the waypoint for spectators */
 167 #define EV_CustomizeWaypoint(i, o) \
 168     /** waypoint */ i(entity, self) \
 169     /** player; other.enemy = spectator */ i(entity, other) \
 170     /**/
 171 MUTATOR_HOOKABLE(CustomizeWaypoint, EV_CustomizeWaypoint);
 172
 173 /**
 174  * 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)
 175  * return error to request removal
 176  */
 177 MUTATOR_HOOKABLE(FilterItem, EV_NO_ARGS);
 178
 179 /** return error to request removal */
 180 #define EV_TurretSpawn(i, o) \
 181     /** turret */ i(entity, self) \
 182     /**/
 183 MUTATOR_HOOKABLE(TurretSpawn, EV_TurretSpawn);
 184
 185 /** return error to not attack */
 186 #define EV_TurretFire(i, o) \
 187     /** turret */ i(entity, self) \
 188     /**/
 189 MUTATOR_HOOKABLE(TurretFire, EV_TurretFire);
 190
 191 /** return error to not attack */
 192 #define EV_Turret_CheckFire(i, o) \
 193     /**/ i(bool, ret_bool) \
 194     /**/ o(bool, ret_bool) \
 195     /**/
 196 bool ret_bool;
 197 MUTATOR_HOOKABLE(Turret_CheckFire, EV_Turret_CheckFire);
 198
 199 /** return error to prevent entity spawn, or modify the entity */
 200 MUTATOR_HOOKABLE(OnEntityPreSpawn, EV_NO_ARGS);
 201
 202 /** runs in the event loop for players; is called for ALL player entities, also bots, also the dead, or spectators */
 203 MUTATOR_HOOKABLE(PlayerPreThink, EV_NO_ARGS);
 204
 205 /** TODO change this into a general PlayerPostThink hook? */
 206 MUTATOR_HOOKABLE(GetPressedKeys, EV_NO_ARGS);
 207
 208 /**
 209  * called before any player physics, may adjust variables for movement,
 210  * is run AFTER bot code and idle checking
 211  */
 212 MUTATOR_HOOKABLE(PlayerPhysics, EV_NO_ARGS);
 213
 214 /** is meant to call GetCvars_handle*(get_cvars_s, get_cvars_f, cvarfield, "cvarname") for cvars this mutator needs from the client */
 215 #define EV_GetCvars(i, o) \
 216     /**/ i(float, get_cvars_f) \
 217     /**/ i(string, get_cvars_s) \
 218     /**/
 219 float get_cvars_f;
 220 string get_cvars_s;
 221 MUTATOR_HOOKABLE(GetCvars, EV_NO_ARGS); // NOTE: Can't use EV_GetCvars because of `SZ_GetSpace: overflow`
 222
 223 /** can edit any "just fired" projectile */
 224 #define EV_EditProjectile(i, o) \
 225     /**/ i(entity, self) \
 226     /**/ i(entity, other) \
 227     /**/
 228 MUTATOR_HOOKABLE(EditProjectile, EV_EditProjectile);
 229
 230 /** called when a monster spawns */
 231 MUTATOR_HOOKABLE(MonsterSpawn, EV_NO_ARGS);
 232
 233 /** called when a monster dies */
 234 #define EV_MonsterDies(i, o) \
 235     /**/ i(entity, frag_attacker) \
 236     /**/
 237 MUTATOR_HOOKABLE(MonsterDies, EV_MonsterDies);
 238
 239 /** called when a monster dies */
 240 #define EV_MonsterRemove(i, o) \
 241     /**/ i(entity, rem_mon) \
 242     /**/
 243 entity rem_mon; // avoiding ovewriting self & other
 244 MUTATOR_HOOKABLE(MonsterRemove, EV_MonsterRemove);
 245
 246 /** called when a monster wants to respawn */
 247 #define EV_MonsterRespawn(i, o) \
 248     /**/ i(entity, other) \
 249     /**/
 250 MUTATOR_HOOKABLE(MonsterRespawn, EV_MonsterRespawn);
 251
 252 /** called when a monster is dropping loot */
 253 #define EV_MonsterDropItem(i, o) \
 254     /**/ i(entity, other) \
 255     /**/ o(entity, other) \
 256     /**/
 257 .void() monster_loot;
 258 MUTATOR_HOOKABLE(MonsterDropItem, EV_MonsterDropItem);
 259
 260 /**
 261  * called when a monster moves
 262  * returning true makes the monster stop
 263  */
 264 #define EV_MonsterMove(i, o) \
 265     /**/ i(float, monster_speed_run) \
 266     /**/ o(float, monster_speed_run) \
 267     /**/ i(float, monster_speed_walk) \
 268     /**/ o(float, monster_speed_walk) \
 269     /**/ i(entity, monster_target) \
 270     /**/
 271 float monster_speed_run;
 272 float monster_speed_walk;
 273 entity monster_target;
 274 MUTATOR_HOOKABLE(MonsterMove, EV_MonsterMove);
 275
 276 /** called when a monster looks for another target */
 277 MUTATOR_HOOKABLE(MonsterFindTarget, EV_NO_ARGS);
 278
 279 /** called to change a random monster to a miniboss */
 280 MUTATOR_HOOKABLE(MonsterCheckBossFlag, EV_NO_ARGS);
 281
 282 /**
 283  * called when a player tries to spawn a monster
 284  * return 1 to prevent spawning
 285  */
 286 MUTATOR_HOOKABLE(AllowMobSpawning, EV_NO_ARGS);
 287
 288 /** called when a player gets damaged to e.g. remove stuff he was carrying. */
 289 #define EV_PlayerDamage_SplitHealthArmor(i, o) \
 290     /**/ i(entity, frag_inflictor) \
 291     /**/ i(entity, frag_attacker) \
 292     /** same as self */ i(entity, frag_target) \
 293     /** NOTE: this force already HAS been applied */ i(vector, damage_force) \
 294     /**/ i(float, damage_take) \
 295     /**/ o(float, damage_take) \
 296         /**/ i(float, damage_save) \
 297     /**/ o(float, damage_save) \
 298     /**/
 299 vector damage_force;
 300 float damage_take;
 301 float damage_save;
 302 MUTATOR_HOOKABLE(PlayerDamage_SplitHealthArmor, EV_PlayerDamage_SplitHealthArmor);
 303
 304 /**
 305  * called to adjust damage and force values which are applied to the player, used for e.g. strength damage/force multiplier
 306  * i'm not sure if I should change this around slightly (Naming of the entities, and also how they're done in g_damage).
 307  */
 308 #define EV_PlayerDamage_Calculate(i, o) \
 309     /**/ i(entity, frag_attacker) \
 310     /**/ i(entity, frag_target) \
 311     /**/ i(float, frag_deathtype) \
 312         /**/ i(float, frag_damage) \
 313     /**/ o(float, frag_damage) \
 314         /**/ i(float, frag_mirrordamage) \
 315     /**/ o(float, frag_mirrordamage) \
 316     /**/ i(vector, frag_force) \
 317     /**/ o(vector, frag_force) \
 318     /**/
 319 float frag_damage;
 320 float frag_mirrordamage;
 321 vector frag_force;
 322 MUTATOR_HOOKABLE(PlayerDamage_Calculate, EV_PlayerDamage_Calculate);
 323
 324 /**
 325  * Called when a player is damaged
 326  */
 327 #define EV_PlayerDamaged(i, o) \
 328     /** attacker */ i(entity, mutator_argv_entity_0) \
 329     /** target */ i(entity, mutator_argv_entity_1) \
 330     /** health */ i(int, mutator_argv_int_0) \
 331     /** armor */ i(int, mutator_argv_int_1) \
 332     /** location */ i(vector, mutator_argv_vector_0) \
 333     /**/
 334 MUTATOR_HOOKABLE(PlayerDamaged, EV_PlayerDamaged);
 335
 336 /** called at the end of player_powerups() in cl_client.qc, used for manipulating the values which are set by powerup items. */
 337 #define EV_PlayerPowerups(i, o) \
 338     /**/ i(entity, self) \
 339     /**/ i(int, olditems) \
 340     /**/
 341 int olditems;
 342 MUTATOR_HOOKABLE(PlayerPowerups, EV_PlayerPowerups);
 343
 344 /**
 345  * called every player think frame
 346  * return 1 to disable regen
 347  */
 348 #define EV_PlayerRegen(i, o) \
 349     /**/ i(float, regen_mod_max) \
 350     /**/ o(float, regen_mod_max) \
 351     /**/ i(float, regen_mod_regen) \
 352     /**/ o(float, regen_mod_regen) \
 353     /**/ i(float, regen_mod_rot) \
 354     /**/ o(float, regen_mod_rot) \
 355     /**/ i(float, regen_mod_limit) \
 356     /**/ o(float, regen_mod_limit) \
 357     /**/
 358 float regen_mod_max;
 359 float regen_mod_regen;
 360 float regen_mod_rot;
 361 float regen_mod_limit;
 362 MUTATOR_HOOKABLE(PlayerRegen, EV_PlayerRegen);
 363
 364 /**
 365  * called when the use key is pressed
 366  * if MUTATOR_RETURNVALUE is 1, don't do anything
 367  * return 1 if the use key actually did something
 368  */
 369 MUTATOR_HOOKABLE(PlayerUseKey, EV_NO_ARGS);
 370
 371 /**
 372  * called when a client command is parsed
 373  * NOTE: hooks MUST start with if (MUTATOR_RETURNVALUE) return false;
 374  * NOTE: return true if you handled the command, return false to continue handling
 375  * NOTE: THESE HOOKS MUST NEVER EVER CALL tokenize()
 376  * // example:
 377  * MUTATOR_HOOKFUNCTION(foo_SV_ParseClientCommand)
 378  * {
 379  *     if (MUTATOR_RETURNVALUE) // command was already handled?
 380  *         return false;
 381  *     if (cmd_name == "echocvar" && cmd_argc >= 2)
 382  *     {
 383  *         print(cvar_string(argv(1)), "\n");
 384  *         return true;
 385  *     }
 386  *     if (cmd_name == "echostring" && cmd_argc >= 2)
 387  *     {
 388  *         print(substring(cmd_string, argv_start_index(1), argv_end_index(-1) - argv_start_index(1)), "\n");
 389  *         return true;
 390  *     }
 391  *     return false;
 392  * }
 393  */
 394 #define EV_SV_ParseClientCommand(i, o) \
 395     /** command name */ i(string, cmd_name) \
 396     /** also, argv() can be used */ i(int, cmd_argc) \
 397     /** whole command, use only if you really have to */ i(string, cmd_string) \
 398     /**/
 399 string cmd_name;
 400 int cmd_argc;
 401 string cmd_string;
 402 MUTATOR_HOOKABLE(SV_ParseClientCommand, EV_SV_ParseClientCommand);
 403
 404 /**
 405  * called when a spawnpoint is being evaluated
 406  * return 1 to make the spawnpoint unusable
 407  */
 408 #define EV_Spawn_Score(i, o) \
 409     /** player wanting to spawn */ i(entity, self) \
 410     /** spot to be evaluated */ i(entity, spawn_spot) \
 411     /** _x is priority, _y is "distance" */ i(vector, spawn_score) \
 412     /**/ o(vector, spawn_score) \
 413     /**/
 414 vector spawn_score;
 415 MUTATOR_HOOKABLE(Spawn_Score, EV_Spawn_Score);
 416
 417 /** runs globally each server frame */
 418 MUTATOR_HOOKABLE(SV_StartFrame, EV_NO_ARGS);
 419
 420 #define EV_SetModname(i, o) \
 421     /** name of the mutator/mod if it warrants showing as such in the server browser */ \
 422     o(string, modname) \
 423     /**/
 424 MUTATOR_HOOKABLE(SetModname, EV_SetModname);
 425
 426 /**
 427  * called for each item being spawned on a map, including dropped weapons
 428  * return 1 to remove an item
 429  */
 430 #define EV_Item_Spawn(i, o) \
 431     /** the item */ i(entity, self) \
 432     /**/
 433 MUTATOR_HOOKABLE(Item_Spawn, EV_Item_Spawn);
 434
 435 #define EV_SetWeaponreplace(i, o) \
 436     /** map entity */ i(entity, self) \
 437     /** weapon info */ i(entity, other) \
 438     /**/ i(string, ret_string) \
 439     /**/ o(string, ret_string) \
 440     /**/
 441 MUTATOR_HOOKABLE(SetWeaponreplace, EV_SetWeaponreplace);
 442
 443 /** called when an item is about to respawn */
 444 #define EV_Item_RespawnCountdown(i, o) \
 445     /**/ i(string, item_name) \
 446     /**/ o(string, item_name) \
 447     /**/ i(vector, item_color) \
 448     /**/ o(vector, item_color) \
 449     /**/
 450 string item_name;
 451 vector item_color;
 452 MUTATOR_HOOKABLE(Item_RespawnCountdown, EV_Item_RespawnCountdown);
 453
 454 /** called when a bot checks a target to attack */
 455 #define EV_BotShouldAttack(i, o) \
 456     /**/ i(entity, checkentity) \
 457     /**/
 458 entity checkentity;
 459 MUTATOR_HOOKABLE(BotShouldAttack, EV_BotShouldAttack);
 460
 461 /**
 462  * called whenever a player goes through a portal gun teleport
 463  * allows you to strip a player of an item if they go through the teleporter to help prevent cheating
 464  */
 465 #define EV_PortalTeleport(i, o) \
 466     /**/ i(entity, self) \
 467     /**/
 468 MUTATOR_HOOKABLE(PortalTeleport, EV_PortalTeleport);
 469
 470 /**
 471  * called whenever a player uses impulse 33 (help me) in cl_impulse.qc
 472  * normally help me ping uses self.waypointsprite_attachedforcarrier,
 473  * but if your mutator uses something different then you can handle it
 474  * in a special manner using this hook
 475  */
 476 #define EV_HelpMePing(i, o) \
 477     /** the player who pressed impulse 33 */ i(entity, self) \
 478     /**/
 479 MUTATOR_HOOKABLE(HelpMePing, EV_HelpMePing);
 480
 481 /**
 482  * called when a vehicle initializes
 483  * return true to remove the vehicle
 484  */
 485 MUTATOR_HOOKABLE(VehicleSpawn, EV_NO_ARGS);
 486
 487 /**
 488  * called when a player enters a vehicle
 489  * allows mutators to set special settings in this event
 490  */
 491 #define EV_VehicleEnter(i, o) \
 492     /** player */ i(entity, vh_player) \
 493     /** vehicle */ i(entity, vh_vehicle) \
 494     /**/
 495 entity vh_player;
 496 entity vh_vehicle;
 497 MUTATOR_HOOKABLE(VehicleEnter, EV_VehicleEnter);
 498
 499 /**
 500  * called when a player touches a vehicle
 501  * return true to stop player from entering the vehicle
 502  */
 503 #define EV_VehicleTouch(i, o) \
 504     /** vehicle */ i(entity, self) \
 505     /** player */ i(entity, other) \
 506     /**/
 507 MUTATOR_HOOKABLE(VehicleTouch, EV_VehicleTouch);
 508
 509 /**
 510  * called when a player exits a vehicle
 511  * allows mutators to set special settings in this event
 512  */
 513 #define EV_VehicleExit(i, o) \
 514     /** player */ i(entity, vh_player) \
 515     /** vehicle */ i(entity, vh_vehicle) \
 516     /**/
 517 MUTATOR_HOOKABLE(VehicleExit, EV_VehicleExit);
 518
 519 /** called when a speedrun is aborted and the player is teleported back to start position */
 520 #define EV_AbortSpeedrun(i, o) \
 521     /** player */ i(entity, self) \
 522     /**/
 523 MUTATOR_HOOKABLE(AbortSpeedrun, EV_AbortSpeedrun);
 524
 525 /** called at when a item is touched. Called early, can edit item properties. */
 526 #define EV_ItemTouch(i, o) \
 527     /** item */ i(entity, self) \
 528     /** player */ i(entity, other) \
 529     /**/
 530 MUTATOR_HOOKABLE(ItemTouch, EV_ItemTouch);
 531
 532 enum {
 533         MUT_ITEMTOUCH_CONTINUE, // return this flag to make the function continue as normal
 534         MUT_ITEMTOUCH_RETURN, // return this flag to make the function return (handled entirely by mutator)
 535         MUT_ITEMTOUCH_PICKUP // return this flag to have the item "picked up" and taken even after mutator handled it
 536 };
 537
 538 /** called at when a player connect */
 539 #define EV_ClientConnect(i, o) \
 540     /** player */ i(entity, self) \
 541     /**/
 542 MUTATOR_HOOKABLE(ClientConnect, EV_ClientConnect);
 543
 544 #define EV_HavocBot_ChooseRole(i, o) \
 545     /**/ i(entity, self) \
 546     /**/
 547 MUTATOR_HOOKABLE(HavocBot_ChooseRole, EV_HavocBot_ChooseRole);
 548
 549 /** called when a target is checked for accuracy */
 550 #define EV_AccuracyTargetValid(i, o) \
 551     /** attacker */ i(entity, frag_attacker) \
 552     /** target */ i(entity, frag_target) \
 553     /**/
 554 MUTATOR_HOOKABLE(AccuracyTargetValid, EV_AccuracyTargetValid);
 555 enum {
 556         MUT_ACCADD_VALID, // return this flag to make the function continue if target is a client
 557         MUT_ACCADD_INVALID, // return this flag to make the function always continue
 558         MUT_ACCADD_INDIFFERENT // return this flag to make the function always return
 559 };
 560
 561 /** Called when clearing the global parameters for a model */
 562 MUTATOR_HOOKABLE(ClearModelParams, EV_NO_ARGS);
 563
 564 /** Called when getting the global parameters for a model */
 565 #define EV_GetModelParams(i, o) \
 566     /** entity id */ i(string, checkmodel_input) \
 567     /** entity id */ i(string, checkmodel_command) \
 568     /**/
 569 string checkmodel_input, checkmodel_command;
 570 MUTATOR_HOOKABLE(GetModelParams, EV_GetModelParams);
 571
 572 /** called when a bullet has hit a target */
 573 #define EV_FireBullet_Hit(i, o) \
 574     /**/ i(entity, self) \
 575     /**/ i(entity, bullet_hit) \
 576     /**/ i(vector, bullet_startpos) \
 577     /**/ i(vector, bullet_endpos) \
 578     /**/ i(float, frag_damage) \
 579     /**/ o(float, frag_damage) \
 580     /**/
 581 entity bullet_hit;
 582 //vector bullet_hitloc; // the end pos matches the hit location, apparently
 583 vector bullet_startpos;
 584 vector bullet_endpos;
 585 //float frag_damage;
 586 MUTATOR_HOOKABLE(FireBullet_Hit, EV_FireBullet_Hit);
 587
 588 #define EV_FixPlayermodel(i, o) \
 589     /**/ i(string, ret_string) \
 590     /**/ o(string, ret_string) \
 591     /**/
 592 MUTATOR_HOOKABLE(FixPlayermodel, EV_FixPlayermodel);
 593
 594 /** Return error to play frag remaining announcements */
 595 MUTATOR_HOOKABLE(Scores_CountFragsRemaining, EV_NO_ARGS);
 596 #endif