X-Git-Url: https://de.git.xonotic.org/?a=blobdiff_plain;f=qcsrc%2Fserver%2Fmutators%2Fbase.qh;h=fdfbdfb1223d2c3bfc9111b584c85ce2decc368d;hb=a63f5d0afcdd3c85742b92a4dbc99c324e4ddb6f;hp=61eb83127a2fa592b8c6c9f12e7ef43398fa9a74;hpb=14ee7a437513ad91c6f74b457bfc8da6ce1dbc08;p=xonotic%2Fxonotic-data.pk3dir.git

diff --git a/qcsrc/server/mutators/base.qh b/qcsrc/server/mutators/base.qh
index 61eb83127..fdfbdfb12 100644
--- a/qcsrc/server/mutators/base.qh
+++ b/qcsrc/server/mutators/base.qh
@@ -36,21 +36,96 @@ void Mutator_Remove(float(float) func); // calls error() on fail
 
 
 // register all possible hooks here
+
 MUTATOR_HOOKABLE(MakePlayerObserver);
-MUTATOR_HOOKABLE(MakePlayerSpectator);
+	// called when a player becomes observer, after shared setup
+
 MUTATOR_HOOKABLE(PlayerSpawn);
+	// called when a player spawns as player, after shared setup, before his weapon is chosen (so items may be changed in here)
+
 MUTATOR_HOOKABLE(ClientDisconnect);
-MUTATOR_HOOKABLE(PlayerDies); entity other; entity frag_attacker;
-MUTATOR_HOOKABLE(GiveFragsForKill); entity frag_attacker, frag_target; float frag_score;
+	// called when a player disconnects
+
+MUTATOR_HOOKABLE(PlayerDies);
+	// called when a player dies to e.g. remove stuff he was carrying.
+	// INPUT:
+		entity frag_inflictor;
+		entity frag_attacker;
+		entity frag_target; // same as self
+
+MUTATOR_HOOKABLE(GiveFragsForKill);
+	// called when someone was fragged by "self", and is expected to change frag_score to adjust scoring for the kill
+	// INPUT:
+		entity frag_attacker; // same as self
+		entity frag_target;
+	// INPUT, OUTPUT:
+		float frag_score;
+
 MUTATOR_HOOKABLE(MatchEnd);
-MUTATOR_HOOKABLE(GetTeamCount); float ret_float;
-MUTATOR_HOOKABLE(SpectateCopy); entity other;
+	// called when the match ends
+
+MUTATOR_HOOKABLE(GetTeamCount);
+	// should adjust ret_float to contain the team count
+	// INPUT, OUTPUT:
+		float ret_float;
+
+MUTATOR_HOOKABLE(SpectateCopy);
+	// copies variables for spectating "other" to "self"
+	// INPUT:
+		entity other;
+
 MUTATOR_HOOKABLE(ForbidThrowCurrentWeapon);
+	// returns 1 if throwing the current weapon shall not be allowed
+
 MUTATOR_HOOKABLE(SetStartItems);
-MUTATOR_HOOKABLE(BuildMutatorsString); string ret_string;
-MUTATOR_HOOKABLE(BuildMutatorsPrettyString); string ret_string;
-MUTATOR_HOOKABLE(FilterItem); // return error to request removal, or change self.items or self.weapons
-MUTATOR_HOOKABLE(OnEntityPreSpawn); // return error to prevent entity spawn, or modify the entity
+	// adjusts {warmup_}start_{items,weapons,ammo_{cells,rockets,nails,shells,fuel}}
+
+MUTATOR_HOOKABLE(BuildMutatorsString);
+	// appends ":mutatorname" to ret_string for logging
+	// INPUT, OUTPUT:
+		string ret_string;
+
+MUTATOR_HOOKABLE(BuildMutatorsPrettyString);
+	// appends ", Mutator name" to ret_string for display
+	// INPUT, OUTPUT:
+		string ret_string;
+
+MUTATOR_HOOKABLE(FilterItem);
+	// 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)
+	// return error to request removal
+
+MUTATOR_HOOKABLE(OnEntityPreSpawn);
+	// return error to prevent entity spawn, or modify the entity
+
 MUTATOR_HOOKABLE(PlayerPreThink);
+	// runs in the event loop for players; is called for ALL player entities, also bots, also the dead, or spectators
+
 MUTATOR_HOOKABLE(GetPressedKeys);
+	// TODO change this into a general PlayerPostThink hook?
+
 MUTATOR_HOOKABLE(PlayerPhysics);
+	// called before any player physics, may adjust variables for movement,
+	// is run AFTER bot code and idle checking
+
+MUTATOR_HOOKABLE(GetCvars);
+	// is meant to call GetCvars_handle*(get_cvars_s, get_cvars_f, cvarfield, "cvarname") for cvars this mutator needs from the client
+	// INPUT:
+		float get_cvars_f;
+		string get_cvars_s;
+
+MUTATOR_HOOKABLE(EditProjectile);
+	// can edit any "just fired" projectile
+	// INPUT:
+		entity self;
+		entity other;
+
+MUTATOR_HOOKABLE(PlayerDamage);
+	// called when a player gets damaged to e.g. remove stuff he was carrying.
+	// INPUT:
+		entity frag_inflictor;
+		entity frag_attacker;
+		entity frag_target; // same as self
+		vector damage_force; // NOTE: this force already HAS been applied (create and use a Damage hook to change that one)
+	// INPUT, OUTPUT:
+		float damage_take;
+		float damage_save;