]> de.git.xonotic.org Git - xonotic/xonotic-data.pk3dir.git/blobdiff - qcsrc/server/mutators/events.qh
Merge branch 'master' into TimePath/scoreboard_elo
[xonotic/xonotic-data.pk3dir.git] / qcsrc / server / mutators / events.qh
index 0d692ba2f2e2bd7203b37efa99b5fab423af7c9d..6c3c8c1b7b31d4457aa7e4c1d047c88f90ce016e 100644 (file)
@@ -19,7 +19,7 @@ MUTATOR_HOOKABLE(PutClientInServer, EV_PutClientInServer);
 /** called when a player spawns as player, after shared setup, before his weapon is chosen (so items may be changed in here) */
 #define EV_PlayerSpawn(i, o) \
        /** player spawning */ i(entity, MUTATOR_ARGV_0_entity) \
-    /** spot that was used, or world */ i(entity, MUTATOR_ARGV_1_entity) \
+    /** spot that was used, or NULL */ i(entity, MUTATOR_ARGV_1_entity) \
     /**/
 MUTATOR_HOOKABLE(PlayerSpawn, EV_PlayerSpawn);
 
@@ -98,7 +98,7 @@ MUTATOR_HOOKABLE(MatchEnd, EV_NO_ARGS);
     /**/
 MUTATOR_HOOKABLE(GetTeamCount, EV_GetTeamCount);
 
-/** copies variables for spectating "other" to "self" */
+/** copies variables for spectating "spectatee" to "this" */
 #define EV_SpectateCopy(i, o) \
     /** spectatee   */ i(entity, MUTATOR_ARGV_0_entity) \
     /** client      */ i(entity, MUTATOR_ARGV_1_entity) \
@@ -123,7 +123,7 @@ MUTATOR_HOOKABLE(ForbidThrowCurrentWeapon, EV_ForbidThrowCurrentWeapon);
 
 /** returns true if dropping the current weapon shall not be allowed at any time including death */
 #define EV_ForbidDropCurrentWeapon(i, o) \
-    /** player        */ i(entity, MUTATOR_ARGV_0_entity) \
+    /** player */ i(entity, MUTATOR_ARGV_0_entity) \
     /**/
 MUTATOR_HOOKABLE(ForbidDropCurrentWeapon, EV_ForbidDropCurrentWeapon);
 
@@ -157,7 +157,7 @@ MUTATOR_HOOKABLE(SetStartItems, EV_NO_ARGS);
 MUTATOR_HOOKABLE(CustomizeWaypoint, EV_CustomizeWaypoint);
 
 /**
- * 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)
+ * checks if the current item may be spawned (.items and .weapons may be read and written to, as well as the ammo_ fields)
  * return error to request removal
  */
 #define EV_FilterItem(i, o) \
@@ -191,10 +191,16 @@ MUTATOR_HOOKABLE(Turret_CheckFire, EV_Turret_CheckFire);
 MUTATOR_HOOKABLE(OnEntityPreSpawn, EV_OnEntityPreSpawn);
 
 /** runs in the event loop for players; is called for ALL player entities, also bots, also the dead, or spectators */
-MUTATOR_HOOKABLE(PlayerPreThink, EV_NO_ARGS);
+#define EV_PlayerPreThink(i, o) \
+    /** player */ i(entity, MUTATOR_ARGV_0_entity) \
+    /**/
+MUTATOR_HOOKABLE(PlayerPreThink, EV_PlayerPreThink);
 
 /** TODO change this into a general PlayerPostThink hook? */
-MUTATOR_HOOKABLE(GetPressedKeys, EV_NO_ARGS);
+#define EV_GetPressedKeys(i, o) \
+    /** player */ i(entity, MUTATOR_ARGV_0_entity) \
+    /**/
+MUTATOR_HOOKABLE(GetPressedKeys, EV_GetPressedKeys);
 
 /** is meant to call GetCvars_handle*(get_cvars_s, get_cvars_f, cvarfield, "cvarname") for cvars this mutator needs from the client */
 #define EV_GetCvars(i, o) \
@@ -355,24 +361,40 @@ MUTATOR_HOOKABLE(PlayerPowerups, EV_PlayerPowerups);
  * called every player think frame
  * return 1 to disable regen
  */
