summaryrefslogtreecommitdiff
path: root/include/modules.h
diff options
context:
space:
mode:
authorAdam <Adam@anope.org>2013-06-01 21:51:00 -0400
committerAdam <Adam@anope.org>2013-06-01 21:56:52 -0400
commit9956da18e3186591b5347e63081756390f4f35d5 (patch)
tree61992e9d8b370cec2785db1ea281175359088cc3 /include/modules.h
parentb56e71ab14b020a3a01f1fbd183382083156aaf4 (diff)
Move OnJoinChannel event to trigger after the user has completely joined and document it more about what you should and shouldnt do in it
Diffstat (limited to 'include/modules.h')
-rw-r--r--include/modules.h5
1 files changed, 4 insertions, 1 deletions
diff --git a/include/modules.h b/include/modules.h
index 286ba5246..c430767db 100644
--- a/include/modules.h
+++ b/include/modules.h
@@ -462,7 +462,10 @@ class CoreExport Module : public Extensible
*/
virtual void OnLeaveChannel(User *u, Channel *c) { throw NotImplementedException(); }
- /** Called when a user joins a channel
+ /** Called after a user joins a channel
+ * If this event triggers the user is allowed to be in the channel, and will
+ * not be kicked for restricted/akick/forbidden, etc. If you want to kick the user,
+ * use the CheckKick event instead.
* @param u The user
* @param channel The channel
*/