otfbot.plugins.ircClient.commands.Plugin

class documentation

class Plugin(chatMod.chatMod): (source)

Undocumented

Method	`__init__`	Undocumented
Method	`command`	a command message received
Method	`connectionMade`	made connection to server
Method	`getCommand`	Undocumented
Method	`joined`	we have joined a channel
Method	`reload`	called to reload the settings of the module
Method	`respond`	respond to a command, substituting USER by the actual user and OTHER by the given options
Method	`start`	called to start the work of the module put your initialization stuff in here insteadof __init__
Instance Variable	`bot`	Undocumented
Instance Variable	`channels`	Undocumented
Instance Variable	`commands`	Undocumented
Instance Variable	`mtime`	Undocumented

Inherited from chatMod:

Method	`action`	action (/me) received
Method	`auth`	check the authorisation of the user
Method	`connectionLost`	lost connection to server
Method	`ctcpQuery`	called for ctcp queries
Method	`irc_unknown`	an IRC-Message, which is not handle by twisted was received
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	`sendLine`	Undocumented
Method	`signedOn`	successfully signed on
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

def __init__(self, bot): (source) ¶

overrides otfbot.lib.chatMod.chatMod.__init__

Undocumented

@callback
def command(self, user, channel, command, options): (source) ¶

overrides otfbot.lib.chatMod.chatMod.command

a command message received

@callback
def connectionMade(self): (source) ¶

overrides otfbot.lib.chatMod.chatMod.connectionMade

made connection to server

def getCommand(self, channel, cmd): (source) ¶

Undocumented

@callback
def joined(self, channel): (source) ¶

overrides otfbot.lib.chatMod.chatMod.joined

we have joined a channel

def reload(self): (source) ¶

overrides otfbot.lib.chatMod.chatMod.reload

called to reload the settings of the module

def respond(self, channel, user, command, options): (source) ¶

respond to a command, substituting USER by the actual user and OTHER by the given options

>>> c=Plugin(None)
>>> c.commands={} #just for the example to work
>>> c.commands['general']={"test": ["USER wanted a test"],
>>> "test_": ["USER wanted to show OTHER how it works"]}
>>> c.commands['network']={}
>>> #example begins here:
>>> c.respond("", "testuser", "test", "")
'testuser wanted a test'
>>> c.respond("", "testuser", "test", "you")
'testuser wanted to show you how it works'

def start(self): (source) ¶

overrides otfbot.lib.chatMod.chatMod.start

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

bot = (source) ¶

overrides otfbot.lib.chatMod.chatMod.bot

Undocumented

channels: list = (source) ¶

Undocumented

commands: dict = (source) ¶

Undocumented

mtime = (source) ¶

Undocumented