diff options
Diffstat (limited to 'docs/man/man3/Module.3')
| -rw-r--r-- | docs/man/man3/Module.3 | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/man/man3/Module.3 b/docs/man/man3/Module.3 index 326d33cec..08fddea6c 100644 --- a/docs/man/man3/Module.3 +++ b/docs/man/man3/Module.3 @@ -127,6 +127,10 @@ Inherits \fBclassbase\fP. .RI "virtual void \fBOnBackgroundTimer\fP (time_t curtime)" .br .RI "\fICalled once every five seconds for background processing. \fP" +.ti -1c +.RI "virtual void \fBOnSendList\fP (\fBuserrec\fP *user, \fBchanrec\fP *channel, char mode)" +.br +.RI "\fICalled whenever a list is needed for a listmode. \fP" .in -1c .SH "Detailed Description" .PP @@ -276,6 +280,13 @@ Called on rehash. This method is called prior to a /REHASH or when a SIGHUP is r .nf 314 { } .fi +.SS "void Module::OnSendList (\fBuserrec\fP * user, \fBchanrec\fP * channel, char mode)\fC [virtual]\fP" +.PP +Called whenever a list is needed for a listmode. For example, when a /MODE #channel +b (without any other parameters) is called, if a module was handling +b this function would be called. The function can then output any lists it wishes to. Please note that all modules will see all mode characters to provide the ability to extend each other, so please only output a list if the mode character given matches the one(s) you want to handle.Definition at line 334 of file modules.cpp. +.PP +.nf +334 { }; +.fi .SS "void Module::OnServerRaw (std::string & raw, bool inbound, \fBuserrec\fP * user)\fC [virtual]\fP" .PP Called when a raw command is transmitted or received. This method is the lowest level of handler available to a module. It will be called with raw data which is passing through a connected socket. If you wish, you may munge this data by changing the string parameter 'raw'. If you do this, after your function exits it will immediately be cut down to 510 characters plus a carriage return and linefeed. For INBOUND messages only (where inbound is set to true) the value of user will be the userrec of the connection sending the data. This is not possible for outbound data because the data may be being routed to multiple targets.Definition at line 315 of file modules.cpp. |