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