Modules/bIRC/ircGetChannelUsers
Jump to navigation
Jump to search
|
This function is provided by the external module Basic IRC Module. You must install this module to use this function. |
This function can be used to list out all the users a specified channel.
Syntax
table ircGetChannelUsers ( ircbot theBot, string channel )
Required Arguments
- theBot: The ircbot which is connecteed to the channel
- channel: The channel which users you want to get
Returns
Returns a table over all channel users. Returns an empty table if there's no users on that channel or false if invalid arguments were passed.
Example
This example adds a command listusers which can be used to print out all users in the specified channel to the console.
function printOutChannels ( thePlayer, commandName, name, channel )
local theBot = ircGetBotByName ( name )
if not theBot then
outputConsole ( "There's no ircbot called " .. name .. "!", thePlayer )
else
if ircIsInChannel ( theBot, channel ) then
local users = ircGetChannelUsers ( theBot, channel )
if #users == 0 then
outputConsole ( "There's no users on " .. channel .. "!", thePlayer )
else
outputConsole ( "There is " .. #users .. " on " .. channel .. ":", thePlayer )
for key, value in ipairs ( users ) do
outputConsole ( "- " .. value, thePlayer )
end
end
else
outputConsole ( name .. " is not on " .. channel .. "!", thePlayer )
end
end
end
addCommandHandler ( "listchannels", printOutChannels )
See Also
Bot functions
Creation
Connection
Other
IRC functions
Channel
- ircGetChannelMode
- ircGetChannelTopic
- ircGetChannelUsers
- ircGetConnectedChannels
- ircJoinChannel
- ircPartChannel
- ircSetChannelMode
- ircSetChannelTopic