otfbot.lib.chatMod.chatMod

class documentation

class chatMod(Plugin): (source)

Known subclasses: otfbot.plugins.ircClient.answers.Plugin, otfbot.plugins.ircClient.auth.Plugin, otfbot.plugins.ircClient.autorejoin.Plugin, otfbot.plugins.ircClient.badwords.Plugin, otfbot.plugins.ircClient.blowcrypt.Plugin, otfbot.plugins.ircClient.chapterbot.Plugin, otfbot.plugins.ircClient.checkbox.Plugin, otfbot.plugins.ircClient.commands.Plugin, otfbot.plugins.ircClient.controlIRC.Plugin, otfbot.plugins.ircClient.controlServer.Plugin, otfbot.plugins.ircClient.ddate.Plugin, otfbot.plugins.ircClient.eightBall.Plugin, otfbot.plugins.ircClient.feed.Plugin, otfbot.plugins.ircClient.flyspray.Plugin, otfbot.plugins.ircClient.google.Plugin, otfbot.plugins.ircClient.human.Plugin, otfbot.plugins.ircClient.icecast.Plugin, otfbot.plugins.ircClient.identify.Plugin, otfbot.plugins.ircClient.jc.plugin.Plugin, otfbot.plugins.ircClient.karma.Plugin, otfbot.plugins.ircClient.keepnick.Plugin, otfbot.plugins.ircClient.ki.Plugin, otfbot.plugins.ircClient.kurs.Plugin, otfbot.plugins.ircClient.log.Plugin, otfbot.plugins.ircClient.marvin.Plugin, otfbot.plugins.ircClient.math.Plugin, otfbot.plugins.ircClient.mirror.Plugin, otfbot.plugins.ircClient.mode.Plugin, otfbot.plugins.ircClient.moon.Plugin, otfbot.plugins.ircClient.noautorejoin.Plugin, otfbot.plugins.ircClient.quotesfromweb.Plugin, otfbot.plugins.ircClient.reminder.Plugin, otfbot.plugins.ircClient.seen.Plugin, otfbot.plugins.ircClient.statistics.Plugin, otfbot.plugins.ircClient.svn-push.Plugin, otfbot.plugins.ircClient.svn.Plugin, otfbot.plugins.ircClient.timediff.Plugin, otfbot.plugins.ircClient.tv.Plugin, otfbot.plugins.ircClient.url.Plugin, otfbot.plugins.ircClient.version.Plugin, otfbot.plugins.ircClient.vote.Plugin, otfbot.plugins.ircClient.weather.Plugin, otfbot.plugins.ircClient.youtube.Plugin, otfbot.plugins.ircServer.basic.Plugin, otfbot.plugins.ircServer.controlServer.Plugin, otfbot.plugins.ircServer.human.Plugin

View In Hierarchy

this class is mainly for documentation of the callbacks. some functions are helper functions for common tasks, i.e. kicked calls userLeft, so a plugin only implementing userLeft will notice that a kicked user left the channel. a plugin implementing kicked too, can handle it independent from userLeft, because kicked will be overwritten

