Awwu: Created page with '{{ml_birc}} NOTOC This function can be used to list out all the channels a specified {{ml_birc|ircbot}} has connected to. ==Syntax== table ircGetConnectedChan…'

2009-07-30T10:55:42Z

Created page with '{{ml_birc}} __NOTOC__ This function can be used to list out all the channels a specified {{ml_birc|ircbot}} has connected to. ==Syntax== <syntaxhighlight lang="lua"> table ircGetConnectedChan…'

New page

{{ml_birc}}
__NOTOC__
This function can be used to list out all the channels a specified {{ml_birc|ircbot}} has connected to.

==Syntax==
<syntaxhighlight lang="lua">
table ircGetConnectedChannels ( ircbot theBot )
</syntaxhighlight>

===Required Arguments===
*'''theBot:''' The ircbot which connected channels you want to get

===Returns===
Returns a [[table]] over all connected channels. Returns an empty table if the ircbot isn't connected to any channel.

==Example==
This example adds a command ''listchannels'' which can be used to print out all channels where the specified ircbot is connected to the console.
<syntaxhighlight lang="lua">
function printOutChannels ( thePlayer, commandName, name )
local theBot = ircGetBotByName ( name )
if not theBot then
outputConsole ( "There's no ircbot called " .. name .. "!", thePlayer )
else
local channels = ircGetConnectedChannels ( theBot )
outputConsole ( name .. " is on " .. #channels .. " channels:", thePlayer )
for key, value in ipairs ( channels ) do
outputConsole ( "- " .. value, thePlayer )
end
end
end
addCommandHandler ( "listchannels", printOutChannels )
</syntaxhighlight>

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

Modules/bIRC/ircGetConnectedChannels - Revision history

Awwu: Created page with '{{ml_birc}} __NOTOC__ This function can be used to list out all the channels a specified {{ml_birc|ircbot}} has connected to. ==Syntax== table ircGetConnectedChan…'

Awwu: Created page with '{{ml_birc}} NOTOC This function can be used to list out all the channels a specified {{ml_birc|ircbot}} has connected to. ==Syntax== table ircGetConnectedChan…'