summaryrefslogtreecommitdiff
path: root/include/modules.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/modules.h')
-rw-r--r--include/modules.h9
1 files changed, 5 insertions, 4 deletions
diff --git a/include/modules.h b/include/modules.h
index 4af979118..3f779fe80 100644
--- a/include/modules.h
+++ b/include/modules.h
@@ -422,7 +422,7 @@ enum Implementation
I_OnUserPostNick, I_OnAccessCheck, I_On005Numeric, I_OnKill, I_OnRemoteKill, I_OnLoadModule,
I_OnUnloadModule, I_OnBackgroundTimer, I_OnPreCommand, I_OnCheckReady, I_OnCheckInvite,
I_OnRawMode, I_OnCheckKey, I_OnCheckLimit, I_OnCheckBan, I_OnCheckExtBan, I_OnCheckStringExtBan,
- I_OnStats, I_OnChangeLocalUserHost, I_OnChangeLocalUserGecos, I_OnLocalTopicChange,
+ I_OnStats, I_OnChangeLocalUserHost, I_OnChangeLocalUserGecos, I_OnPreTopicChange,
I_OnPostTopicChange, I_OnEvent, I_OnRequest, I_OnGlobalOper, I_OnPostConnect, I_OnAddBan,
I_OnDelBan, I_OnRawSocketAccept, I_OnRawSocketClose, I_OnRawSocketWrite, I_OnRawSocketRead,
I_OnChangeLocalUserGECOS, I_OnUserRegister, I_OnChannelPreDelete, I_OnChannelDelete,
@@ -1210,17 +1210,18 @@ class CoreExport Module : public Extensible
*/
virtual ModResult OnChangeLocalUserGECOS(User* user, const std::string &newhost);
- /** Called whenever a topic is changed by a local user.
+ /** Called before a topic is changed.
* Return 1 to deny the topic change, 0 to check details on the change, -1 to let it through with no checks
+ * As with other 'pre' events, you should only ever block a local event.
* @param user The user changing the topic
* @param chan The channels who's topic is being changed
* @param topic The actual topic text
* @param 1 to block the topic change, 0 to allow
*/
- virtual ModResult OnLocalTopicChange(User* user, Channel* chan, const std::string &topic);
+ virtual ModResult OnPreTopicChange(User* user, Channel* chan, const std::string &topic);
/** Called whenever a topic has been changed.
- * To block topic changes you must use OnLocalTopicChange instead.
+ * To block topic changes you must use OnPreTopicChange instead.
* @param user The user changing the topic
* @param chan The channels who's topic is being changed
* @param topic The actual topic text