summaryrefslogtreecommitdiff
path: root/include/modules.h
diff options
context:
space:
mode:
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
*/