Method __init__ Undocumented
Method action action (/me) received
Method auth check the authorisation of the user
Method command a command message received
Method connectionLost lost connection to server
Method connectionMade made connection to server
Method ctcpQuery called for ctcp queries
Method irc_unknown an IRC-Message, which is not handle by twisted was received
Method joined we have joined a channel
Method kickedFrom someone kicked the bot
Method left we have left a channel
Method lineReceived Undocumented
Method modeChanged mode changed
Method msg message received
Method noticed we got a notice
Method query a private message received
Method reload called to reload the settings of the module
Method sendLine Undocumented
Method signedOn successfully signed on
Method start called to start the work of the module put your initialization stuff in here insteadof __init__
Method stop called, when the bot is stopped, or the module is reloaded
Method topicUpdated a user changed the topic of a channel
Method userJoined a user joined the channel
Method userJoinedMask Undocumented
Method userKicked someone kicked someone else
Method userLeft a user left the channel
Method userQuit a user disconnect from the network
Method userRenamed a user changed the nick
Method yourHost info about your host
Instance Variable bot Undocumented
def __init__(self, bot): (source)
overridden in otfbot.plugins.ircClient.answers.Plugin, otfbot.plugins.ircClient.auth.Plugin, otfbot.plugins.ircClient.autorejoin.Plugin, otfbot.plugins.ircClient.badwords.Plugin, otfbot.plugins.ircClient.blowcrypt.Plugin, otfbot.plugins.ircClient.chapterbot.Plugin, otfbot.plugins.ircClient.checkbox.Plugin, otfbot.plugins.ircClient.commands.Plugin, otfbot.plugins.ircClient.controlIRC.Plugin, otfbot.plugins.ircClient.controlServer.Plugin, otfbot.plugins.ircClient.ddate.Plugin, otfbot.plugins.ircClient.eightBall.Plugin, otfbot.plugins.ircClient.feed.Plugin, otfbot.plugins.ircClient.flyspray.Plugin, otfbot.plugins.ircClient.google.Plugin, otfbot.plugins.ircClient.human.Plugin, otfbot.plugins.ircClient.icecast.Plugin, otfbot.plugins.ircClient.identify.Plugin, otfbot.plugins.ircClient.jc.plugin.Plugin, otfbot.plugins.ircClient.karma.Plugin, otfbot.plugins.ircClient.keepnick.Plugin, otfbot.plugins.ircClient.ki.Plugin, otfbot.plugins.ircClient.kurs.Plugin, otfbot.plugins.ircClient.log.Plugin, otfbot.plugins.ircClient.marvin.Plugin, otfbot.plugins.ircClient.math.Plugin, otfbot.plugins.ircClient.mirror.Plugin, otfbot.plugins.ircClient.mode.Plugin, otfbot.plugins.ircClient.moon.Plugin, otfbot.plugins.ircClient.noautorejoin.Plugin, otfbot.plugins.ircClient.quotesfromweb.Plugin, otfbot.plugins.ircClient.reminder.Plugin, otfbot.plugins.ircClient.seen.Plugin, otfbot.plugins.ircClient.statistics.Plugin, otfbot.plugins.ircClient.svn-push.Plugin, otfbot.plugins.ircClient.svn.Plugin, otfbot.plugins.ircClient.timediff.Plugin, otfbot.plugins.ircClient.tv.Plugin, otfbot.plugins.ircClient.url.Plugin, otfbot.plugins.ircClient.version.Plugin, otfbot.plugins.ircClient.vote.Plugin, otfbot.plugins.ircClient.weather.Plugin, otfbot.plugins.ircClient.youtube.Plugin, otfbot.plugins.ircServer.basic.Plugin, otfbot.plugins.ircServer.controlServer.Plugin, otfbot.plugins.ircServer.human.Plugin

Undocumented

def action(self, user, channel, msg): (source)
overridden in otfbot.plugins.ircClient.answers.Plugin, otfbot.plugins.ircClient.human.Plugin, otfbot.plugins.ircClient.ki.Plugin, otfbot.plugins.ircClient.log.Plugin, otfbot.plugins.ircClient.mirror.Plugin

action (/me) received

def auth(self, user): (source)
overridden in otfbot.plugins.ircClient.auth.Plugin

check the authorisation of the user

def command(self, user, channel, command, options): (source)
overridden in otfbot.plugins.ircClient.chapterbot.Plugin, otfbot.plugins.ircClient.commands.Plugin, otfbot.plugins.ircClient.controlIRC.Plugin, otfbot.plugins.ircClient.ddate.Plugin, otfbot.plugins.ircClient.eightBall.Plugin, otfbot.plugins.ircClient.feed.Plugin, otfbot.plugins.ircClient.flyspray.Plugin, otfbot.plugins.ircClient.google.Plugin, otfbot.plugins.ircClient.icecast.Plugin, otfbot.plugins.ircClient.jc.plugin.Plugin, otfbot.plugins.ircClient.karma.Plugin, otfbot.plugins.ircClient.kurs.Plugin, otfbot.plugins.ircClient.math.Plugin, otfbot.plugins.ircClient.mode.Plugin, otfbot.plugins.ircClient.moon.Plugin, otfbot.plugins.ircClient.quotesfromweb.Plugin, otfbot.plugins.ircClient.reminder.Plugin, otfbot.plugins.ircClient.seen.Plugin, otfbot.plugins.ircClient.statistics.Plugin, otfbot.plugins.ircClient.timediff.Plugin, otfbot.plugins.ircClient.tv.Plugin, otfbot.plugins.ircClient.url.Plugin, otfbot.plugins.ircClient.version.Plugin, otfbot.plugins.ircClient.vote.Plugin, otfbot.plugins.ircClient.weather.Plugin, otfbot.plugins.ircClient.youtube.Plugin

a command message received

