1 #define CBC_ORDER_EXCLUSIVE 3
2 #define CBC_ORDER_FIRST 1
3 #define CBC_ORDER_LAST 2
4 #define CBC_ORDER_ANY 4
6 float CallbackChain_ReturnValue; // read-only field of the current return value
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)
17 float CallbackChain_Call(entity cb);
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
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)
36 #define MUTATOR_HOOKABLE(cb) entity HOOK_##cb
37 #define MUTATOR_CALLHOOK(cb) CallbackChain_Call(HOOK_##cb)
39 #define MUTATOR_RETURNVALUE CallbackChain_ReturnValue
44 // register all possible hooks here
46 MUTATOR_HOOKABLE(MakePlayerObserver);
47 // called when a player becomes observer, after shared setup
49 MUTATOR_HOOKABLE(PutClientInServer);
50 entity self; // client wanting to spawn
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)
56 MUTATOR_HOOKABLE(reset_map_global);
57 // called in reset_map
59 MUTATOR_HOOKABLE(reset_map_players);
60 // called in reset_map
62 MUTATOR_HOOKABLE(ForbidPlayerScore_Clear);
63 // returns 1 if clearing player score shall not be allowed
65 MUTATOR_HOOKABLE(ClientDisconnect);
66 // called when a player disconnects
68 MUTATOR_HOOKABLE(PlayerDies);
69 // called when a player dies to e.g. remove stuff he was carrying.
71 entity frag_inflictor;
73 entity frag_target; // same as self
76 MUTATOR_HOOKABLE(GiveFragsForKill);
77 // called when someone was fragged by "self", and is expected to change frag_score to adjust scoring for the kill
79 entity frag_attacker; // same as self
84 MUTATOR_HOOKABLE(MatchEnd);
85 // called when the match ends
87 MUTATOR_HOOKABLE(GetTeamCount);
88 // should adjust ret_float to contain the team count
92 MUTATOR_HOOKABLE(SpectateCopy);
93 // copies variables for spectating "other" to "self"
97 MUTATOR_HOOKABLE(ForbidThrowCurrentWeapon);
98 // returns 1 if throwing the current weapon shall not be allowed
100 MUTATOR_HOOKABLE(SetStartItems);
101 // adjusts {warmup_}start_{items,weapons,ammo_{cells,rockets,nails,shells,fuel}}
103 MUTATOR_HOOKABLE(BuildMutatorsString);
104 // appends ":mutatorname" to ret_string for logging
108 MUTATOR_HOOKABLE(BuildMutatorsPrettyString);
109 // appends ", Mutator name" to ret_string for display
113 MUTATOR_HOOKABLE(CustomizeWaypoint);
114 // called every frame
115 // customizes the waypoint for spectators
116 // INPUT: self = waypoint, other = player, other.enemy = spectator
118 MUTATOR_HOOKABLE(FilterItem);
119 // 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)
120 // return error to request removal
122 MUTATOR_HOOKABLE(TurretSpawn);
123 // return error to request removal
124 // INPUT: self - turret
126 MUTATOR_HOOKABLE(OnEntityPreSpawn);
127 // return error to prevent entity spawn, or modify the entity
129 MUTATOR_HOOKABLE(PlayerPreThink);
130 // runs in the event loop for players; is called for ALL player entities, also bots, also the dead, or spectators
132 MUTATOR_HOOKABLE(GetPressedKeys);
133 // TODO change this into a general PlayerPostThink hook?
135 MUTATOR_HOOKABLE(PlayerPhysics);
136 // called before any player physics, may adjust variables for movement,
137 // is run AFTER bot code and idle checking
139 MUTATOR_HOOKABLE(GetCvars);
140 // is meant to call GetCvars_handle*(get_cvars_s, get_cvars_f, cvarfield, "cvarname") for cvars this mutator needs from the client
145 MUTATOR_HOOKABLE(EditProjectile);
146 // can edit any "just fired" projectile
151 MUTATOR_HOOKABLE(PlayerDamage_SplitHealthArmor);
152 // called when a player gets damaged to e.g. remove stuff he was carrying.
154 entity frag_inflictor;
155 entity frag_attacker;
156 entity frag_target; // same as self
157 vector damage_force; // NOTE: this force already HAS been applied
162 MUTATOR_HOOKABLE(PlayerDamage_Calculate);
163 // called to adjust damage and force values which are applied to the player, used for e.g. strength damage/force multiplier
164 // i'm not sure if I should change this around slightly (Naming of the entities, and also how they're done in g_damage).
166 entity frag_attacker;
168 float frag_deathtype;
171 float frag_mirrordamage;
174 MUTATOR_HOOKABLE(PlayerPowerups);
175 // called at the end of player_powerups() in cl_client.qc, used for manipulating the values which are set by powerup items.
178 float olditems; // also technically output, but since it is at the end of the function it's useless for that :P
180 MUTATOR_HOOKABLE(PlayerUseKey);
181 // called when the use key is pressed
182 // if MUTATOR_RETURNVALUE is 1, don't do anything
183 // return 1 if the use key actually did something
185 MUTATOR_HOOKABLE(SV_ParseClientCommand);
186 // called when a client command is parsed
187 // NOTE: hooks MUST start with if(MUTATOR_RETURNVALUE) return 0;
188 // NOTE: return 1 if you handled the command, return 0 to continue handling
189 // NOTE: THESE HOOKS MUST NEVER EVER CALL tokenize()
191 string cmd_name; // command name
192 float cmd_argc; // also, argv() can be used
193 string cmd_string; // whole command, use only if you really have to
196 MUTATOR_HOOKFUNCTION(foo_SV_ParseClientCommand)
198 if(MUTATOR_RETURNVALUE) // command was already handled?
200 if(cmd_name == "echocvar" && cmd_argc >= 2)
202 print(cvar_string(argv(1)), "\n");
205 if(cmd_name == "echostring" && cmd_argc >= 2)
207 print(substring(cmd_string, argv_start_index(1), argv_end_index(-1) - argv_start_index(1)), "\n");
214 MUTATOR_HOOKABLE(Spawn_Score);
215 // called when a spawnpoint is being evaluated
216 // return 1 to make the spawnpoint unusable
218 entity self; // player wanting to spawn
219 entity spawn_spot; // spot to be evaluated
221 vector spawn_score; // _x is priority, _y is "distance"
223 MUTATOR_HOOKABLE(SV_StartFrame);
224 // runs globally each server frame
226 MUTATOR_HOOKABLE(SetModname);
228 string modname; // name of the mutator/mod if it warrants showing as such in the server browser
230 MUTATOR_HOOKABLE(Item_Spawn);
231 // called for each item being spawned on a map, including dropped weapons
232 // return 1 to remove an item
234 entity self; // the item
236 MUTATOR_HOOKABLE(SetWeaponreplace);
238 entity self; // map entity
239 entity other; // weapon info
243 MUTATOR_HOOKABLE(Item_RespawnCountdown);
244 // called when an item is about to respawn
249 MUTATOR_HOOKABLE(BotShouldAttack);
250 // called when a bot checks a target to attack
254 MUTATOR_HOOKABLE(PortalTeleport);
255 // called whenever a player goes through a portal gun teleport
256 // allows you to strip a player of an item if they go through the teleporter to help prevent cheating
260 MUTATOR_HOOKABLE(HelpMePing);
261 // called whenever a player uses impulse 33 (help me) in cl_impulse.qc
262 // normally help me ping uses self.waypointsprite_attachedforcarrier,
263 // but if your mutator uses something different then you can handle it
264 // in a special manner using this hook
266 entity self; // the player who pressed impulse 33
268 MUTATOR_HOOKABLE(VehicleSpawn);
269 // called when a vehicle initializes
270 // return TRUE to remove the vehicle
272 MUTATOR_HOOKABLE(VehicleEnter);
273 // called when a player enters a vehicle
274 // allows mutators to set special settings in this event
276 entity vh_player; // player
277 entity vh_vehicle; // vehicle
279 MUTATOR_HOOKABLE(VehicleTouch);
280 // called when a player touches a vehicle
281 // return TRUE to stop player from entering the vehicle
283 entity self; // vehicle
284 entity other; // player
286 MUTATOR_HOOKABLE(VehicleExit);
287 // called when a player exits a vehicle
288 // allows mutators to set special settings in this event
290 entity vh_player; // player
291 entity vh_vehicle; // vehicle
293 MUTATOR_HOOKABLE(AbortSpeedrun);
294 // called when a speedrun is aborted and the player is teleported back to start position
296 entity self; // player
298 MUTATOR_HOOKABLE(ItemTouch);
299 // called at when a item is touched. Called early, can edit item properties.
301 entity other; // player
302 #define MUT_ITEMTOUCH_CONTINUE 0 // return this flag to make the function continue as normal
303 #define MUT_ITEMTOUCH_RETURN 1 // return this flag to make the function return (handled entirely by mutator)
304 #define MUT_ITEMTOUCH_PICKUP 2 // return this flag to have the item "picked up" and taken even after mutator handled it
306 MUTATOR_HOOKABLE(ClientConnect);
307 // called at when a player connect
308 entity self; // player
310 MUTATOR_HOOKABLE(HavocBot_ChooseRule);