-float regen_mod_max;
-float regen_mod_regen;
-float regen_mod_rot;
-float regen_mod_limit;
-float regen_health;
-float regen_health_linear;
-float regen_health_rot;
-float regen_health_rotlinear;
-float regen_health_stable;
-float regen_health_rotstable;
-MUTATOR_HOOKABLE(PlayerRegen, EV_NO_ARGS);
+ #define EV_PlayerRegen(i, o) \
+    /** player */               i(entity, MUTATOR_ARGV_0_entity) \
+    /** max_mod */              i(float, MUTATOR_ARGV_1_float) \
+    /**/                        o(float, MUTATOR_ARGV_1_float) \
+    /** regen_mod */            i(float, MUTATOR_ARGV_2_float) \
+    /**/                        o(float, MUTATOR_ARGV_2_float) \
+    /** rot_mod */              i(float, MUTATOR_ARGV_3_float) \
+    /**/                        o(float, MUTATOR_ARGV_3_float) \
+    /** limit_mod */            i(float, MUTATOR_ARGV_4_float) \
+    /**/                        o(float, MUTATOR_ARGV_4_float) \
+    /** health_regen */         i(float, MUTATOR_ARGV_5_float) \
+    /**/                        o(float, MUTATOR_ARGV_5_float) \
+    /** health_regenlinear */   i(float, MUTATOR_ARGV_6_float) \
+    /**/                        o(float, MUTATOR_ARGV_6_float) \
+    /** health_rot */           i(float, MUTATOR_ARGV_7_float) \
+    /**/                        o(float, MUTATOR_ARGV_7_float) \
+    /** health_rotlinear */     i(float, MUTATOR_ARGV_8_float) \
+    /**/                        o(float, MUTATOR_ARGV_8_float) \
+    /** health_stable */        i(float, MUTATOR_ARGV_9_float) \
+    /**/                        o(float, MUTATOR_ARGV_9_float) \
+    /** health_rotstable */     i(float, MUTATOR_ARGV_10_float) \
+    /**/                        o(float, MUTATOR_ARGV_10_float) \
+    /**/
+MUTATOR_HOOKABLE(PlayerRegen, EV_PlayerRegen);
 
 /**
  * called when the use key is pressed
  * if MUTATOR_RETURNVALUE is 1, don't do anything
  * return 1 if the use key actually did something
  */
-MUTATOR_HOOKABLE(PlayerUseKey, EV_NO_ARGS);
+ #define EV_PlayerUseKey(i, o) \
+    /** player */ i(entity, MUTATOR_ARGV_0_entity) \
+    /**/
+MUTATOR_HOOKABLE(PlayerUseKey, EV_PlayerUseKey);
 
 /**
  * called when a client command is parsed
@@ -420,8 +442,8 @@ MUTATOR_HOOKABLE(SV_ParseServerCommand, EV_SV_ParseServerCommand);
 #define EV_Spawn_Score(i, o) \
     /** player wanting to spawn */ i(entity, MUTATOR_ARGV_0_entity) \
     /** spot to be evaluated */ i(entity, MUTATOR_ARGV_1_entity) \
-    /** spot score, _x is priority, _y is "distance" */ i(vector, MUTATOR_ARGV_0_vector) \
-    /**/ o(vector, MUTATOR_ARGV_0_vector) \
+    /** spot score, _x is priority, _y is "distance" */ i(vector, MUTATOR_ARGV_2_vector) \
+    /**/ o(vector, MUTATOR_ARGV_2_vector) \
     /**/
 MUTATOR_HOOKABLE(Spawn_Score, EV_Spawn_Score);
 
@@ -478,7 +500,7 @@ MUTATOR_HOOKABLE(PortalTeleport, EV_PortalTeleport);
 
 /**
  * called whenever a player uses impulse 33 (help me) in cl_impulse.qc
- * normally help me ping uses self.waypointsprite_attachedforcarrier,
+ * normally help me ping uses .waypointsprite_attachedforcarrier,
  * but if your mutator uses something different then you can handle it
  * in a special manner using this hook
  */
@@ -536,6 +558,7 @@ MUTATOR_HOOKABLE(AbortSpeedrun, EV_AbortSpeedrun);
 #define EV_ItemTouch(i, o) \
     /** item */    i(entity, MUTATOR_ARGV_0_entity) \
     /** toucher */ i(entity, MUTATOR_ARGV_1_entity) \
+    /**/           o(entity, MUTATOR_ARGV_1_entity) \
     /**/
 MUTATOR_HOOKABLE(ItemTouch, EV_ItemTouch);
 
