Document 'do-commands'.

This commit is contained in:
Valentin Lorentz 2014-01-20 10:46:39 +01:00
parent 0ba89a0425
commit 6c3d4fa07c
4 changed files with 25 additions and 0 deletions

View File

@ -418,6 +418,8 @@ Note that we initialize it just the same as we do any other registry type, with
two arguments: the default value, and then the description of the config
variable.
.. _configuration-hooks:
Configuration hooks
===================

20
develop/events.rst Normal file
View File

@ -0,0 +1,20 @@
***************
Catching events
***************
This page is a non-exhaustive list of catchable
events via plugin methods (other events include
:ref:`configuration hooks <configuration-hooks>` and
:ref:`HTTP server callbacks <http_plugins>`)
Commands and numerics
=====================
You can catch commands directly with “do-methods”: when the bot receives a
``PRIVMSG``, all ``doPrivmsg`` methods are called; when it gets a ``437``
message, all ``do437`` methods are called, etc.
Those command take two commands: an :ref:`Irc object <supybot-irclib-irc>`
and a :ref:`IrcMsg object <supybot-ircmsgs>`.
To get a list of all possible messages, check IRC RFCs.

View File

@ -1,3 +1,5 @@
.. _http_plugins:
********************************************
Using Limnoria's HTTP server in your plugins
********************************************

View File

@ -23,6 +23,7 @@ Specific documentation
:maxdepth: 2
using_utils.rst
events.rst
httpserver.rst
Library reference