mirror of
https://github.com/OpenMW/openmw.git
synced 2025-01-22 06:53:53 +00:00
215b46503c
Useful when need to find tiles with high number of updates. Add debug Lua package with new functions to toggle render mode and set navmesh render mode.
80 lines
2.2 KiB
ReStructuredText
80 lines
2.2 KiB
ReStructuredText
#################
|
|
Lua API reference
|
|
#################
|
|
|
|
.. toctree::
|
|
:hidden:
|
|
|
|
engine_handlers
|
|
user_interface
|
|
aipackages
|
|
events
|
|
openmw_util
|
|
openmw_storage
|
|
openmw_core
|
|
openmw_types
|
|
openmw_async
|
|
openmw_world
|
|
openmw_self
|
|
openmw_nearby
|
|
openmw_input
|
|
openmw_ui
|
|
openmw_camera
|
|
openmw_postprocessing
|
|
openmw_debug
|
|
openmw_aux_calendar
|
|
openmw_aux_util
|
|
openmw_aux_time
|
|
openmw_aux_ui
|
|
interface_ai
|
|
interface_camera
|
|
interface_mwui
|
|
interface_settings
|
|
iterables
|
|
|
|
|
|
- :ref:`Engine handlers reference`
|
|
- :ref:`User interface reference <User interface reference>`
|
|
- `Game object reference <openmw_core.html##(GameObject)>`_
|
|
- `Cell reference <openmw_core.html##(Cell)>`_
|
|
- :ref:`Built-in AI packages`
|
|
- :ref:`Built-in events`
|
|
|
|
**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.
|
|
|
|
.. include:: tables/packages.rst
|
|
|
|
**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.
|
|
|
|
.. include:: tables/aux_packages.rst
|
|
|
|
**Interfaces of built-in scripts**
|
|
|
|
.. list-table::
|
|
:widths: 20 20 60
|
|
|
|
* - Interface
|
|
- Can be used
|
|
- Description
|
|
* - :ref:`AI <Interface AI>`
|
|
- by local scripts
|
|
- Control basic AI of NPCs and creatures.
|
|
* - :ref:`Camera <Interface Camera>`
|
|
- by player scripts
|
|
- | Allows to alter behavior of the built-in camera script
|
|
| without overriding the script completely.
|
|
* - :ref:`Settings <Interface Settings>`
|
|
- by player and global scripts
|
|
- Save, display and track changes of setting values.
|
|
* - :ref:`MWUI <Interface MWUI>`
|
|
- by player scripts
|
|
- Morrowind-style UI templates.
|