@@ -594,6 +617,7 @@ MUTATOR_HOOKABLE(FireBullet_Hit, EV_FireBullet_Hit);
     /**/            o(string, MUTATOR_ARGV_0_string) \
     /** skin */     i(int, MUTATOR_ARGV_1_int) \
     /**/            o(int, MUTATOR_ARGV_1_int) \
+    /** player */   i(entity, MUTATOR_ARGV_2_entity) \
     /**/
 MUTATOR_HOOKABLE(FixPlayermodel, EV_FixPlayermodel);
 
@@ -621,6 +645,7 @@ MUTATOR_HOOKABLE(BuffModel_Customize, EV_BuffModel_Customize);
 #define EV_BuffTouch(i, o) \
     /** buff */    i(entity, MUTATOR_ARGV_0_entity) \
     /** player */  i(entity, MUTATOR_ARGV_1_entity) \
+    /**/           o(entity, MUTATOR_ARGV_1_entity) \
     /**/
 MUTATOR_HOOKABLE(BuffTouch, EV_BuffTouch);
 
@@ -656,27 +681,25 @@ MUTATOR_HOOKABLE(ClientKill, EV_ClientKill);
 MUTATOR_HOOKABLE(FixClientCvars, EV_FixClientCvars);
 
 #define EV_SpectateSet(i, o) \
-    /**/ i(entity, __self) \
-    /**/ i(entity, spec_player) \
-    /**/ o(entity, spec_player) \
+    /** client */    i(entity, MUTATOR_ARGV_0_entity) \
+    /** target */    i(entity, MUTATOR_ARGV_1_entity) \
+    /**/             o(entity, MUTATOR_ARGV_1_entity) \
     /**/
-entity spec_player;
 MUTATOR_HOOKABLE(SpectateSet, EV_SpectateSet);
 
 #define EV_SpectateNext(i, o) \
-    /**/ i(entity, __self) \
-    /**/ i(entity, spec_player) \
-    /**/ o(entity, spec_player) \
+    /** client */    i(entity, MUTATOR_ARGV_0_entity) \
+    /** target */    i(entity, MUTATOR_ARGV_1_entity) \
+    /**/             o(entity, MUTATOR_ARGV_1_entity) \
     /**/
 MUTATOR_HOOKABLE(SpectateNext, EV_SpectateNext);
 
 #define EV_SpectatePrev(i, o) \
-    /**/ i(entity, __self) \
-    /**/ i(entity, spec_player) \
-    /**/ o(entity, spec_player) \
-    /**/ i(entity, spec_first) \
+    /** client */    i(entity, MUTATOR_ARGV_0_entity) \
+    /** target */    i(entity, MUTATOR_ARGV_1_entity) \
+    /**/             o(entity, MUTATOR_ARGV_1_entity) \
+       /** first */     i(entity, MUTATOR_ARGV_2_entity) \
     /**/
