Awwu at 18:18, 13 August 2009

2009-08-13T18:18:04Z

← Older revision		Revision as of 18:18, 13 August 2009
Line 1:		Line 1:
	{{ml_birc}}		{{ml_birc}}
	__NOTOC__		__NOTOC__
	This function can be used to ~~list out all the users~~ a ~~specified~~ channel. Note that a delay of 2-3 seconds should be used before calling this function inside callback {{ml_birc\|event_ircOnJoinChannel}}.		This function can be used to join a channel. Note that a delay of 2-3 seconds should be used before calling this function inside callback {{ml_birc\|event_ircOnJoinChannel}}.

	==Syntax==		==Syntax==

Awwu: Created page with '{{ml_birc}} NOTOC This function can be used to list out all the users a specified channel. Note that a delay of 2-3 seconds should be used before calling this function inside…'

2009-08-13T18:13:45Z

Created page with '{{ml_birc}} __NOTOC__ This function can be used to list out all the users a specified channel. Note that a delay of 2-3 seconds should be used before calling this function inside…'

New page

{{ml_birc}}
__NOTOC__
This function can be used to list out all the users a specified channel. Note that a delay of 2-3 seconds should be used before calling this function inside callback {{ml_birc|event_ircOnJoinChannel}}.

==Syntax==
<syntaxhighlight lang="lua">
bool ircJoinChannel ( ircbot theBot, string channel, [ string key = "" ] )
</syntaxhighlight>

===Required Arguments===
*'''theBot:''' The ircbot which is going to join the channel
*'''channel:''' The channel which the ircbot will connect to

===Optional Arguments===
{{OptionalArg}}
*'''key:''' The key (password) for the channel. Needs to be specified for channels which have key set

===Returns===
Returns ''true'' if passed arguments were valid, ''false'' otherwise.<br>
'''Note:''' Does not return ''true'' if ircbot successfully joined or ''false'' if the bot failed to join the channel. You can check if the bot joined the channel by using callback {{ml_birc|event_ircOnJoinChannel}}.

==Example==
This example creates an ircbot called ''DummyBot'' makes it connect to a server and join a channel called ''#testchannel'' after it has connected.
<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
</syntaxhighlight>

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

Modules/bIRC/ircJoinChannel - Revision history

Awwu at 18:18, 13 August 2009

Awwu: Created page with '{{ml_birc}} __NOTOC__ This function can be used to list out all the users a specified channel. Note that a delay of 2-3 seconds should be used before calling this function inside…'

Awwu: Created page with '{{ml_birc}} NOTOC This function can be used to list out all the users a specified channel. Note that a delay of 2-3 seconds should be used before calling this function inside…'