Document Weapon Accuracy stats

diff --git a/qcsrc/server/weapons/accuracy.qh b/qcsrc/server/weapons/accuracy.qh
index 6005813fee1710ef05f9dd72354f2c7c2a4bcc2b..fcdf7c481ae3a185f2c81067be1cbd3c6560c606 100644 (file)
--- a/qcsrc/server/weapons/accuracy.qh
+++ b/qcsrc/server/weapons/accuracy.qh
@@ -3,6 +3,21 @@
 #include <common/weapons/_all.qh>
 #include <common/stats.qh>
 
+/**
+ * Weapon Accuracy stats
+ *
+ * These stats are sent to all the clients to be displayed on the scoreboard
+ * and also to Xonstats.
+ *
+ * Note that weapon damage is counted differently from player damage:
+ *  - it isn't limited by target's health in case you kill them
+ *  - it ignores handicap, shield, strength and similar powerups / buffs
+ *  - it doesn't count more than a single full hit if you hit multiple targets
+ *    with a single shot in order to never assign more than 100% accuracy per hit
+ *  - obviously damage caused by fall, lava, trigger_hurt and telefrags isn't
+ *    counted as weapon damage in any way
+ */
+
 float autocvar_sv_accuracy_data_share = 1;
 
 .bool cvar_cl_accuracy_data_share;