Limnoria/Limnoria-doc
1
0
Fork 0
mirror of https://github.com/Limnoria/Limnoria-doc.git synced 2025-04-04 14:29:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

plugin_tutorial: fill in note about irc in plugin constructor

Browse Source
This commit is contained in:
James Lu
2023-05-05 23:53:13 -07:00
committed by James Lu
parent 94784eb88d
commit a88f291096
1 changed files with 7 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
develop/plugin_tutorial.rst
View File

@ -165,11 +165,14 @@ For this sample plugin, we define a custom constructor (``__init__``) that
instantiates a random number generator instance and pre-seeds it. This isn't
technically necessary for Python's ``random`` module, but it helps outline
how to write a similar constructor. Notice in particular how you must pass in
the ``irc`` argument in addition to ``self``.
an ``irc`` argument in addition to ``self``.
.. note::
TODO(jlu): semantically, what does ``irc`` refer to? Most plugins don't
actually reference it on load time.
.. warning::
Because Limnoria is a multi-network bot, you should generally ignore
the ``irc`` instance passed to the plugin constructor.
On a manual ``load`` call to a live bot, this will be set to the network
the command was run on, but on bot startup, ``irc`` will be (arbitrarily)
set to the first network that the bot decides to connect to.
Basic command handler
---------------------