Mikaela/Limnoria-doc
1
0
Fork 0
mirror of https://github.com/Mikaela/Limnoria-doc.git synced 2025-02-21 08:01:04 +01:00
Code Issues Projects Releases Wiki Activity

Start writing a FAQ for plugin developers.

Browse Source
This commit is contained in:
Valentin Lorentz 2020-09-27 15:55:01 +02:00
parent b6e426b9d5
commit d9e718d80e
1 changed files with 26 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
develop/faq.rst Normal file
View File

@ -0,0 +1,26 @@
.. _developer-faq:
**************************
Frequently Asked Questions
**************************
This section tries to cover all questions you may have as a plugin developer.
(If you are a user, check out the :ref:`User FAQ <user-faq>` instead.)
Where can I find the user who called a command?
===============================================
The ``msg`` object passed to all event method as well as command methods is an
:py:class:`supybot.ircmsgs.IrcMsg` object, which stores the content of the
message, the nick and hostname of its author, etc. Check the documentation of
:py:class:`supybot.ircmsgs.IrcMsg` to see all available attributes.:w
Where can I find the hostname from a user's nick?
=================================================
The ``irc`` object passed to all event method as well as command methods is an
:py:class:`supybot.irclib.Irc` object, use
:py:meth:`irc.state.nickToHostmask <supybot.irclib.IrcState.nickToHostmask>`