Awwu at 19:44, 14 August 2009

2009-08-14T19:44:27Z

← Older revision		Revision as of 19:44, 14 August 2009
Line 1:		Line 1:
	{{ml_birc}}		{{ml_birc}}
	__NOTOC__		__NOTOC__
	This function can be used to set a channel mode the specified channel. The specified {{ml_birc\|ircbot}} ~~has to be in that channel and~~ often it needs to have suitable privileges.		This function can be used to set a channel mode the specified channel. The specified {{ml_birc\|ircbot}} often needs to have suitable privileges in order for the change to have an effect.

	==Syntax==		==Syntax==

Awwu at 19:19, 14 August 2009

2009-08-14T19:19:58Z

← Older revision		Revision as of 19:19, 14 August 2009
Line 5:		Line 5:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~string~~ ircSetChannelMode ( ircbot theBot, string channel, string mode )		bool ircSetChannelMode ( ircbot theBot, string channel, string mode )
	</syntaxhighlight>		</syntaxhighlight>

Awwu: Created page with '{{ml_birc}} NOTOC This function can be used to set a channel mode the specified channel. The specified {{ml_birc|ircbot}} has to be in that channel and often it needs to have…'

2009-08-14T19:18:55Z

Created page with '{{ml_birc}} __NOTOC__ This function can be used to set a channel mode the specified channel. The specified {{ml_birc|ircbot}} has to be in that channel and often it needs to have…'

New page

{{ml_birc}}
__NOTOC__
This function can be used to set a channel mode the specified channel. The specified {{ml_birc|ircbot}} has to be in that channel and often it needs to have suitable privileges.

==Syntax==
<syntaxhighlight lang="lua">
string ircSetChannelMode ( ircbot theBot, string channel, string mode )
</syntaxhighlight>

===Required Arguments===
*'''theBot:''' The ircbot which is in the channel
*'''channel:''' The name of the channel on which you want to set a channel mode
*'''mode:''' The channel mode string

===Returns===
Returns ''true''.<br>
'''Note:''' Does not return ''true'' if a channel mode was successfully set or ''false'' if it wasn't set. You can check if the channel mode was set by using callback {{ml_birc|event_ircOnChannelMode}}.

==Example==
This example creates an ircbot called ''DummyBot'' makes it connect to a server and join a channel. It also includes an IRC command '!limitusers' which can used to change the channel's maximum user limit.
<syntaxhighlight lang="lua">
function resourceStart ( )
theBot = ircCreateBot ( "DummyBot" )
ircConnect ( theBot, "irc.gtanet.com", 6667 )
end
addEventHandler ( "onResourceStart", getResourceRootElement ( getThisResource() ), resourceStart )

function event_ircOnConnect ( theBot )
setTimer ( ircJoinChannel, 2000, 1, theBot, "#testchannel" )
end

function event_ircOnText ( theBot, channel, sender, message )
if message:find( "!limitusers" ) then
local params = split ( message, string.byte (' ') )
-- params[1] has the string "!limitusers" which we don't need
-- params[2] has the user count
if tonumber( params[2] ) then -- check if it's a number, but don't convert it to a number
ircSetChannelMode ( theBot, channel, "+l " .. params[2] )
elseif params[2] == "off" then -- if user passes 'off' as the number, remove the limit
ircSetChannelMode ( theBot, channel, "-l" )
end
end
end
</syntaxhighlight>

==See Also==
{{ml_birc functions}}

Modules/bIRC/ircSetChannelMode - Revision history

Awwu at 19:44, 14 August 2009

Awwu at 19:19, 14 August 2009

Awwu: Created page with '{{ml_birc}} __NOTOC__ This function can be used to set a channel mode the specified channel. The specified {{ml_birc|ircbot}} has to be in that channel and often it needs to have…'

Awwu: Created page with '{{ml_birc}} NOTOC This function can be used to set a channel mode the specified channel. The specified {{ml_birc|ircbot}} has to be in that channel and often it needs to have…'