Mikaela/Limnoria-doc
1
0
Fork 0
mirror of https://github.com/Mikaela/Limnoria-doc.git synced 2024-11-30 08:19:24 +01:00
Code Issues Projects Releases Wiki Activity

Document channel-specific and private configuration variables.

Browse Source
This commit is contained in:
Valentin Lorentz 2014-01-20 10:11:01 +01:00
parent 68218a70d3
commit 82e1866c0e
1 changed files with 31 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
develop/advanced_plugin_config.rst
View File

@ -125,6 +125,7 @@ Using Config Groups
A brief overview of how to use config groups to organize config variables A brief overview of how to use config groups to organize config variables
Supybot's Hierarchical Configuration Supybot's Hierarchical Configuration
------------------------------------
Supybot's configuration is inherently hierarchical, as you've probably already Supybot's configuration is inherently hierarchical, as you've probably already
figured out in your use of the bot. Naturally, it makes sense to allow plugin figured out in your use of the bot. Naturally, it makes sense to allow plugin
@ -146,7 +147,7 @@ find that we do this in a handful of spots yet we use the "values as groups"
feature quite a bit. feature quite a bit.
Creating a Config Group Creating a Config Group
======================= -----------------------
As stated before, config variables themselves are groups, so you can create a As stated before, config variables themselves are groups, so you can create a
group simply by creating a configuration variable:: group simply by creating a configuration variable::
@ -177,7 +178,7 @@ course, the group name. So now we have WorldDom.attackTargets (or, fully,
supybot.plugins.WorldDom.attackTargets). supybot.plugins.WorldDom.attackTargets).
Adding Values to a Group Adding Values to a Group
======================== ------------------------
Actually, you've already done this several times, just never to a custom group Actually, you've already done this several times, just never to a custom group
of your own. You've always added config values to your plugin's config group. of your own. You've always added config values to your plugin's config group.
@ -193,6 +194,34 @@ argument is WorldDom.attackTargets, our new group. Make sure that the
conf.registerGroup call is made before this one or else you'll get a nasty conf.registerGroup call is made before this one or else you'll get a nasty
AttributeError. AttributeError.
Variations
----------
Channel-specific values
^^^^^^^^^^^^^^^^^^^^^^^
A very handy feature is channel-specific variables, which allows bot
administrators to set a global value (as for non-channel-specific values
AND another value for specific channels).
The syntax is pretty much like the previous one, except we use
`registerChannelValue` instead of `registerGlobalValue`::
conf.registerChannelValue(WorldDom.attackTargets, 'air',
registry.SpaceSeparatedListOfStrings('', """Contains the list of air
targets."""))
Private values
^^^^^^^^^^^^^^
Variable type also take an optional argument, for setting a configuration
variable to private (useful for passwords, authentication tokens,
api keys, …)::
conf.registerChannelValue(WorldDom.attackTargets, 'air',
registry.SpaceSeparatedListOfStrings('', """Contains the list of air
targets.""", private=True))
The Built-in Registry Types The Built-in Registry Types
=========================== ===========================
A rundown of all of the built-in registry types available for use with config A rundown of all of the built-in registry types available for use with config