qcsrc/server/mutators/base.qh

   1 #define CBC_ORDER_EXCLUSIVE 3
   2 #define CBC_ORDER_FIRST 1
   3 #define CBC_ORDER_LAST 2
   4 #define CBC_ORDER_ANY 4
   5
   6 float CallbackChain_ReturnValue; // read-only field of the current return value
   7
   8 entity CallbackChain_New(string name);
   9 float CallbackChain_Add(entity cb, float() func, float order);
  10 float CallbackChain_Remove(entity cb, float() func);
  11 // a callback function is like this:
  12 // float mycallback(entity me)
  13 // {
  14 //   do something
  15 //   return r;
  16 // }
  17 float CallbackChain_Call(entity cb);
  18
  19 #define MUTATOR_REMOVING 0
  20 #define MUTATOR_ADDING 1
  21 #define MUTATOR_ROLLING_BACK 2
  22 typedef float(float) mutatorfunc_t;
  23 float Mutator_Add(mutatorfunc_t func, string name);
  24 void Mutator_Remove(mutatorfunc_t func, string name); // calls error() on fail
  25
  26 #define MUTATOR_ADD(name) Mutator_Add(MUTATOR_##name, #name)
  27 #define MUTATOR_REMOVE(name) Mutator_Remove(MUTATOR_##name, #name)
  28 #define MUTATOR_DEFINITION(name) float MUTATOR_##name(float mode)
  29 #define MUTATOR_DECLARATION(name) float MUTATOR_##name(float mode)
  30 #define MUTATOR_HOOKFUNCTION(name) float HOOKFUNCTION_##name()
  31 #define MUTATOR_HOOK(cb,func,order) do { if(mode == MUTATOR_ADDING) { if(!HOOK_##cb) HOOK_##cb = CallbackChain_New(#cb); if(!CallbackChain_Add(HOOK_##cb,HOOKFUNCTION_##func,order)) { print("HOOK FAILED: ", #func, "\n"); return 1; } } else if(mode == MUTATOR_REMOVING || mode == MUTATOR_ROLLING_BACK) { if(HOOK_##cb) CallbackChain_Remove(HOOK_##cb,HOOKFUNCTION_##func); } } while(0)
  32 #define MUTATOR_ONADD if(mode == MUTATOR_ADDING)
  33 #define MUTATOR_ONREMOVE if(mode == MUTATOR_REMOVING)
  34 #define MUTATOR_ONROLLBACK_OR_REMOVE if(mode == MUTATOR_REMOVING || mode == MUTATOR_ROLLING_BACK)
  35
  36 #define MUTATOR_HOOKABLE(cb) entity HOOK_##cb
  37 #define MUTATOR_CALLHOOK(cb) CallbackChain_Call(HOOK_##cb)
  38
  39 #define MUTATOR_RETURNVALUE CallbackChain_ReturnValue
  40
  41
  42
  43
  44 // register all possible hooks here
  45
  46 MUTATOR_HOOKABLE(MakePlayerObserver);
  47         // called when a player becomes observer, after shared setup
  48
  49 MUTATOR_HOOKABLE(PutClientInServer);
  50         entity self; // client wanting to spawn
  51
  52 MUTATOR_HOOKABLE(PlayerSpawn);
  53         entity spawn_spot; // spot that was used, or world
  54         // called when a player spawns as player, after shared setup, before his weapon is chosen (so items may be changed in here)
  55
  56 MUTATOR_HOOKABLE(reset_map_global);
  57         // called in reset_map
  58
  59 MUTATOR_HOOKABLE(reset_map_players);
  60         // called in reset_map
  61
  62 MUTATOR_HOOKABLE(ForbidPlayerScore_Clear);
  63         // returns 1 if clearing player score shall not be allowed
  64
  65 MUTATOR_HOOKABLE(ClientDisconnect);
  66         // called when a player disconnects
  67
  68 MUTATOR_HOOKABLE(PlayerDies);
  69         // called when a player dies to e.g. remove stuff he was carrying.
  70         // INPUT:
  71                 entity frag_inflictor;
  72                 entity frag_attacker;
  73                 entity frag_target; // same as self
  74                 float frag_deathtype;
  75
  76 MUTATOR_HOOKABLE(PlayerJump);
  77         // called when a player presses the jump key
  78         // INPUT, OUTPUT:
  79                 float player_multijump;
  80
  81 MUTATOR_HOOKABLE(GiveFragsForKill);
  82         // called when someone was fragged by "self", and is expected to change frag_score to adjust scoring for the kill
  83         // INPUT:
  84                 entity frag_attacker; // same as self
  85                 entity frag_target;
  86         // INPUT, OUTPUT:
  87                 float frag_score;
  88
  89 MUTATOR_HOOKABLE(MatchEnd);
  90         // called when the match ends
  91
  92 MUTATOR_HOOKABLE(GetTeamCount);
  93         // should adjust ret_float to contain the team count
  94         // INPUT, OUTPUT:
  95                 float ret_float;
  96
  97 MUTATOR_HOOKABLE(SpectateCopy);
  98         // copies variables for spectating "other" to "self"
  99         // INPUT:
 100                 entity other;
 101
 102 MUTATOR_HOOKABLE(ForbidThrowCurrentWeapon);
 103         // returns 1 if throwing the current weapon shall not be allowed
 104
 105 MUTATOR_HOOKABLE(SetStartItems);
 106         // adjusts {warmup_}start_{items,weapons,ammo_{cells,rockets,nails,shells,fuel}}
 107
 108 MUTATOR_HOOKABLE(BuildMutatorsString);
 109         // appends ":mutatorname" to ret_string for logging
 110         // INPUT, OUTPUT:
 111                 string ret_string;
 112
 113 MUTATOR_HOOKABLE(BuildMutatorsPrettyString);
 114         // appends ", Mutator name" to ret_string for display
 115         // INPUT, OUTPUT:
 116                 string ret_string;
 117
 118 MUTATOR_HOOKABLE(CustomizeWaypoint);
 119         // called every frame
 120         // customizes the waypoint for spectators
 121         // INPUT: self = waypoint, other = player, other.enemy = spectator
 122
 123 MUTATOR_HOOKABLE(FilterItem);
 124         // 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)
 125         // return error to request removal
 126
 127 MUTATOR_HOOKABLE(TurretSpawn);
 128         // return error to request removal
 129         // INPUT: self - turret
 130
 131 MUTATOR_HOOKABLE(TurretDies);
 132         // called when a turret dies
 133
 134 MUTATOR_HOOKABLE(TurretValidateTarget);
 135         // return target score
 136         // INPUT:
 137                 entity turret_target;
 138                 entity turret;
 139                 float turret_flags;
 140
 141 MUTATOR_HOOKABLE(OnEntityPreSpawn);
 142         // return error to prevent entity spawn, or modify the entity
 143
 144 MUTATOR_HOOKABLE(PlayerPreThink);
 145         // runs in the event loop for players; is called for ALL player entities, also bots, also the dead, or spectators
 146
 147 MUTATOR_HOOKABLE(GetPressedKeys);
 148         // TODO change this into a general PlayerPostThink hook?
 149
 150 MUTATOR_HOOKABLE(PlayerPhysics);
 151         // called before any player physics, may adjust variables for movement,
 152         // is run AFTER bot code and idle checking
 153
 154 MUTATOR_HOOKABLE(GetCvars);
 155         // is meant to call GetCvars_handle*(get_cvars_s, get_cvars_f, cvarfield, "cvarname") for cvars this mutator needs from the client
 156         // INPUT:
 157                 float get_cvars_f;
 158                 string get_cvars_s;
 159
 160 MUTATOR_HOOKABLE(EditProjectile);
 161         // can edit any "just fired" projectile
 162         // INPUT:
 163                 entity self;
 164                 entity other;
 165
 166 MUTATOR_HOOKABLE(MonsterSpawn);
 167         // called when a monster spawns
 168
 169 MUTATOR_HOOKABLE(MonsterDies);
 170         // called when a monster dies
 171         // INPUT:
 172                 entity frag_attacker;
 173
 174 MUTATOR_HOOKABLE(MonsterRespawn);
 175         // called when a monster wants to respawn
 176         // INPUT:
 177                 entity other;
 178
 179 MUTATOR_HOOKABLE(MonsterDropItem);
 180         // called when a monster is dropping loot
 181         // INPUT, OUTPUT:
 182                 .void() monster_loot;
 183                 entity other;
 184
 185 MUTATOR_HOOKABLE(MonsterMove);
 186         // called when a monster moves
 187         // returning TRUE makes the monster stop
 188         // INPUT:
 189                 float monster_speed_run;
 190                 float monster_speed_walk;
 191                 entity monster_target;
 192
 193 MUTATOR_HOOKABLE(MonsterFindTarget);
 194         // called when a monster looks for another target
 195
 196 MUTATOR_HOOKABLE(MonsterCheckBossFlag);
 197     // called to change a random monster to a miniboss
 198
 199 MUTATOR_HOOKABLE(PlayerDamage_SplitHealthArmor);
 200         // called when a player gets damaged to e.g. remove stuff he was carrying.
 201         // INPUT:
 202                 entity frag_inflictor;
 203                 entity frag_attacker;
 204                 entity frag_target; // same as self
 205                 vector damage_force; // NOTE: this force already HAS been applied
 206         // INPUT, OUTPUT:
 207                 float damage_take;
 208                 float damage_save;
 209
 210 MUTATOR_HOOKABLE(PlayerDamage_Calculate);
 211         // called to adjust damage and force values which are applied to the player, used for e.g. strength damage/force multiplier
 212         // i'm not sure if I should change this around slightly (Naming of the entities, and also how they're done in g_damage).
 213         // INPUT:
 214                 entity frag_attacker;
 215                 entity frag_target;
 216                 float frag_deathtype;
 217         // INPUT, OUTPUT:
 218                 float frag_damage;
 219                 float frag_mirrordamage;
 220                 vector frag_force;
 221
 222 MUTATOR_HOOKABLE(PlayerPowerups);
 223         // called at the end of player_powerups() in cl_client.qc, used for manipulating the values which are set by powerup items.
 224         // INPUT
 225         entity self;
 226         float olditems; // also technically output, but since it is at the end of the function it's useless for that :P
 227
 228 MUTATOR_HOOKABLE(PlayerUseKey);
 229         // called when the use key is pressed
 230         // if MUTATOR_RETURNVALUE is 1, don't do anything
 231         // return 1 if the use key actually did something
 232
 233 MUTATOR_HOOKABLE(SV_ParseClientCommand);
 234         // called when a client command is parsed
 235         // NOTE: hooks MUST start with if(MUTATOR_RETURNVALUE) return 0;
 236         // NOTE: return 1 if you handled the command, return 0 to continue handling
 237         // NOTE: THESE HOOKS MUST NEVER EVER CALL tokenize()
 238         // INPUT
 239         string cmd_name; // command name
 240         float cmd_argc; // also, argv() can be used
 241         string cmd_string; // whole command, use only if you really have to
 242         /*
 243                 // example:
 244                 MUTATOR_HOOKFUNCTION(foo_SV_ParseClientCommand)
 245                 {
 246                         if(MUTATOR_RETURNVALUE) // command was already handled?
 247                                 return 0;
 248                         if(cmd_name == "echocvar" && cmd_argc >= 2)
 249                         {
 250                                 print(cvar_string(argv(1)), "\n");
 251                                 return 1;
 252                         }
 253                         if(cmd_name == "echostring" && cmd_argc >= 2)
 254                         {
 255                                 print(substring(cmd_string, argv_start_index(1), argv_end_index(-1) - argv_start_index(1)), "\n");
 256                                 return 1;
 257                         }
 258                         return 0;
 259                 }
 260         */
 261
 262 MUTATOR_HOOKABLE(Spawn_Score);
 263         // called when a spawnpoint is being evaluated
 264         // return 1 to make the spawnpoint unusable
 265         // INPUT
 266         entity self; // player wanting to spawn
 267         entity spawn_spot; // spot to be evaluated
 268         // IN+OUT
 269         vector spawn_score; // _x is priority, _y is "distance"
 270
 271 MUTATOR_HOOKABLE(SV_StartFrame);
 272         // runs globally each server frame
 273
 274 MUTATOR_HOOKABLE(SetModname);
 275         // OUT
 276         string modname; // name of the mutator/mod if it warrants showing as such in the server browser
 277
 278 MUTATOR_HOOKABLE(Item_Spawn);
 279         // called for each item being spawned on a map, including dropped weapons
 280         // return 1 to remove an item
 281         // INPUT
 282         entity self; // the item
 283
 284 MUTATOR_HOOKABLE(SetWeaponreplace);
 285         // IN
 286                 entity self; // map entity
 287                 entity other; // weapon info
 288         // IN+OUT
 289                 string ret_string;
 290
 291 MUTATOR_HOOKABLE(Item_RespawnCountdown);
 292         // called when an item is about to respawn
 293         // INPUT+OUTPUT:
 294         string item_name;
 295         vector item_color;
 296
 297 MUTATOR_HOOKABLE(BotShouldAttack);
 298         // called when a bot checks a target to attack
 299         // INPUT
 300         entity checkentity;
 301
 302 MUTATOR_HOOKABLE(PortalTeleport);
 303         // called whenever a player goes through a portal gun teleport
 304         // allows you to strip a player of an item if they go through the teleporter to help prevent cheating
 305         // INPUT
 306         entity self;
 307
 308 MUTATOR_HOOKABLE(HelpMePing);
 309         // called whenever a player uses impulse 33 (help me) in cl_impulse.qc
 310         // normally help me ping uses self.waypointsprite_attachedforcarrier,
 311         // but if your mutator uses something different then you can handle it
 312         // in a special manner using this hook
 313         // INPUT
 314         entity self; // the player who pressed impulse 33
 315
 316 MUTATOR_HOOKABLE(VehicleSpawn);
 317         // called when a vehicle initializes
 318         // return TRUE to remove the vehicle
 319
 320 MUTATOR_HOOKABLE(VehicleEnter);
 321         // called when a player enters a vehicle
 322         // allows mutators to set special settings in this event
 323         // INPUT
 324         entity vh_player; // player
 325         entity vh_vehicle; // vehicle
 326
 327 MUTATOR_HOOKABLE(VehicleTouch);
 328         // called when a player touches a vehicle
 329         // return TRUE to stop player from entering the vehicle
 330         // INPUT
 331         entity self; // vehicle
 332         entity other; // player
 333
 334 MUTATOR_HOOKABLE(VehicleExit);
 335         // called when a player exits a vehicle
 336         // allows mutators to set special settings in this event
 337         // INPUT
 338         entity vh_player; // player
 339         entity vh_vehicle; // vehicle
 340
 341 MUTATOR_HOOKABLE(AbortSpeedrun);
 342         // called when a speedrun is aborted and the player is teleported back to start position
 343         // INPUT
 344         entity self; // player
 345
 346 MUTATOR_HOOKABLE(ItemTouch);
 347         // called at when a item is touched. Called early, can edit item properties.
 348         entity self;    // item
 349         entity other;   // player
 350         #define MUT_ITEMTOUCH_CONTINUE 0 // return this flag to make the function continue as normal
 351         #define MUT_ITEMTOUCH_RETURN 1 // return this flag to make the function return (handled entirely by mutator)
 352         #define MUT_ITEMTOUCH_PICKUP 2 // return this flag to have the item "picked up" and taken even after mutator handled it
 353
 354 MUTATOR_HOOKABLE(ClientConnect);
 355         // called at when a player connect
 356         entity self;    // player
 357
 358 MUTATOR_HOOKABLE(HavocBot_ChooseRule);
 359         entity self;