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 prevent entity spawn, or modify the entity */
 186 MUTATOR_HOOKABLE(OnEntityPreSpawn, EV_NO_ARGS);
 187
 188 /** runs in the event loop for players; is called for ALL player entities, also bots, also the dead, or spectators */
 189 MUTATOR_HOOKABLE(PlayerPreThink, EV_NO_ARGS);
 190
 191 /** TODO change this into a general PlayerPostThink hook? */
 192 MUTATOR_HOOKABLE(GetPressedKeys, EV_NO_ARGS);
 193
 194 /**
 195  * called before any player physics, may adjust variables for movement,
 196  * is run AFTER bot code and idle checking
 197  */
 198 MUTATOR_HOOKABLE(PlayerPhysics, EV_NO_ARGS);
 199
 200 /** is meant to call GetCvars_handle*(get_cvars_s, get_cvars_f, cvarfield, "cvarname") for cvars this mutator needs from the client */
 201 #define EV_GetCvars(i, o) \
 202     /**/ i(float, get_cvars_f) \
 203     /**/ i(string, get_cvars_s) \
 204     /**/
 205 float get_cvars_f;
 206 string get_cvars_s;
 207 MUTATOR_HOOKABLE(GetCvars, EV_NO_ARGS); // NOTE: Can't use EV_GetCvars because of `SZ_GetSpace: overflow`
 208
 209 /** can edit any "just fired" projectile */
 210 #define EV_EditProjectile(i, o) \
 211     /**/ i(entity, self) \
 212     /**/ i(entity, other) \
 213     /**/
 214 MUTATOR_HOOKABLE(EditProjectile, EV_EditProjectile);
 215
 216 /** called when a monster spawns */
 217 MUTATOR_HOOKABLE(MonsterSpawn, EV_NO_ARGS);
 218
 219 /** called when a monster dies */
 220 #define EV_MonsterDies(i, o) \
 221     /**/ i(entity, frag_attacker) \
 222     /**/
 223 MUTATOR_HOOKABLE(MonsterDies, EV_MonsterDies);
 224
 225 /** called when a monster wants to respawn */
 226 #define EV_MonsterRespawn(i, o) \
 227     /**/ i(entity, other) \
 228     /**/
 229 MUTATOR_HOOKABLE(MonsterRespawn, EV_MonsterRespawn);
 230
 231 /** called when a monster is dropping loot */
 232 #define EV_MonsterDropItem(i, o) \
 233     /**/ i(entity, other) \
 234     /**/ o(entity, other) \
 235     /**/
 236 .void() monster_loot;
 237 MUTATOR_HOOKABLE(MonsterDropItem, EV_MonsterDropItem);
 238
 239 /**
 240  * called when a monster moves
 241  * returning true makes the monster stop
 242  */
 243 #define EV_MonsterMove(i, o) \
 244     /**/ i(float, monster_speed_run) \
 245     /**/ o(float, monster_speed_run) \
 246     /**/ i(float, monster_speed_walk) \
 247     /**/ o(float, monster_speed_walk) \
 248     /**/ i(entity, monster_target) \
 249     /**/
 250 float monster_speed_run;
 251 float monster_speed_walk;
 252 entity monster_target;
 253 MUTATOR_HOOKABLE(MonsterMove, EV_MonsterMove);
 254
 255 /** called when a monster looks for another target */
 256 MUTATOR_HOOKABLE(MonsterFindTarget, EV_NO_ARGS);
 257
 258 /** called to change a random monster to a miniboss */
 259 MUTATOR_HOOKABLE(MonsterCheckBossFlag, EV_NO_ARGS);
 260
 261 /**
 262  * called when a player tries to spawn a monster
 263  * return 1 to prevent spawning
 264  */
 265 MUTATOR_HOOKABLE(AllowMobSpawning, EV_NO_ARGS);
 266
 267 /** called when a player gets damaged to e.g. remove stuff he was carrying. */
 268 #define EV_PlayerDamage_SplitHealthArmor(i, o) \
 269     /**/ i(entity, frag_inflictor) \
 270     /**/ i(entity, frag_attacker) \
 271     /** same as self */ i(entity, frag_target) \
 272     /** NOTE: this force already HAS been applied */ i(vector, damage_force) \
 273     /**/ i(float, damage_take) \
 274     /**/ o(float, damage_take) \
 275         /**/ i(float, damage_save) \
 276     /**/ o(float, damage_save) \
 277     /**/
 278 vector damage_force;
 279 float damage_take;
 280 float damage_save;
 281 MUTATOR_HOOKABLE(PlayerDamage_SplitHealthArmor, EV_PlayerDamage_SplitHealthArmor);
 282
 283 /**
 284  * called to adjust damage and force values which are applied to the player, used for e.g. strength damage/force multiplier
 285  * i'm not sure if I should change this around slightly (Naming of the entities, and also how they're done in g_damage).
 286  */
 287 #define EV_PlayerDamage_Calculate(i, o) \
 288     /**/ i(entity, frag_attacker) \
 289     /**/ i(entity, frag_target) \
 290     /**/ i(float, frag_deathtype) \
 291         /**/ i(float, frag_damage) \
 292     /**/ o(float, frag_damage) \
 293         /**/ i(float, frag_mirrordamage) \
 294     /**/ o(float, frag_mirrordamage) \
 295     /**/ i(vector, frag_force) \
 296     /**/ o(vector, frag_force) \
 297     /**/
 298 float frag_damage;
 299 float frag_mirrordamage;
 300 vector frag_force;
 301 MUTATOR_HOOKABLE(PlayerDamage_Calculate, EV_PlayerDamage_Calculate);
 302
 303 /**
 304  * Called when a player is damaged
 305  */
 306 #define EV_PlayerDamaged(i, o) \
 307     /** attacker */ i(entity, mutator_argv_entity_0) \
 308     /** target */ i(entity, mutator_argv_entity_1) \
 309     /** health */ i(int, mutator_argv_int_0) \
 310     /** armor */ i(int, mutator_argv_int_1) \
 311     /** location */ i(vector, mutator_argv_vector_0) \
 312     /**/
 313 MUTATOR_HOOKABLE(PlayerDamaged, EV_PlayerDamaged);
 314
 315 /** called at the end of player_powerups() in cl_client.qc, used for manipulating the values which are set by powerup items. */
 316 #define EV_PlayerPowerups(i, o) \
 317     /**/ i(entity, self) \
 318     /**/ i(int, olditems) \
 319     /**/
 320 int olditems;
 321 MUTATOR_HOOKABLE(PlayerPowerups, EV_PlayerPowerups);
 322
 323 /**
 324  * called every player think frame
 325  * return 1 to disable regen
 326  */
 327 #define EV_PlayerRegen(i, o) \
 328     /**/ i(float, regen_mod_max) \
 329     /**/ o(float, regen_mod_max) \
 330     /**/ i(float, regen_mod_regen) \
 331     /**/ o(float, regen_mod_regen) \
 332     /**/ i(float, regen_mod_rot) \
 333     /**/ o(float, regen_mod_rot) \
 334     /**/ i(float, regen_mod_limit) \
 335     /**/ o(float, regen_mod_limit) \
 336     /**/
 337 float regen_mod_max;
 338 float regen_mod_regen;
 339 float regen_mod_rot;
 340 float regen_mod_limit;
 341 MUTATOR_HOOKABLE(PlayerRegen, EV_PlayerRegen);
 342
 343 /**
 344  * called when the use key is pressed
 345  * if MUTATOR_RETURNVALUE is 1, don't do anything
 346  * return 1 if the use key actually did something
 347  */
 348 MUTATOR_HOOKABLE(PlayerUseKey, EV_NO_ARGS);
 349
 350 /**
 351  * called when a client command is parsed
 352  * NOTE: hooks MUST start with if (MUTATOR_RETURNVALUE) return false;
 353  * NOTE: return true if you handled the command, return false to continue handling
 354  * NOTE: THESE HOOKS MUST NEVER EVER CALL tokenize()
 355  * // example:
 356  * MUTATOR_HOOKFUNCTION(foo_SV_ParseClientCommand)
 357  * {
 358  *     if (MUTATOR_RETURNVALUE) // command was already handled?
 359  *         return false;
 360  *     if (cmd_name == "echocvar" && cmd_argc >= 2)
 361  *     {
 362  *         print(cvar_string(argv(1)), "\n");
 363  *         return true;
 364  *     }
 365  *     if (cmd_name == "echostring" && cmd_argc >= 2)
 366  *     {
 367  *         print(substring(cmd_string, argv_start_index(1), argv_end_index(-1) - argv_start_index(1)), "\n");
 368  *         return true;
 369  *     }
 370  *     return false;
 371  * }
 372  */
 373 #define EV_SV_ParseClientCommand(i, o) \
 374     /** command name */ i(string, cmd_name) \
 375     /** also, argv() can be used */ i(int, cmd_argc) \
 376     /** whole command, use only if you really have to */ i(string, cmd_string) \
 377     /**/
 378 string cmd_name;
 379 int cmd_argc;
 380 string cmd_string;
 381 MUTATOR_HOOKABLE(SV_ParseClientCommand, EV_SV_ParseClientCommand);
 382
 383 /**
 384  * called when a spawnpoint is being evaluated
 385  * return 1 to make the spawnpoint unusable
 386  */
 387 #define EV_Spawn_Score(i, o) \
 388     /** player wanting to spawn */ i(entity, self) \
 389     /** spot to be evaluated */ i(entity, spawn_spot) \
 390     /** _x is priority, _y is "distance" */ i(vector, spawn_score) \
 391     /**/ o(vector, spawn_score) \
 392     /**/
 393 vector spawn_score;
 394 MUTATOR_HOOKABLE(Spawn_Score, EV_Spawn_Score);
 395
 396 /** runs globally each server frame */
 397 MUTATOR_HOOKABLE(SV_StartFrame, EV_NO_ARGS);
 398
 399 #define EV_SetModname(i, o) \
 400     /** name of the mutator/mod if it warrants showing as such in the server browser */ \
 401     o(string, modname) \
 402     /**/
 403 MUTATOR_HOOKABLE(SetModname, EV_SetModname);
 404
 405 /**
 406  * called for each item being spawned on a map, including dropped weapons
 407  * return 1 to remove an item
 408  */
 409 #define EV_Item_Spawn(i, o) \
 410     /** the item */ i(entity, self) \
 411     /**/
 412 MUTATOR_HOOKABLE(Item_Spawn, EV_Item_Spawn);
 413
 414 #define EV_SetWeaponreplace(i, o) \
 415     /** map entity */ i(entity, self) \
 416     /** weapon info */ i(entity, other) \
 417     /**/ i(string, ret_string) \
 418     /**/ o(string, ret_string) \
 419     /**/
 420 MUTATOR_HOOKABLE(SetWeaponreplace, EV_SetWeaponreplace);
 421
 422 /** called when an item is about to respawn */
 423 #define EV_Item_RespawnCountdown(i, o) \
 424     /**/ i(string, item_name) \
 425     /**/ o(string, item_name) \
 426     /**/ i(vector, item_color) \
 427     /**/ o(vector, item_color) \
 428     /**/
 429 string item_name;
 430 vector item_color;
 431 MUTATOR_HOOKABLE(Item_RespawnCountdown, EV_Item_RespawnCountdown);
 432
 433 /** called when a bot checks a target to attack */
 434 #define EV_BotShouldAttack(i, o) \
 435     /**/ i(entity, checkentity) \
 436     /**/
 437 entity checkentity;
 438 MUTATOR_HOOKABLE(BotShouldAttack, EV_BotShouldAttack);
 439
 440 /**
 441  * called whenever a player goes through a portal gun teleport
 442  * allows you to strip a player of an item if they go through the teleporter to help prevent cheating
 443  */
 444 #define EV_PortalTeleport(i, o) \
 445     /**/ i(entity, self) \
 446     /**/
 447 MUTATOR_HOOKABLE(PortalTeleport, EV_PortalTeleport);
 448
 449 /**
 450  * called whenever a player uses impulse 33 (help me) in cl_impulse.qc
 451  * normally help me ping uses self.waypointsprite_attachedforcarrier,
 452  * but if your mutator uses something different then you can handle it
 453  * in a special manner using this hook
 454  */
 455 #define EV_HelpMePing(i, o) \
 456     /** the player who pressed impulse 33 */ i(entity, self) \
 457     /**/
 458 MUTATOR_HOOKABLE(HelpMePing, EV_HelpMePing);
 459
 460 /**
 461  * called when a vehicle initializes
 462  * return true to remove the vehicle
 463  */
 464 MUTATOR_HOOKABLE(VehicleSpawn, EV_NO_ARGS);
 465
 466 /**
 467  * called when a player enters a vehicle
 468  * allows mutators to set special settings in this event
 469  */
 470 #define EV_VehicleEnter(i, o) \
 471     /** player */ i(entity, vh_player) \
 472     /** vehicle */ i(entity, vh_vehicle) \
 473     /**/
 474 entity vh_player;
 475 entity vh_vehicle;
 476 MUTATOR_HOOKABLE(VehicleEnter, EV_VehicleEnter);
 477
 478 /**
 479  * called when a player touches a vehicle
 480  * return true to stop player from entering the vehicle
 481  */
 482 #define EV_VehicleTouch(i, o) \
 483     /** vehicle */ i(entity, self) \
 484     /** player */ i(entity, other) \
 485     /**/
 486 MUTATOR_HOOKABLE(VehicleTouch, EV_VehicleTouch);
 487
 488 /**
 489  * called when a player exits a vehicle
 490  * allows mutators to set special settings in this event
 491  */
 492 #define EV_VehicleExit(i, o) \
 493     /** player */ i(entity, vh_player) \
 494     /** vehicle */ i(entity, vh_vehicle) \
 495     /**/
 496 MUTATOR_HOOKABLE(VehicleExit, EV_VehicleExit);
 497
 498 /** called when a speedrun is aborted and the player is teleported back to start position */
 499 #define EV_AbortSpeedrun(i, o) \
 500     /** player */ i(entity, self) \
 501     /**/
 502 MUTATOR_HOOKABLE(AbortSpeedrun, EV_AbortSpeedrun);
 503
 504 /** called at when a item is touched. Called early, can edit item properties. */
 505 #define EV_ItemTouch(i, o) \
 506     /** item */ i(entity, self) \
 507     /** player */ i(entity, other) \
 508     /**/
 509 MUTATOR_HOOKABLE(ItemTouch, EV_ItemTouch);
 510
 511 enum {
 512         MUT_ITEMTOUCH_CONTINUE, // return this flag to make the function continue as normal
 513         MUT_ITEMTOUCH_RETURN, // return this flag to make the function return (handled entirely by mutator)
 514         MUT_ITEMTOUCH_PICKUP // return this flag to have the item "picked up" and taken even after mutator handled it
 515 };
 516
 517 /** called at when a player connect */
 518 #define EV_ClientConnect(i, o) \
 519     /** player */ i(entity, self) \
 520     /**/
 521 MUTATOR_HOOKABLE(ClientConnect, EV_ClientConnect);
 522
 523 #define EV_HavocBot_ChooseRole(i, o) \
 524     /**/ i(entity, self) \
 525     /**/
 526 MUTATOR_HOOKABLE(HavocBot_ChooseRole, EV_HavocBot_ChooseRole);
 527
 528 /** called when a target is checked for accuracy */
 529 #define EV_AccuracyTargetValid(i, o) \
 530     /** attacker */ i(entity, frag_attacker) \
 531     /** target */ i(entity, frag_target) \
 532     /**/
 533 MUTATOR_HOOKABLE(AccuracyTargetValid, EV_AccuracyTargetValid);
 534 enum {
 535         MUT_ACCADD_VALID, // return this flag to make the function continue if target is a client
 536         MUT_ACCADD_INVALID, // return this flag to make the function always continue
 537         MUT_ACCADD_INDIFFERENT // return this flag to make the function always return
 538 };
 539 #endif