Awwu at 09:24, 30 July 2009

2009-07-30T09:24:38Z

← Older revision		Revision as of 09:24, 30 July 2009
Line 16:		Line 16:
	*'''connecting'''		*'''connecting'''
	*'''connected'''		*'''connected'''
			If invalid arguments were passed, it returns ''false''.

	==Example==		==Example==
	This example creates an ircbot called ''DummyBot'' makes it connect to a server. During the connection progress bot's current states are printed out to the server log.		This example creates an ircbot called ''DummyBot'' and makes it connect to a server. During the connection progress bot's current states are printed out to the server log.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function resourceStart ()		function resourceStart ()

Awwu: Created page with '{{ml_birc}} NOTOC This function is used to retrieve the current state of specified {{ml_birc|ircbot}}. ==Syntax== string ircGetBotState ( ircbot theBot )
2009-07-30T09:19:25Z

Created page with '{{ml_birc}} NOTOC This function is used to retrieve the current state of specified {{ml_birc|ircbot}}. ==Syntax== <syntaxhighlight lang="lua"> string ircGetBotState ( ircbot theBot ) </co…'

New page
{{ml_birc}}
NOTOC
This function is used to retrieve the current state of specified {{ml_birc|ircbot}}.

==Syntax==
<syntaxhighlight lang="lua">
string ircGetBotState ( ircbot theBot )
</syntaxhighlight>

===Required Arguments===
'''theBot:''' The ircbot which current state you want to get

===Returns===
Returns a string of the ircbot's current state. Possible values are:
'''disconnected'''
'''connecting'''
'''connected'''

==Example==
This example creates an ircbot called ''DummyBot'' makes it connect to a server. During the connection progress bot's current states are printed out to the server log.
<syntaxhighlight lang="lua">
function resourceStart ()
dummyBot = ircCreateBot ( "DummyBot" )
outputServerLog ( "DummyBot is now " .. ircGetBotState ( dummyBot ) ) -- "disconnected"
ircConnect ( dummyBot, "irc.gtanet.com", 6667 )
outputServerLog ( "DummyBot is now " .. ircGetBotState ( dummyBot ) ) -- "connecting"
end
addEventHandler ( "onResourceStart", getResourceRootElement ( getThisResource() ), resourceStart )

function event_ircOnConnect ( theBot )
outputServerLog ( ircGetName ( theBot ) .. " is now " .. ircGetBotState ( theBot ) ) -- "connected"
end
</syntaxhighlight>

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