def connectionLost(self, reason): (source)
overridden in otfbot.plugins.ircClient.feed.Plugin, otfbot.plugins.ircClient.identify.Plugin, otfbot.plugins.ircClient.ki.Plugin, otfbot.plugins.ircClient.svn.Plugin

lost connection to server

def connectionMade(self): (source)
overridden in otfbot.plugins.ircClient.commands.Plugin, otfbot.plugins.ircClient.log.Plugin

made connection to server

def ctcpQuery(self, user, channel, messages): (source)

called for ctcp queries

def irc_unknown(self, prefix, command, params): (source)
overridden in otfbot.plugins.ircClient.keepnick.Plugin

an IRC-Message, which is not handle by twisted was received

def joined(self, channel): (source)
overridden in otfbot.plugins.ircClient.commands.Plugin, otfbot.plugins.ircClient.feed.Plugin, otfbot.plugins.ircClient.karma.Plugin, otfbot.plugins.ircClient.ki.Plugin, otfbot.plugins.ircClient.log.Plugin, otfbot.plugins.ircClient.mirror.Plugin, otfbot.plugins.ircClient.seen.Plugin, otfbot.plugins.ircClient.statistics.Plugin, otfbot.plugins.ircClient.svn.Plugin

we have joined a channel

def kickedFrom(self, channel, kicker, message): (source)
overridden in otfbot.plugins.ircClient.autorejoin.Plugin, otfbot.plugins.ircClient.mirror.Plugin, otfbot.plugins.ircClient.svn.Plugin

someone kicked the bot

def left(self, channel): (source)
overridden in otfbot.plugins.ircClient.karma.Plugin, otfbot.plugins.ircClient.log.Plugin, otfbot.plugins.ircClient.svn.Plugin

we have left a channel

def lineReceived(self, line): (source)

Undocumented

def modeChanged(self, user, channel, set, modes, args): (source)
overridden in otfbot.plugins.ircClient.log.Plugin, otfbot.plugins.ircClient.mirror.Plugin

mode changed

def msg(self, user, channel, msg): (source)
overridden in otfbot.plugins.ircClient.answers.Plugin, otfbot.plugins.ircClient.badwords.Plugin, otfbot.plugins.ircClient.blowcrypt.Plugin, otfbot.plugins.ircClient.checkbox.Plugin, otfbot.plugins.ircClient.eightBall.Plugin, otfbot.plugins.ircClient.human.Plugin, otfbot.plugins.ircClient.ki.Plugin, otfbot.plugins.ircClient.log.Plugin, otfbot.plugins.ircClient.marvin.Plugin, otfbot.plugins.ircClient.mirror.Plugin, otfbot.plugins.ircClient.seen.Plugin, otfbot.plugins.ircClient.statistics.Plugin, otfbot.plugins.ircClient.url.Plugin

message received

def noticed(self, user, channel, msg): (source)
overridden in otfbot.plugins.ircClient.identify.Plugin, otfbot.plugins.ircClient.log.Plugin

we got a notice

def query(self, user, channel, msg): (source)
overridden in otfbot.plugins.ircClient.auth.Plugin, otfbot.plugins.ircClient.controlIRC.Plugin, otfbot.plugins.ircClient.human.Plugin, otfbot.plugins.ircClient.jc.plugin.Plugin, otfbot.plugins.ircClient.ki.Plugin, otfbot.plugins.ircClient.log.Plugin

a private message received

def reload(self): (source)
overridden in otfbot.plugins.ircClient.answers.Plugin, otfbot.plugins.ircClient.badwords.Plugin, otfbot.plugins.ircClient.commands.Plugin, otfbot.plugins.ircClient.marvin.Plugin

called to reload the settings of the module

def sendLine(self, line): (source)
overridden in otfbot.plugins.ircClient.blowcrypt.Plugin

Undocumented

def signedOn(self): (source)
overridden in otfbot.plugins.ircClient.identify.Plugin, otfbot.plugins.ircClient.keepnick.Plugin

successfully signed on

def start(self): (source)
overridden in otfbot.plugins.ircClient.answers.Plugin, otfbot.plugins.ircClient.badwords.Plugin, otfbot.plugins.ircClient.commands.Plugin, otfbot.plugins.ircClient.jc.plugin.Plugin, otfbot.plugins.ircClient.karma.Plugin, otfbot.plugins.ircClient.ki.Plugin, otfbot.plugins.ircClient.marvin.Plugin

called to start the work of the module put your initialization stuff in here insteadof __init__

