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