mirror of
https://github.com/OpenMW/openmw.git
synced 2025-10-27 00:56:39 +00:00
74 lines
5.9 KiB
ReStructuredText
74 lines
5.9 KiB
ReStructuredText
#################
|
|
Lua API reference
|
|
#################
|
|
|
|
.. toctree::
|
|
:hidden:
|
|
|
|
engine_handlers
|
|
openmw_util
|
|
openmw_settings
|
|
openmw_core
|
|
openmw_async
|
|
openmw_query
|
|
openmw_world
|
|
openmw_self
|
|
openmw_nearby
|
|
openmw_input
|
|
openmw_ui
|
|
openmw_aux_util
|
|
|
|
|
|
- :ref:`Engine handlers reference`
|
|
- `Game object reference <openmw_core.html##(GameObject)>`_
|
|
- `Cell reference <openmw_core.html##(Cell)>`_
|
|
|
|
**API packages**
|
|
|
|
API packages provide functions that can be called by scripts. I.e. it is a script-to-engine interaction.
|
|
A package can be loaded with ``require('<package name>')``.
|
|
It can not be overloaded even if there is a lua file with the same name.
|
|
The list of available packages is different for global and for local scripts.
|
|
Player scripts are local scripts that are attached to a player.
|
|
|
|
+---------------------------------------------------------+--------------------+---------------------------------------------------------------+
|
|
| Package | Can be used | Description |
|
|
+=========================================================+====================+===============================================================+
|
|
|:ref:`openmw.interfaces <Script interfaces>` | everywhere | | Public interfaces of other scripts. |
|
|
+---------------------------------------------------------+--------------------+---------------------------------------------------------------+
|
|
|:ref:`openmw.util <Package openmw.util>` | everywhere | | Defines utility functions and classes like 3D vectors, |
|
|
| | | | that don't depend on the game world. |
|
|
+---------------------------------------------------------+--------------------+---------------------------------------------------------------+
|
|
|:ref:`openmw.settings <Package openmw.settings>` | everywhere | | Access to GMST records in content files (implemented) and |
|
|
| | | | to mod settings (not implemented). |
|
|
+---------------------------------------------------------+--------------------+---------------------------------------------------------------+
|
|
|:ref:`openmw.core <Package openmw.core>` | everywhere | | Functions that are common for both global and local scripts |
|
|
+---------------------------------------------------------+--------------------+---------------------------------------------------------------+
|
|
|:ref:`openmw.async <Package openmw.async>` | everywhere | | Timers (implemented) and coroutine utils (not implemented) |
|
|
+---------------------------------------------------------+--------------------+---------------------------------------------------------------+
|
|
|:ref:`openmw.query <Package openmw.query>` | everywhere | | Tools for constructing queries: base queries and fields. |
|
|
+---------------------------------------------------------+--------------------+---------------------------------------------------------------+
|
|
|:ref:`openmw.world <Package openmw.world>` | by global scripts | | Read-write access to the game world. |
|
|
+---------------------------------------------------------+--------------------+---------------------------------------------------------------+
|
|
|:ref:`openmw.self <Package openmw.self>` | by local scripts | | Full access to the object the script is attached to. |
|
|
+---------------------------------------------------------+--------------------+---------------------------------------------------------------+
|
|
|:ref:`openmw.nearby <Package openmw.nearby>` | by local scripts | | Read-only access to the nearest area of the game world. |
|
|
+---------------------------------------------------------+--------------------+---------------------------------------------------------------+
|
|
|:ref:`openmw.input <Package openmw.input>` | by player scripts | | User input |
|
|
+---------------------------------------------------------+--------------------+---------------------------------------------------------------+
|
|
|:ref:`openmw.ui <Package openmw.ui>` | by player scripts | | Controls user interface |
|
|
+---------------------------------------------------------+--------------------+---------------------------------------------------------------+
|
|
|openmw.camera | by player scripts | | Controls camera (not implemented) |
|
|
+---------------------------------------------------------+--------------------+---------------------------------------------------------------+
|
|
|
|
**openmw_aux**
|
|
|
|
``openmw_aux.*`` are built-in libraries that are itself implemented in Lua. They can not do anything that is not possible with the basic API, they only make it more convenient.
|
|
Sources can be found in ``resources/vfs/openmw_aux``. In theory mods can override them, but it is not recommended.
|
|
|
|
+---------------------------------------------------------+--------------------+---------------------------------------------------------------+
|
|
| Built-in library | Can be used | Description |
|
|
+=========================================================+====================+===============================================================+
|
|
|:ref:`openmw_aux.util <Package openmw_aux.util>` | everywhere | | Miscellaneous utils |
|
|
+---------------------------------------------------------+--------------------+---------------------------------------------------------------+
|
|
|