Mikaela/Limnoria-doc
1
0
Fork 0
mirror of https://github.com/Mikaela/Limnoria-doc.git synced 2024-11-23 12:39:35 +01:00
Code Issues Projects Releases Wiki Activity

Fix titles in develop/advanced_plugin_configuration.rst.

Browse Source
This commit is contained in:
Valentin Lorentz 2014-01-20 09:33:49 +01:00
parent 69c14633ba
commit 512fb25c93
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
develop/advanced_plugin_config.rst
View File

@ -249,6 +249,7 @@ Custom Registry Types
plugin config variables. plugin config variables.
Why Create Custom Registry Types? Why Create Custom Registry Types?
---------------------------------
For most configuration, the provided types in the registry module are For most configuration, the provided types in the registry module are
sufficient. However, for some configuration variables it's not only convenient sufficient. However, for some configuration variables it's not only convenient
@ -257,6 +258,7 @@ types allows for tighter restrictions on the values that get set and for
greater error-checking than is possible with the provided types. greater error-checking than is possible with the provided types.
What Defines a Registry Type? What Defines a Registry Type?
-----------------------------
First and foremost, it needs to subclass one of the existing registry types First and foremost, it needs to subclass one of the existing registry types
from the registry module, whether it be one of the ones in the previous section from the registry module, whether it be one of the ones in the previous section
@ -267,6 +269,7 @@ type, customized value-setting (transforming the data you get into something
else if wanted), etc. else if wanted), etc.
Creating Your First Custom Registry Type Creating Your First Custom Registry Type
----------------------------------------
As stated above, priority number one is that you subclass one of the types in As stated above, priority number one is that you subclass one of the types in
the registry module. Basically, you just subclass one of those and then the registry module. Basically, you just subclass one of those and then
@ -291,6 +294,7 @@ gotten an invalid value is to call self.error(). Finally, we call the parent
class's setValue to actually set the value. class's setValue to actually set the value.
What Else Can I Customize? What Else Can I Customize?
--------------------------
Well, the error string and the setValue function are the most useful things Well, the error string and the setValue function are the most useful things
that are available for customization, but there are other things. For examples, that are available for customization, but there are other things. For examples,
@ -298,6 +302,7 @@ look at the actual built-in registry types defined in registry.py (in the src
directory distributed with the bot). directory distributed with the bot).
What Subclasses Can I Use? What Subclasses Can I Use?
--------------------------
Chances are one of the built-in types in the previous section will be Chances are one of the built-in types in the previous section will be
sufficient, but there are a few others of note which deserve mention: sufficient, but there are a few others of note which deserve mention:
@ -322,6 +327,7 @@ sufficient, but there are a few others of note which deserve mention:
section below. section below.
Using My Custom Registry Type Using My Custom Registry Type
-----------------------------
Using your new registry type is relatively straightforward. Instead of using Using your new registry type is relatively straightforward. Instead of using
whatever registry built-in you might have used before, now use your own custom whatever registry built-in you might have used before, now use your own custom