kaguya v0.5.1 Kaguya.Util

Summary

Functions

Sets MODE +b on mask in chan where mask can be !@vhost.com This bans a user from chan

Looks up a channel’s pid and returns it if it exists, nil otherwise

Returns the docstring for a handler in a module

Sends a WHOIS query to a server for a nick and returns a Kaguya.Core.User struct if it was succesful. Otherwise nil is returned

Sends the IRC server the JOIN command

Kicks user from chan

Kicks user from chan with the reason reason

Loads a module

Sends the IRC server the PART command

Unloads then loads a module

Sends the NICK command to the IRC server, with the given nick

Sends a NOTICE to a recipient on the IRC server

Sends a PRIVMSG to a recipient on the IRC server

Sends the PASS command to the IRC server with the given password

Sends the USER command to the IRC server, with the given name, and an optional realname param

Sets MODE mode on chan. Example: chan is “#sekrit” mode is “+s”

Sets MODE mode on trailing in chan. Example: chan is “#sekrit”, mode is “+b” and trailing is “baduser”

Sets MODE -b on mask in chan where mask can be !@vhost.com This unbans a user from chan

Unloads a module

Functions

ban(chan, mask)

Sets MODE +b on mask in chan where mask can be !@vhost.com This bans a user from chan.

black()
blue()
bold()
brown()
clear()
color(foreground)
color(foreground, background)
cyan()
darkgray()
getChanPid(channel)

Looks up a channel’s pid and returns it if it exists, nil otherwise.

getDocs(module, handler)

Returns the docstring for a handler in a module

getWhois(nick)

Sends a WHOIS query to a server for a nick and returns a Kaguya.Core.User struct if it was succesful. Otherwise nil is returned.

gray()
green()
italic()
joinChan(channel)

Sends the IRC server the JOIN command.

kick(chan, user)

Kicks user from chan.

kick(reason, chan, user)

Kicks user from chan with the reason reason.

lightblue()
lightcyan()
lightgreen()
lightmagenta()
lightred()
loadModule(module)

Loads a module.

magenta()
partChan(channel)

Sends the IRC server the PART command.

red()
reloadModule(module)

Unloads then loads a module.

sendNick(nick)

Sends the NICK command to the IRC server, with the given nick.

sendNotice(message, recipient)

Sends a NOTICE to a recipient on the IRC server.

sendPM(message, recipient)

Sends a PRIVMSG to a recipient on the IRC server.

sendPass(password)

Sends the PASS command to the IRC server with the given password

sendUser(user, realname \\ "")

Sends the USER command to the IRC server, with the given name, and an optional realname param.

setMode(chan, mode)

Sets MODE mode on chan. Example: chan is “#sekrit” mode is “+s”

This will make the #sekrit channel secret.

setMode(chan, mode, trailing)

Sets MODE mode on trailing in chan. Example: chan is “#sekrit”, mode is “+b” and trailing is “baduser”

This will set +b on baduser!@

unban(chan, mask)

Sets MODE -b on mask in chan where mask can be !@vhost.com This unbans a user from chan.

underline()
unloadModule(module)

Unloads a module.

white()
yellow()