From 59a2c6c2d96a4557cd885fefcbce97f490962692 Mon Sep 17 00:00:00 2001 From: brain Date: Tue, 6 Apr 2004 20:16:43 +0000 Subject: Updated docs git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@411 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classModule.html | 207 +++++++++++++++++++++++++++++++-------- 1 file changed, 165 insertions(+), 42 deletions(-) (limited to 'docs/module-doc/classModule.html') diff --git a/docs/module-doc/classModule.html b/docs/module-doc/classModule.html index 5e85deac7..8520f7bbc 100644 --- a/docs/module-doc/classModule.html +++ b/docs/module-doc/classModule.html @@ -52,8 +52,12 @@ Inheritance diagram for Module:



virtual void OnInfo (userrec *user)  Called whenever a user types /INFO.

-void Module::OnWhois (userrec *source, userrec *dest) +virtual void OnWhois (userrec *source, userrec *dest)  Called whenever a /WHOIS is performed on a local user.

+virtual int OnUserPreMessage (userrec *user, void *dest, int target_type, std::string text) + Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.

+virtual int OnUserPreNotice (userrec *user, void *dest, int target_type, std::string text) + Called whenever a user is about to NOTICE A user or a channel, before any processing is done.

Detailed Description

Base class for all InspIRCd modules This class is the base class for InspIRCd modules. @@ -169,46 +173,6 @@ Definition at line 119 -

- - - - -
- - - - - - - - - - - - - - - - - - - -
void Module::Module::OnWhois ( userrec *   source,
userrec *   dest
) 
-
- - - - - -
-   - - -

-Called whenever a /WHOIS is performed on a local user. -

-The source parameter contains the details of the user who issued the WHOIS command, and the dest parameter contains the information of the user they are whoising.

@@ -682,6 +646,120 @@ Definition at line 117
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
int Module::OnUserPreMessage ( userrec *   user,
void *   dest,
int   target_type,
std::string   text
)  [virtual]
+
+ + + + + +
+   + + +

+Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done. +

+Returning any nonzero value from this function stops the process immediately, causing no output to be sent to the user by the core. If you do this you must produce your own numerics, notices etc. This is useful for modules which may want to filter or redirect messages. target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user, you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details of where the message is destined to be sent. +

+Definition at line 123 of file modules.cpp. +

+

00123 { return 0; };
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
int Module::OnUserPreNotice ( userrec *   user,
void *   dest,
int   target_type,
std::string   text
)  [virtual]
+
+ + + + + +
+   + + +

+Called whenever a user is about to NOTICE A user or a channel, before any processing is done. +

+Returning any nonzero value from this function stops the process immediately, causing no output to be sent to the user by the core. If you do this you must produce your own numerics, notices etc. This is useful for modules which may want to filter or redirect messages. target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user, you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details of where the message is destined to be sent. +

+Definition at line 124 of file modules.cpp. +

+

00124 { return 0; };
+

@@ -718,9 +796,54 @@ Definition at line 110
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
void Module::OnWhois ( userrec *   source,
userrec *   dest
)  [virtual]
+
+ + + + + +
+   + + +

+Called whenever a /WHOIS is performed on a local user. +

+The source parameter contains the details of the user who issued the WHOIS command, and the dest parameter contains the information of the user they are whoising. +

+Definition at line 122 of file modules.cpp. +

+

00122 { };
+

The documentation for this class was generated from the following files: -
Generated on Tue Apr 6 11:42:45 2004 for InspIRCd by +
Generated on Tue Apr 6 21:14:07 2004 for InspIRCd by doxygen1.3-rc3
-- cgit v1.2.3