-entity spec_first;
 MUTATOR_HOOKABLE(SpectatePrev, EV_SpectatePrev);
 
 enum {
@@ -687,17 +710,15 @@ enum {
 
 /** called when player triggered kill (or is changing teams), return error to not do anything */
 #define EV_Bot_FixCount(i, o) \
-    /**/ i(int, bot_activerealplayers) \
-    /**/ o(int, bot_activerealplayers) \
-    /**/ i(int, bot_realplayers) \
-    /**/ o(int, bot_realplayers) \
+       /** active real players */  i(int, MUTATOR_ARGV_0_int) \
+       /**/                                            o(int, MUTATOR_ARGV_0_int) \
+    /** real players */                i(int, MUTATOR_ARGV_1_int) \
+    /**/                                       o(int, MUTATOR_ARGV_1_int) \
     /**/
-int bot_activerealplayers;
-int bot_realplayers;
 MUTATOR_HOOKABLE(Bot_FixCount, EV_Bot_FixCount);
 
 #define EV_ClientCommand_Spectate(i, o) \
-    /**/ i(entity, __self) \
+    /** player */ i(entity, MUTATOR_ARGV_0_entity) \
     /**/
 MUTATOR_HOOKABLE(ClientCommand_Spectate, EV_ClientCommand_Spectate);
 
@@ -727,7 +748,7 @@ MUTATOR_HOOKABLE(CheckRules_World, EV_CheckRules_World);
 MUTATOR_HOOKABLE(WantWeapon, EV_WantWeapon);
 
 #define EV_AddPlayerScore(i, o) \
-    /** score field */  i(int, MUTATOR_ARGV_0_int) \
+    /** score field */  i(PlayerScoreField, MUTATOR_ARGV_0_entity) \
     /** score */        i(float, MUTATOR_ARGV_1_float) \
     /**/                o(float, MUTATOR_ARGV_1_float) \
     /** player */       i(entity, MUTATOR_ARGV_2_entity) \
@@ -762,16 +783,13 @@ MUTATOR_HOOKABLE(AllowMobButcher, EV_AllowMobButcher);
 MUTATOR_HOOKABLE(ReadLevelCvars, EV_NO_ARGS);
 
 #define EV_SendWaypoint(i, o) \
-    /**/ i(entity, __self) \
-    /**/ i(entity, wp_sendto) \
-    /**/ i(int, wp_sendflags) \
-    /**/ o(int, wp_sendflags) \
-    /**/ i(int, wp_flag) \
-    /**/ o(int, wp_flag) \
-    /**/
-entity wp_sendto;
-int wp_sendflags;
-int wp_flag;
+       /** waypoint */     i(entity, MUTATOR_ARGV_0_entity) \
+       /** to */               i(entity, MUTATOR_ARGV_1_entity) \
+       /** send flags */   i(int, MUTATOR_ARGV_2_int) \
+       /**/                            o(int, MUTATOR_ARGV_2_int) \
+       /** wp flag */      i(int, MUTATOR_ARGV_3_int) \
+       /**/                            o(int, MUTATOR_ARGV_3_int) \
+    /**/
 MUTATOR_HOOKABLE(SendWaypoint, EV_SendWaypoint);
 
 #define EV_TurretValidateTarget(i, o) \
@@ -783,7 +801,7 @@ MUTATOR_HOOKABLE(SendWaypoint, EV_SendWaypoint);
 MUTATOR_HOOKABLE(TurretValidateTarget, EV_TurretValidateTarget);
 
 #define EV_TurretThink(i, o) \
-    /**/ i(entity, __self) \
+    /** turret */ i(entity, MUTATOR_ARGV_0_entity) \
     /**/
 MUTATOR_HOOKABLE(TurretThink, EV_TurretThink);
 
@@ -792,37 +810,30 @@ MUTATOR_HOOKABLE(Ent_Init, EV_NO_ARGS);
 /** */
 #define EV_PrepareExplosionByDamage(i, o) \
     /** projectile */ i(entity, MUTATOR_ARGV_0_entity) \
-    /** attacker */ i(entity, MUTATOR_ARGV_1_entity) \
+    /** attacker */   i(entity, MUTATOR_ARGV_1_entity) \
     /**/
 MUTATOR_HOOKABLE(PrepareExplosionByDamage, EV_PrepareExplosionByDamage);
 
 /** called when a monster model is about to be set, allows custom paths etc. */
 #define EV_MonsterModel(i, o) \
-    /**/ i(string, monster_model) \
-    /**/ i(string, monster_model_output) \
-    /**/ o(string, monster_model_output) \
+       /** model */  i(string, MUTATOR_ARGV_0_string) \
+       /** output */ i(string, MUTATOR_ARGV_1_string) \
+       /**/              o(string, MUTATOR_ARGV_1_string) \
     /**/
-string monster_model;
-string monster_model_output;
 MUTATOR_HOOKABLE(MonsterModel, EV_MonsterModel);
 
 /**/
 #define EV_Player_ChangeTeam(i, o) \
-    /**/ i(entity, __self) \
-    /**/ i(float, pct_curteam) \
-    /**/ i(float, pct_newteam) \
+    /** player */         i(entity, MUTATOR_ARGV_0_entity) \
+       /** current team */   i(float, MUTATOR_ARGV_1_float) \
+       /** new team */       i(float, MUTATOR_ARGV_2_float) \
     /**/
-float pct_curteam;
-float pct_newteam;
 MUTATOR_HOOKABLE(Player_ChangeTeam, EV_Player_ChangeTeam);
 
 /**/
 #define EV_URI_GetCallback(i, o) \
-    /**/ i(float, uricb_id) \
-    /**/ i(float, uricb_status) \
-    /**/ i(string, uricb_data) \
+       /** id */       i(float, MUTATOR_ARGV_0_float) \
+       /** status */   i(float, MUTATOR_ARGV_1_float) \
+       /** data */     i(string, MUTATOR_ARGV_2_string) \
     /**/
-float uricb_id;
-float uricb_status;
-string uricb_data;
 MUTATOR_HOOKABLE(URI_GetCallback, EV_URI_GetCallback);