diff options
Diffstat (limited to 'docs/module-doc/classModule.html')
| -rw-r--r-- | docs/module-doc/classModule.html | 160 |
1 files changed, 142 insertions, 18 deletions
diff --git a/docs/module-doc/classModule.html b/docs/module-doc/classModule.html index a055fef1e..5e85deac7 100644 --- a/docs/module-doc/classModule.html +++ b/docs/module-doc/classModule.html @@ -46,8 +46,14 @@ Inheritance diagram for Module:<p><center><img src="classModule__inherit__graph. <tr><td> </td><td><font size=-1><em>Called when a raw command is transmitted or received.</em> <a href="#a10"></a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>virtual bool </td><td valign=bottom><a class="el" href="classModule.html#a11">OnExtendedMode</a> (<a class="el" href="classuserrec.html">userrec</a> *user, void *target, char modechar, int type, bool mode_on, <a class="el" href="modules_8h.html#a11">string_list</a> &params)</td></tr> <tr><td> </td><td><font size=-1><em>Called whenever an extended mode is to be processed.</em> <a href="#a11"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual int </td><td valign=bottom><a class="el" href="classModule.html#a12">Module::OnUserPreJoin</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="classchanrec.html">chanrec</a> *chan, char *cname)</td></tr> +<tr><td nowrap align=right valign=top>virtual int </td><td valign=bottom><a class="el" href="classModule.html#a12">OnUserPreJoin</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="classchanrec.html">chanrec</a> *chan, const char *cname)</td></tr> <tr><td> </td><td><font size=-1><em>Called whenever a user is about to join a channel, before any processing is done.</em> <a href="#a12"></a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classModule.html#a13">OnOper</a> (<a class="el" href="classuserrec.html">userrec</a> *user)</td></tr> +<tr><td> </td><td><font size=-1><em>Called whenever a user opers locally.</em> <a href="#a13"></a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classModule.html#a14">OnInfo</a> (<a class="el" href="classuserrec.html">userrec</a> *user)</td></tr> +<tr><td> </td><td><font size=-1><em>Called whenever a user types /INFO.</em> <a href="#a14"></a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classModule.html#a15">Module::OnWhois</a> (<a class="el" href="classuserrec.html">userrec</a> *source, <a class="el" href="classuserrec.html">userrec</a> *dest)</td></tr> +<tr><td> </td><td><font size=-1><em>Called whenever a /WHOIS is performed on a local user.</em> <a href="#a15"></a><em></em></font><br><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> Base class for all InspIRCd modules This class is the base class for InspIRCd modules. @@ -163,33 +169,27 @@ Definition at line <a class="el" href="modules_8cpp-source.html#l00119">119</a> </pre></div> </td> </tr> </table> -<a name="a12" doxytag="Module::Module::OnUserPreJoin"></a><p> +<a name="a15" doxytag="Module::Module::OnWhois"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> - <td class="md" nowrap valign="top"> virtual int Module::Module::OnUserPreJoin </td> + <td class="md" nowrap valign="top"> void Module::Module::OnWhois </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> * </td> - <td class="mdname" nowrap> <em>user</em>, </td> - </tr> - <tr> - <td></td> - <td></td> - <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> * </td> - <td class="mdname" nowrap> <em>chan</em>, </td> + <td class="mdname" nowrap> <em>source</em>, </td> </tr> <tr> <td></td> <td></td> - <td class="md" nowrap>char * </td> - <td class="mdname" nowrap> <em>cname</em></td> + <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> * </td> + <td class="mdname" nowrap> <em>dest</em></td> </tr> <tr> <td></td> <td class="md">) </td> - <td class="md" colspan="2"><code> [virtual]</code></td> + <td class="md" colspan="2"></td> </tr> </table> @@ -204,11 +204,9 @@ Definition at line <a class="el" href="modules_8cpp-source.html#l00119">119</a> <td> <p> -Called whenever a user is about to join a channel, before any processing is done. +Called whenever a /WHOIS is performed on a local user. <p> -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 mimic +b, +k, +l etc.<p> -IMPORTANT NOTE!<p> -If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel record is created. This will cause chanrec* chan to be NULL. There is very little you can do in form of processing on the actual channel record at this point, however the channel NAME will still be passed in char* cname, so that you could for example implement a channel blacklist or whitelist, etc. </td> +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. </td> </tr> </table> <a name="a11" doxytag="Module::OnExtendedMode"></a><p> @@ -280,6 +278,79 @@ Definition at line <a class="el" href="modules_8cpp-source.html#l00118">118</a> </pre></div> </td> </tr> </table> +<a name="a14" doxytag="Module::OnInfo"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void Module::OnInfo </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> * </td> + <td class="mdname1" valign="top" nowrap> <em>user</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Called whenever a user types /INFO. +<p> +The userrec will contain the information of the user who typed the command. Modules may use this method to output their own credits in /INFO (which is the ircd's version of an about box). It is purposefully not possible to modify any info that has already been output, or halt the list. You must write a 371 numeric to the user, containing your info in the following format:<p> +:information here +<p> +Definition at line <a class="el" href="modules_8cpp-source.html#l00121">121</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +<div class="fragment"><pre>00121 { }; +</pre></div> </td> + </tr> +</table> +<a name="a13" doxytag="Module::OnOper"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void Module::OnOper </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> * </td> + <td class="mdname1" valign="top" nowrap> <em>user</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Called whenever a user opers locally. +<p> +The userrec will contain the oper mode 'o' as this function is called after any modifications are made to the user's structure by the core. +<p> +Definition at line <a class="el" href="modules_8cpp-source.html#l00120">120</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +<div class="fragment"><pre>00120 { }; +</pre></div> </td> + </tr> +</table> <a name="a8" doxytag="Module::OnPacketReceive"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> @@ -558,6 +629,59 @@ Definition at line <a class="el" href="modules_8cpp-source.html#l00112">112</a> </pre></div> </td> </tr> </table> +<a name="a12" doxytag="Module::OnUserPreJoin"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> int Module::OnUserPreJoin </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> * </td> + <td class="mdname" nowrap> <em>user</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> * </td> + <td class="mdname" nowrap> <em>chan</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>cname</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Called whenever a user is about to join a channel, before any processing is done. +<p> +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 mimic +b, +k, +l etc.<p> +IMPORTANT NOTE!<p> +If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel record is created. This will cause chanrec* chan to be NULL. There is very little you can do in form of processing on the actual channel record at this point, however the channel NAME will still be passed in char* cname, so that you could for example implement a channel blacklist or whitelist, etc. +<p> +Definition at line <a class="el" href="modules_8cpp-source.html#l00117">117</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +<div class="fragment"><pre>00117 { <span class="keywordflow">return</span> 0; } +</pre></div> </td> + </tr> +</table> <a name="a4" doxytag="Module::OnUserQuit"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> @@ -596,7 +720,7 @@ Definition at line <a class="el" href="modules_8cpp-source.html#l00110">110</a> </table> <hr>The documentation for this class was generated from the following files:<ul> <li><a class="el" href="modules_8h-source.html">modules.h</a><li><a class="el" href="modules_8cpp-source.html">modules.cpp</a></ul> -<hr><address style="align: right;"><small>Generated on Mon Apr 5 02:04:07 2004 for InspIRCd by +<hr><address style="align: right;"><small>Generated on Tue Apr 6 11:42:45 2004 for InspIRCd by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border=0 width=110 height=53></a>1.3-rc3 </small></address> |