loot/libloot
0
0
Fork 0
mirror of https://github.com/loot/libloot.git synced 2026-07-27 14:16:01 -07:00
Code Issues Packages Projects Releases Wiki Activity

Minor documentation updates to reflect refactoring

Browse Source
This commit is contained in:
Oliver Hamlet
2017-02-06 18:03:18 +00:00
parent 93660a26af
commit a427881939
3 changed files with 10 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/api/miscellaneous.rst
+8 -3
View File
@@ -6,10 +6,11 @@ String Encoding
===============
* All output strings are encoded in UTF-8.
* Metadata files are written encoded in UTF-8.
* Input strings are expected to be encoded in UTF-8.
* Metadata files read are expected to be encoded in UTF-8.
* File paths are case-sensitive if and only if the underlying file system is
case-sensitive.
* :cpp:func:`WriteMinimalList` writes a metadata list encoded in UTF-8.
Errors
======
@@ -48,8 +49,12 @@ so that every call to :cpp:func:`EvalLists` re-evaluates all conditions, but
conditions that are used more than once in the loaded metadata are only
evaluated once.
Plugin content is cached between calls to :cpp:func:`SortPlugins`, though no
other API function makes use of it.
Plugin content is cached between calls to :cpp:func:`LoadPlugins` and
:cpp:func:`SortPlugins`.
Load order is cached on creation of a game using :cpp:func:`CreateGameHandle`
and when :cpp:func:`SetLoadOrder` is called, and plugins' active states are
cached between calls to :cpp:func:`LoadPlugins` and :cpp:func:`SortPlugins`.
Performance
===========
docs/api/sorting.rst
+1 -2
View File
@@ -25,8 +25,7 @@ Create plugin graph vertices
Once loaded, a directed graph is created and the plugins are added to it in
lexicographical order as vertices. Any metadata a plugin has in the masterlist
and userlist are then merged into its vertex's data store, and any metadata
conditions evaluated.
and userlist are then merged into its vertex's data store.
Create plugin graph edges
==============================
docs/app/usage/editor.rst
+1 -1
View File
@@ -8,7 +8,7 @@ The editor panel is accessed by clicking the "Edit Metadata" item in a plugin's
The editor's header displays the name of the plugin being edited, "Save Metadata" and "Cancel" buttons, and a row of tabs. The MAIN tab's page contains the following inputs:
- The "Enable Edits" toggle must be on for LOOT to use any user-added metadata, otherwise it will be ignored.
- The "Enable Edits" toggle must be on for LOOT to use any user-added metadata during sorting, otherwise it will be ignored.
- The "Global Priority" input sets the plugin's global priority value, which is used to modify plugin position relative to all other plugins. Plugins with higher priority values load after plugins with lower priority values. Plugins have a default global priority of 0.
- The "Priority Value" input sets the plugin's local priority value, which is used to modify plugin position relative to other plugins that conflict, load archives or are empty. Plugins with higher priority values load after plugins with lower priority values. Plugins have a default local priority of 0.