From 674c868b225f0c2c0a8f7879dbaa322a8c539bec Mon Sep 17 00:00:00 2001 From: brain Date: Fri, 15 Apr 2005 19:31:08 +0000 Subject: New docs for API: int Module::OnRawMode(userrec* user, char mode, std::string param, bool adding, int pcnt); int Module::OnCheckInvite(userrec* user, chanrec* chan); int Module::OnCheckKey(userrec* user, chanrec* chan, std::string keygiven); int Module::OnCheckLimit(userrec* user, chanrec* chan); int Module::OnCheckBan(userrec* user, chanrec* chan); void Module::OnStats(char symbol); int Module::OnChangeLocalUserHost(userrec* user, std::string newhost); int Module::OnChangeLocalUserGECOS(userrec* user, std::string newhost); int Module::OnLocalTopicChange(userrec* user, chanrec* chan, std::string topic); git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@1106 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classModule.html | 455 ++++++++++++++++++++++++++++++++++++++- 1 file changed, 454 insertions(+), 1 deletion(-) (limited to 'docs/module-doc/classModule.html') diff --git a/docs/module-doc/classModule.html b/docs/module-doc/classModule.html index 7a6f4cdf2..84c9555c2 100644 --- a/docs/module-doc/classModule.html +++ b/docs/module-doc/classModule.html @@ -117,6 +117,33 @@ Inherits classbase. virtual void OnUserRegister (userrec *user)  Called whenever a user is about to register their connection (e.g.

+virtual int OnRawMode (userrec *user, char mode, std::string param, bool adding, int pcnt) + + Called whenever a mode character is processed.

+virtual int OnCheckInvite (userrec *user, chanrec *chan) + + Called whenever a user joins a channel, to determine if invite checks should go ahead or not.

+virtual int OnCheckKey (userrec *user, chanrec *chan, std::string keygiven) + + Called whenever a user joins a channel, to determine if key checks should go ahead or not.

+virtual int OnCheckLimit (userrec *user, chanrec *chan) + + Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.

+virtual int OnCheckBan (userrec *user, chanrec *chan) + + Called whenever a user joins a channel, to determine if banlist checks should go ahead or not.

+virtual void OnStats (char symbol) + + Called on all /STATS commands This method is triggered for all /STATS use, including stats symbols handled by the core.

+virtual int OnChangeLocalUserHost (userrec *user, std::string newhost) + + Called whenever a change of a local users displayed host is attempted.

+virtual int OnChangeLocalUserGECOS (userrec *user, std::string newhost) + + Called whenever a change of a local users GECOS (fullname field) is attempted.

+virtual int OnLocalTopicChange (userrec *user, chanrec *chan, std::string topic) + + Called whenever a topic is changed by a local user.

Detailed Description

Base class for all InspIRCd modules This class is the base class for InspIRCd modules. @@ -377,6 +404,96 @@ Definition at line 333 +

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
int Module::OnChangeLocalUserGECOS ( userrec *  user,
std::string  newhost
)  [virtual]
+
+ + + + + +
+   + + +

+Called whenever a change of a local users GECOS (fullname field) is attempted. +

+return 1 to deny the name change, or 0 to allow it. +

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

+

00347 { return 0; };
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
int Module::OnChangeLocalUserHost ( userrec *  user,
std::string  newhost
)  [virtual]
+
+ + + + + +
+   + + +

+Called whenever a change of a local users displayed host is attempted. +

+Return 1 to deny the host change, or 0 to allow it. +

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

+

00346 { return 0; };
+

@@ -415,6 +532,192 @@ References string_list.
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
int Module::OnCheckBan ( userrec *  user,
chanrec *  chan
)  [virtual]
+
+ + + + + +
+   + + +

+Called whenever a user joins a channel, to determine if banlist checks should go ahead or not. +

+This method will always be called for each join, wether or not the user actually matches a channel ban, and determines the outcome of an if statement around the whole section of ban checking code. return 1 to explicitly allow the join to go ahead or 0 to ignore the event. +

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

+

00344 { return 0; };
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
int Module::OnCheckInvite ( userrec *  user,
chanrec *  chan
)  [virtual]
+
+ + + + + +
+   + + +

+Called whenever a user joins a channel, to determine if invite checks should go ahead or not. +

+This method will always be called for each join, wether or not the channel is actually +i, and determines the outcome of an if statement around the whole section of invite checking code. return 1 to explicitly allow the join to go ahead or 0 to ignore the event. +

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

+

00341 { return 0; };
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
int Module::OnCheckKey ( userrec *  user,
chanrec *  chan,
std::string  keygiven
)  [virtual]
+
+ + + + + +
+   + + +

+Called whenever a user joins a channel, to determine if key checks should go ahead or not. +

+This method will always be called for each join, wether or not the channel is actually +k, and determines the outcome of an if statement around the whole section of key checking code. if the user specified no key, the keygiven string will be a valid but empty value. return 1 to explicitly allow the join to go ahead or 0 to ignore the event. +

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

+

00342 { return 0; };
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
int Module::OnCheckLimit ( userrec *  user,
chanrec *  chan
)  [virtual]
+
+ + + + + +
+   + + +

+Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not. +

+This method will always be called for each join, wether or not the channel is actually +l, and determines the outcome of an if statement around the whole section of channel limit checking code. return 1 to explicitly allow the join to go ahead or 0 to ignore the event. +

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

+

00343 { return 0; };
+

@@ -653,6 +956,57 @@ Definition at line 332
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
int Module::OnLocalTopicChange ( userrec *  user,
chanrec *  chan,
std::string  topic
)  [virtual]
+
+ + + + + +
+   + + +

+Called whenever a topic is changed by a local user. +

+Return 1 to deny the topic change, or 0 to allow it. +

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

+

00348 { return 0; };
+

@@ -836,6 +1190,69 @@ Definition at line 335
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
int Module::OnRawMode ( userrec *  user,
char  mode,
std::string  param,
bool  adding,
int  pcnt
)  [virtual]
+
+ + + + + +
+   + + +

+Called whenever a mode character is processed. +

+Return 1 from this function to block the mode character from being processed entirely, so that you may perform your own code instead. Note that this method allows you to override modes defined by other modes, but this is NOT RECOMMENDED! +

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

+

00340 { return 0; };
+

@@ -973,6 +1390,42 @@ Definition at line 315
+

+ + + + +
+ + + + + + + + + + +
void Module::OnStats ( char  symbol  )  [virtual]
+
+ + + + + +
+   + + +

+Called on all /STATS commands This method is triggered for all /STATS use, including stats symbols handled by the core. +

+ +

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

+

00345 { };
+

@@ -1678,7 +2131,7 @@ Definition at line 321

The documentation for this class was generated from the following files: -
Generated on Fri Apr 15 14:50:50 2005 for InspIRCd by +
Generated on Fri Apr 15 19:30:23 2005 for InspIRCd by doxygen 1.3.3
-- cgit v1.3.1-10-gc9f91