inspircd

A modular C++ IRC daemon (ircd). https://www.inspircd.org/
Log | Files | Refs | README

commit 785f3a28666ac2d78c3315f7c9efa6b7fd06a37e
parent 88d5659922bd71843803d3ce087023cb7aacc028
Author: Peter Powell <petpow@saberuk.com>
Date:   Thu,  7 Feb 2019 11:56:53 +0000

Document OnUserWrite.

Diffstat:
Minclude/modules.h | 6++++++
1 file changed, 6 insertions(+), 0 deletions(-)

diff --git a/include/modules.h b/include/modules.h @@ -926,6 +926,12 @@ class CoreExport Module : public classbase, public usecountbase */ virtual void OnServiceDel(ServiceProvider& service); + /** Called whenever a message is about to be written to a user. + * @param user The user who is having a message sent to them. + * @param msg The message which is being written to the user. + * @return MOD_RES_ALLOW to explicitly allow the message to be sent, MOD_RES_DENY to explicitly + * deny the message from being sent, or MOD_RES_PASSTHRU to let another module handle the event. + */ virtual ModResult OnUserWrite(LocalUser* user, ClientProtocol::Message& msg); };