def stop(self): (source)
overridden in otfbot.plugins.ircClient.feed.Plugin, otfbot.plugins.ircClient.karma.Plugin, otfbot.plugins.ircClient.ki.Plugin, otfbot.plugins.ircClient.log.Plugin, otfbot.plugins.ircClient.seen.Plugin

called, when the bot is stopped, or the module is reloaded

def topicUpdated(self, user, channel, newTopic): (source)
overridden in otfbot.plugins.ircClient.blowcrypt.Plugin, otfbot.plugins.ircClient.log.Plugin

a user changed the topic of a channel

def userJoined(self, user, channel): (source)
overridden in otfbot.plugins.ircClient.log.Plugin, otfbot.plugins.ircClient.mirror.Plugin, otfbot.plugins.ircClient.noautorejoin.Plugin, otfbot.plugins.ircClient.statistics.Plugin

a user joined the channel

def userJoinedMask(self, user, channel): (source)

Undocumented

def userKicked(self, kickee, channel, kicker, message): (source)
overridden in otfbot.plugins.ircClient.keepnick.Plugin, otfbot.plugins.ircClient.log.Plugin, otfbot.plugins.ircClient.mirror.Plugin, otfbot.plugins.ircClient.noautorejoin.Plugin

someone kicked someone else

def userLeft(self, user, channel): (source)
overridden in otfbot.plugins.ircClient.log.Plugin, otfbot.plugins.ircClient.mirror.Plugin

a user left the channel

def userQuit(self, user, quitMessage): (source)
overridden in otfbot.plugins.ircClient.keepnick.Plugin, otfbot.plugins.ircClient.log.Plugin, otfbot.plugins.ircClient.mirror.Plugin

a user disconnect from the network

def userRenamed(self, oldname, newname): (source)
overridden in otfbot.plugins.ircClient.keepnick.Plugin, otfbot.plugins.ircClient.log.Plugin, otfbot.plugins.ircClient.mirror.Plugin

a user changed the nick

def yourHost(self, info): (source)

info about your host

bot = (source)
overridden in otfbot.plugins.ircClient.answers.Plugin, otfbot.plugins.ircClient.auth.Plugin, otfbot.plugins.ircClient.autorejoin.Plugin, otfbot.plugins.ircClient.badwords.Plugin, otfbot.plugins.ircClient.blowcrypt.Plugin, otfbot.plugins.ircClient.chapterbot.Plugin, otfbot.plugins.ircClient.checkbox.Plugin, otfbot.plugins.ircClient.commands.Plugin, otfbot.plugins.ircClient.controlIRC.Plugin, otfbot.plugins.ircClient.controlServer.Plugin, otfbot.plugins.ircClient.ddate.Plugin, otfbot.plugins.ircClient.eightBall.Plugin, otfbot.plugins.ircClient.feed.Plugin, otfbot.plugins.ircClient.flyspray.Plugin, otfbot.plugins.ircClient.google.Plugin, otfbot.plugins.ircClient.human.Plugin, otfbot.plugins.ircClient.icecast.Plugin, otfbot.plugins.ircClient.identify.Plugin, otfbot.plugins.ircClient.jc.plugin.Plugin, otfbot.plugins.ircClient.karma.Plugin, otfbot.plugins.ircClient.keepnick.Plugin, otfbot.plugins.ircClient.ki.Plugin, otfbot.plugins.ircClient.kurs.Plugin, otfbot.plugins.ircClient.log.Plugin, otfbot.plugins.ircClient.marvin.Plugin, otfbot.plugins.ircClient.math.Plugin, otfbot.plugins.ircClient.mirror.Plugin, otfbot.plugins.ircClient.mode.Plugin, otfbot.plugins.ircClient.moon.Plugin, otfbot.plugins.ircClient.noautorejoin.Plugin, otfbot.plugins.ircClient.quotesfromweb.Plugin, otfbot.plugins.ircClient.reminder.Plugin, otfbot.plugins.ircClient.seen.Plugin, otfbot.plugins.ircClient.statistics.Plugin, otfbot.plugins.ircClient.svn-push.Plugin, otfbot.plugins.ircClient.svn.Plugin, otfbot.plugins.ircClient.timediff.Plugin, otfbot.plugins.ircClient.tv.Plugin, otfbot.plugins.ircClient.url.Plugin, otfbot.plugins.ircClient.version.Plugin, otfbot.plugins.ircClient.vote.Plugin, otfbot.plugins.ircClient.weather.Plugin, otfbot.plugins.ircClient.youtube.Plugin

Undocumented