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(PlayerJump);
77 // called when a player presses the jump key
79 float player_multijump;
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
84 entity frag_attacker; // same as self
89 MUTATOR_HOOKABLE(MatchEnd);
90 // called when the match ends
92 MUTATOR_HOOKABLE(GetTeamCount);
93 // should adjust ret_float to contain the team count
97 MUTATOR_HOOKABLE(SpectateCopy);
98 // copies variables for spectating "other" to "self"
102 MUTATOR_HOOKABLE(ForbidThrowCurrentWeapon);
103 // returns 1 if throwing the current weapon shall not be allowed
105 MUTATOR_HOOKABLE(SetStartItems);
106 // adjusts {warmup_}start_{items,weapons,ammo_{cells,rockets,nails,shells,fuel}}
108 MUTATOR_HOOKABLE(BuildMutatorsString);
109 // appends ":mutatorname" to ret_string for logging
113 MUTATOR_HOOKABLE(BuildMutatorsPrettyString);
114 // appends ", Mutator name" to ret_string for display
118 MUTATOR_HOOKABLE(CustomizeWaypoint);
119 // called every frame
120 // customizes the waypoint for spectators
121 // INPUT: self = waypoint, other = player, other.enemy = spectator
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
127 MUTATOR_HOOKABLE(TurretSpawn);
128 // return error to request removal
129 // INPUT: self - turret
131 MUTATOR_HOOKABLE(TurretDies);
132 // called when a turret dies
134 MUTATOR_HOOKABLE(TurretValidateTarget);
135 // return target score
137 entity turret_target;
141 MUTATOR_HOOKABLE(OnEntityPreSpawn);
142 // return error to prevent entity spawn, or modify the entity
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
147 MUTATOR_HOOKABLE(GetPressedKeys);
148 // TODO change this into a general PlayerPostThink hook?
150 MUTATOR_HOOKABLE(PlayerPhysics);
151 // called before any player physics, may adjust variables for movement,
152 // is run AFTER bot code and idle checking
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
160 MUTATOR_HOOKABLE(EditProjectile);
161 // can edit any "just fired" projectile
166 MUTATOR_HOOKABLE(MonsterSpawn);
167 // called when a monster spawns
169 MUTATOR_HOOKABLE(MonsterDies);
170 // called when a monster dies
172 entity frag_attacker;
174 MUTATOR_HOOKABLE(MonsterRespawn);
175 // called when a monster wants to respawn
179 MUTATOR_HOOKABLE(MonsterDropItem);
180 // called when a monster is dropping loot
182 .void() monster_loot;
185 MUTATOR_HOOKABLE(MonsterMove);
186 // called when a monster moves
187 // returning TRUE makes the monster stop
189 float monster_speed_run;
190 float monster_speed_walk;
191 entity monster_target;
193 MUTATOR_HOOKABLE(MonsterFindTarget);
194 // called when a monster looks for another target
196 MUTATOR_HOOKABLE(MonsterCheckBossFlag);
197 // called to change a random monster to a miniboss
199 MUTATOR_HOOKABLE(PlayerDamage_SplitHealthArmor);
200 // called when a player gets damaged to e.g. remove stuff he was carrying.
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
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).
214 entity frag_attacker;
216 float frag_deathtype;
219 float frag_mirrordamage;
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.
226 float olditems; // also technically output, but since it is at the end of the function it's useless for that :P
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
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()
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
244 MUTATOR_HOOKFUNCTION(foo_SV_ParseClientCommand)
246 if(MUTATOR_RETURNVALUE) // command was already handled?
248 if(cmd_name == "echocvar" && cmd_argc >= 2)
250 print(cvar_string(argv(1)), "\n");
253 if(cmd_name == "echostring" && cmd_argc >= 2)
255 print(substring(cmd_string, argv_start_index(1), argv_end_index(-1) - argv_start_index(1)), "\n");
262 MUTATOR_HOOKABLE(Spawn_Score);
263 // called when a spawnpoint is being evaluated
264 // return 1 to make the spawnpoint unusable
266 entity self; // player wanting to spawn
267 entity spawn_spot; // spot to be evaluated
269 vector spawn_score; // _x is priority, _y is "distance"
271 MUTATOR_HOOKABLE(SV_StartFrame);
272 // runs globally each server frame
274 MUTATOR_HOOKABLE(SetModname);
276 string modname; // name of the mutator/mod if it warrants showing as such in the server browser
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
282 entity self; // the item
284 MUTATOR_HOOKABLE(SetWeaponreplace);
286 entity self; // map entity
287 entity other; // weapon info
291 MUTATOR_HOOKABLE(Item_RespawnCountdown);
292 // called when an item is about to respawn
297 MUTATOR_HOOKABLE(BotShouldAttack);
298 // called when a bot checks a target to attack
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
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
314 entity self; // the player who pressed impulse 33
316 MUTATOR_HOOKABLE(VehicleSpawn);
317 // called when a vehicle initializes
318 // return TRUE to remove the vehicle
320 MUTATOR_HOOKABLE(VehicleEnter);
321 // called when a player enters a vehicle
322 // allows mutators to set special settings in this event
324 entity vh_player; // player
325 entity vh_vehicle; // vehicle
327 MUTATOR_HOOKABLE(VehicleTouch);
328 // called when a player touches a vehicle
329 // return TRUE to stop player from entering the vehicle
331 entity self; // vehicle
332 entity other; // player
334 MUTATOR_HOOKABLE(VehicleExit);
335 // called when a player exits a vehicle
336 // allows mutators to set special settings in this event
338 entity vh_player; // player
339 entity vh_vehicle; // vehicle
341 MUTATOR_HOOKABLE(AbortSpeedrun);
342 // called when a speedrun is aborted and the player is teleported back to start position
344 entity self; // player
346 MUTATOR_HOOKABLE(ItemTouch);
347 // called at when a item is touched. Called early, can edit item properties.
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
354 MUTATOR_HOOKABLE(ClientConnect);
355 // called at when a player connect
356 entity self; // player
358 MUTATOR_HOOKABLE(HavocBot_ChooseRule);