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