Files
libloot-python/docs/reference.rst
T
Oliver Hamlet 7fe1d322aa Increase API wrapper coverage
It now wraps everything except the Error class, which is intentionally
left unwrapped, as wrapping it would provide no benefit.
2016-08-16 08:12:50 +01:00

64 lines
1.2 KiB
ReStructuredText

*************
API Reference
*************
As this API is just a wrapper for LOOT's C++ API, its documentation is linked to
for all non-Python-specific information.
Enumerations
============
The wrapped enumeration types below are classes in Python, but the distinction
makes no difference in practice, so they're grouped here for semantics.
.. autoclass:: loot_api.GameType
:members:
:undoc-members:
.. autoclass:: loot_api.LanguageCode
:members:
:undoc-members:
.. autoclass:: loot_api.MessageType
:members:
:undoc-members:
.. autoclass:: loot_api.PluginCleanliness
:members:
:undoc-members:
Public-Field Data Structures
============================
Classes with public fields and no member functions.
.. autoclass:: loot_api.MasterlistInfo
:members:
:undoc-members:
.. autoclass:: loot_api.Message
:members:
:undoc-members:
.. autoclass:: loot_api.PluginTags
:members:
:undoc-members:
Functions
=========
.. autofunction:: loot_api.is_compatible
.. autofunction:: loot_api.create_database
Classes
=======
.. autoclass:: loot_api.DatabaseInterface
:members:
.. autoclass:: loot_api.Version
:members:
:undoc-members: