Document creation of mutator hooks

diff --git a/qcsrc/client/mutators/events.qh b/qcsrc/client/mutators/events.qh
index 24d634ce8213e05759f7afed13f2f0b011be5146..5edb84ae0ee7fc42245871e32c1752d02939493b 100644 (file)
--- a/qcsrc/client/mutators/events.qh
+++ b/qcsrc/client/mutators/events.qh
@@ -2,6 +2,11 @@
 
 #include <common/mutators/base.qh>
 
+// register all possible hooks here
+ 
+// to use a hook, first register your mutator using REGISTER_MUTATOR
+// then create your function using MUTATOR_HOOKFUNCTION
+
 /**
  * Called when a client command is parsed
  * NOTE: hooks MUST start with if (MUTATOR_RETURNVALUE) return false;

diff --git a/qcsrc/menu/mutators/events.qh b/qcsrc/menu/mutators/events.qh
index 1df38f5af09c571df07e280b3c9691ec192f837b..0c5056b974673ce76b32958be25a4cb5e319611f 100644 (file)
--- a/qcsrc/menu/mutators/events.qh
+++ b/qcsrc/menu/mutators/events.qh
@@ -2,6 +2,11 @@
 
 #include <common/mutators/base.qh>
 
+// register all possible hooks here
+ 
+// to use a hook, first register your mutator using REGISTER_MUTATOR
+// then create your function using MUTATOR_HOOKFUNCTION
+
 // globals
 
 string cmd_name;

diff --git a/qcsrc/server/mutators/events.qh b/qcsrc/server/mutators/events.qh
index 6853c04a15641dc69bd6e52f7da39615a41610a4..6cdf94feb41dd7427eed36b493a094768e634656 100644 (file)
--- a/qcsrc/server/mutators/events.qh
+++ b/qcsrc/server/mutators/events.qh
@@ -3,6 +3,9 @@
 #include <common/mutators/base.qh>
 
 // register all possible hooks here
+ 
+// to use a hook, first register your mutator using REGISTER_MUTATOR
+// then create your function using MUTATOR_HOOKFUNCTION
 
 /** called when a player becomes observer, after shared setup */
 #define EV_MakePlayerObserver(i, o) \