mtcontrib/LuaIRC
1
0
Fork 0
mirror of https://github.com/ShadowNinja/LuaIRC.git synced 2024-06-30 07:30:23 +02:00
Code Issues Releases Wiki Activity

Updated docs with topic stuff

Browse Source
This commit is contained in:
Jakob Ovrum 2010-07-17 11:54:59 +09:00
parent ccd8a64ae2
commit e589fe727d
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
doc/irc.luadoc
View File

@ -62,6 +62,11 @@ function irc:think()
-- @return Table with fields <code>userinfo</code>, <code>node</code>, <code>channels</code> and <code>account</code>. -- @return Table with fields <code>userinfo</code>, <code>node</code>, <code>channels</code> and <code>account</code>.
function irc:whois(nick) function irc:whois(nick)
--- Look up topic.
-- Use this to invoke the hooks OnTopic and OnTopicInfo at any time.
-- @param channel Channel to query.
function irc:topic(channel)
--- Send a raw line of IRC to the server. --- Send a raw line of IRC to the server.
-- @param fmt Line to be sent, excluding newline characters. -- @param fmt Line to be sent, excluding newline characters.
-- @param ... Format parameters for <code>fmt</code>, with <code>string.format</code> semantics. -- @param ... Format parameters for <code>fmt</code>, with <code>string.format</code> semantics.
@ -113,6 +118,8 @@ function irc:shutdown()
-- <li><code>OnQuit(user, message)</code></li> -- <li><code>OnQuit(user, message)</code></li>
-- <li><code>NickChange(user, newnick, channel)</code>*†</li> -- <li><code>NickChange(user, newnick, channel)</code>*†</li>
-- <li><code>NameList(channel, names)</code></li> -- <li><code>NameList(channel, names)</code></li>
-- <li><code>OnTopic(channel, topic)</code></li>
-- <li><code>OnTopicInfo(channel, creator, timeCreated)</code></li>
-- </ul> -- </ul>
-- * Event also invoked for yourself. -- * Event also invoked for yourself.
-- † Channel passed only when user tracking is enabled -- † Channel passed only when user tracking is enabled