Document commands handling on the plugin side.

This commit is contained in:
Valentin Lorentz 2014-01-20 11:15:30 +01:00
parent 2df3137061
commit 27a9a4764d

View File

@ -7,6 +7,10 @@ events catchable via those methods (other events include
:ref:`configuration hooks <configuration-hooks>` and
:ref:`HTTP server callbacks <http_plugins>`)
All methods here are defined in ``supybot-callbacks-plugin``. You may
override them if you need, but make sure you call the parent's one
unless you actually don't want to do it.
Commands and numerics
=====================
@ -23,3 +27,21 @@ To get a list of all possible messages, check IRC RFCs.
Commands handling
=================
.. note::
I wrote this section with the little knowledge I have of the
commands handling (all I know comes from hacks I made to write
the Aka plugin), so keep in mind some informations might
be wrong.
As for all the documentation, feel free to contact me to
correct/enhance it.
* isCommandMethod takes a command name as a string (which may contain
spaces) and returns a boolean telling if the plugin provides this command.
* listCommands returns a list of command names as strings (which may
contain spaces)
* getCommand takes a potential command name as a list of strings, and
returns a truncated list corresponding to the name of a command provided
by the plugin. If no command match, it returns an empty list.
* getCommandMethod takes a command name as a list of strings and
returns the corresponding method/function.