summaryrefslogtreecommitdiff
path: root/include/modules.h
diff options
context:
space:
mode:
authorbrain <brain@e03df62e-2008-0410-955e-edbf42e46eb7>2006-11-26 18:12:50 +0000
committerbrain <brain@e03df62e-2008-0410-955e-edbf42e46eb7>2006-11-26 18:12:50 +0000
commit0e8a71803850ca62e9c7fd1447714d7548184d95 (patch)
treeb84771831701102c818ccf95fadc961f8ccbace5 /include/modules.h
parent2e52ff280dca14d1598b84fab7a8c2e93fa30910 (diff)
Update comments to reflect new API
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@5807 e03df62e-2008-0410-955e-edbf42e46eb7
Diffstat (limited to 'include/modules.h')
-rw-r--r--include/modules.h4
1 files changed, 4 insertions, 0 deletions
diff --git a/include/modules.h b/include/modules.h
index 57fbc03b6..deb7dcf22 100644
--- a/include/modules.h
+++ b/include/modules.h
@@ -611,6 +611,8 @@ class Module : public Extensible
* @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
* @param text Changeable text being sent by the user
* @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
+ * @param exempt_list A list of users not to send to. For channel messages, this will usually contain just the sender.
+ * It will be ignored for private messages.
* @return 1 to deny the NOTICE, 0 to allow it
*/
virtual int OnUserPreMessage(userrec* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
@@ -630,6 +632,8 @@ class Module : public Extensible
* @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
* @param text Changeable text being sent by the user
* @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
+ * @param exempt_list A list of users not to send to. For channel notices, this will usually contain just the sender.
+ * It will be ignored for private notices.
* @return 1 to deny the NOTICE, 0 to allow it
*/
virtual int OnUserPreNotice(userrec* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);