Document inFilter and outFilter.

This commit is contained in:
Valentin Lorentz 2014-01-20 13:35:42 +01:00
parent 0e7c7fac45
commit 8dc9d73f0e

View File

@ -23,6 +23,19 @@ and a :ref:`IrcMsg object <supybot-ircmsgs>`.
To get a list of all possible messages, check IRC RFCs. To get a list of all possible messages, check IRC RFCs.
Filters
=======
The ``inFilter`` and ``outFilter`` methods allow you to “intercept”
messages between the bot and the network and to alter them.
``inFilter`` gets messages just after they are parsed from network;
and its return value is fed to the bot.
``outFilter`` does the opposite: it get any message the bot is about
the send, and returns a message (which may be the same) that will
be sent instead.
.. _commands_handling: .. _commands_handling:
Commands handling Commands handling