From 5a2675d174e661c55843b3795afe2d688e7197f9 Mon Sep 17 00:00:00 2001 From: brain Date: Tue, 26 Apr 2005 17:15:49 +0000 Subject: New documentation! git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@1199 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classModule.html | 130 ++++++++++++++++++++++++++++++++++++++- 1 file changed, 128 insertions(+), 2 deletions(-) (limited to 'docs/module-doc/classModule.html') diff --git a/docs/module-doc/classModule.html b/docs/module-doc/classModule.html index 6062b0714..c587dcc90 100644 --- a/docs/module-doc/classModule.html +++ b/docs/module-doc/classModule.html @@ -156,6 +156,15 @@ Inherits classbase. virtual char * OnRequest (Request *request)  Called whenever a Request class is sent to your module by another module.

+virtual int OnOperCompare (std::string password, std::string input) + + Called whenever an oper password is to be compared to what a user has input.

+virtual void OnGlobalOper (userrec *user) + + Called whenever a user is given usermode +o, anywhere on the network.

+virtual void OnGlobalConnect (userrec *user) + + Called whenever a user connects, anywhere on the network.

Detailed Description

Base class for all InspIRCd modules This class is the base class for InspIRCd modules. @@ -164,7 +173,7 @@ All modules must inherit from this class, its methods will be called when irc se

-Definition at line 233 of file modules.h.

Constructor & Destructor Documentation

+Definition at line 236 of file modules.h.

Constructor & Destructor Documentation

@@ -871,6 +880,78 @@ Definition at line 373
+

+ + + + +
+ + + + + + + + + + +
void Module::OnGlobalConnect ( userrec *  user  )  [virtual]
+
+ + + + + +
+   + + +

+Called whenever a user connects, anywhere on the network. +

+This event is informational only. You should not change any user information in this event. To do so, use the OnUserConnect method to change the state of local users. +

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

+

00410 { };
+
+

+ + + + +
+ + + + + + + + + + +
void Module::OnGlobalOper ( userrec *  user  )  [virtual]
+
+ + + + + +
+   + + +

+Called whenever a user is given usermode +o, anywhere on the network. +

+You cannot override this and prevent it from happening as it is already happened and such a task must be performed by another server. You can however bounce modes by sending servermodes out to reverse mode changes. +

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

+

00409 { };
+

@@ -1166,6 +1247,51 @@ Definition at line 375
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
int Module::OnOperCompare ( std::string  password,
std::string  input
)  [virtual]
+
+ + + + + +
+   + + +

+Called whenever an oper password is to be compared to what a user has input. +

+The password field (from the config file) is in 'password' and is to be compared against 'input'. This method allows for encryption of oper passwords and much more besides. You should return a nonzero value if you want to allow the comparison or zero if you wish to do nothing. +

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

+

00408 { return 0; };
+

@@ -2334,7 +2460,7 @@ Definition at line 377

The documentation for this class was generated from the following files: -
Generated on Wed Apr 20 15:47:06 2005 for InspIRCd by +
Generated on Tue Apr 26 17:11:49 2005 for InspIRCd by doxygen 1.3.3
-- cgit v1.3.1-10-gc9f91