https://wiki.multitheftauto.com/wiki/Modules/bIRC/ircBan?action=history&feed=atom 2026-05-15T07:17:27Z Revision history for this page on the wiki MediaWiki 1.39.3 https://wiki.multitheftauto.com/index.php?title=Modules/bIRC/ircBan&diff=21099&oldid=prev 2009-08-15T16:23:50Z

<p>Created page with &#039;{{ml_birc}} __NOTOC__ This function can be used to ban-kick user from the specified channel. The specified {{ml_birc|ircbot}} often needs to have suitable privileges in order for…&#039;</p> <p><b>New page</b></p><div>{{ml_birc}}<br /> __NOTOC__<br /> This function can be used to ban-kick user from the specified channel. The specified {{ml_birc|ircbot}} often needs to have suitable privileges in order for this to work.<br /> <br /> ==Syntax== <br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> bool ircBan ( ircbot theBot, string channel, string user, [ int formatType = 2, string reason = &quot;&quot; ] )<br /> &lt;/syntaxhighlight&gt; <br /> <br /> ===Required Arguments=== <br /> *'''theBot:''' The ircbot which is going to do the banning<br /> *'''channel:''' The channel where user should be banned from<br /> *'''user:''' The user who should be banned<br /> <br /> ===Optional Arguments===<br /> {{OptionalArg}}<br /> *'''formatType:''' The ban mask type which should be used for banning. A list can be found in {{ml_birc|ircFormatHost}} function<br /> *'''reason:''' The reason for the ban<br /> <br /> ===Returns===<br /> Returns ''true'' if passed arguments were valid, ''false'' otherwise.&lt;br&gt;<br /> '''Note:''' Does not return ''true'' if the user was successfully banned or ''false'' if it failed. You can check if the user was kicked by using callback {{ml_birc|event_ircOnKick}} and if the a channel mode was set by using callback {{ml_birc|event_ircOnChannelMode}}.<br /> <br /> ==Example==<br /> This example creates an ircbot called ''DummyBot'', makes it connect to a server and join a channel. It also includes an IRC command '!ban' which can be used to ban users from the channel.<br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> function resourceStart ( )<br /> theBot = ircCreateBot ( &quot;DummyBot&quot; )<br /> ircConnect ( theBot, &quot;irc.gtanet.com&quot;, 6667 )<br /> end<br /> addEventHandler ( &quot;onResourceStart&quot;, getResourceRootElement ( getThisResource() ), resourceStart )<br /> <br /> function event_ircOnConnect ( theBot )<br /> setTimer ( ircJoinChannel, 2000, 1, theBot, &quot;#testchannel&quot; )<br /> end<br /> <br /> function event_ircOnText ( theBot, channel, sender, message )<br /> if message:find( &quot;!ban&quot; ) then<br /> local params = split ( message, string.byte (' ') )<br /> -- params[1] has the string &quot;!ban&quot; which we don't need<br /> -- params[2] has the user name<br /> if ircIsInChannel ( theBot, channel, params[2] ) then<br /> ircBan ( theBot, channel, params[2] )<br /> end<br /> end<br /> end<br /> &lt;/syntaxhighlight&gt;<br /> <br /> ==See Also==<br /> {{ml_birc functions}}</div>

Awwu