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

2009-08-14T19:43:22Z

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

New page

{{ml_birc}}
__NOTOC__
This function can be used to change the topic of 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">
bool ircSetChannelTopic ( ircbot theBot, string channel, string topic )
</syntaxhighlight>

===Required Arguments===
*'''theBot:''' The ircbot which is in the channel
*'''channel:''' The name of the channel which channel topic you want to change
*'''topic:''' The new topic of the channel

===Returns===
Returns ''true'' if passed arguments were valid, ''false'' otherwise.<br>
'''Note:''' Does not return ''true'' if the channel topic was successfully changed or ''false'' if it wasn't changed. You can check if the channel topic was changed by using callback {{ml_birc|event_ircOnTopic}}.

==Example==
This example creates an ircbot called ''DummyBot'' makes it connect to a server and join a channel. It also includes an IRC command '!settopic' which can used change the current channel topic.
<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( "!settopic" ) then
local topic = message:sub( 11 ) -- subtract "!settopic " from the message
ircSetChannelTopic ( theBot, channel, topic )
end

end
</syntaxhighlight>

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

Modules/bIRC/ircSetChannelTopic - Revision history

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

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