openmw/docs/source/reference/lua-scripting/api.rst

#################
Lua API reference
#################

.. toctree::
    :hidden:

    engine_handlers
    user_interface
    aipackages
    setting_renderers
    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.
Documentation for Lua scripting 2021-02-23 20:45:03 +00:00			`#################`
			`Lua API reference`
			`#################`

			`.. toctree::`
Integrate Lua doc into sphinx doc (issue #5931) 2021-04-24 22:55:08 +00:00			`:hidden:`
Documentation for Lua scripting 2021-02-23 20:45:03 +00:00
Integrate Lua doc into sphinx doc (issue #5931) 2021-04-24 22:55:08 +00:00			`engine_handlers`
Lua UI API 2021-11-18 15:19:54 +00:00			`user_interface`
Control AI packages from Lua 2022-01-23 19:49:42 +00:00			`aipackages`
Renderers 2022-05-24 19:11:13 +00:00			`setting_renderers`
Control AI packages from Lua 2022-01-23 19:49:42 +00:00			`events`
Integrate Lua doc into sphinx doc (issue #5931) 2021-04-24 22:55:08 +00:00			`openmw_util`
Permanent storage for Lua data 2021-12-13 23:39:01 +00:00			`openmw_storage`
Integrate Lua doc into sphinx doc (issue #5931) 2021-04-24 22:55:08 +00:00			`openmw_core`
[Lua] Update documentation 2022-03-12 23:38:36 +00:00			`openmw_types`
Integrate Lua doc into sphinx doc (issue #5931) 2021-04-24 22:55:08 +00:00			`openmw_async`
			`openmw_world`
			`openmw_self`
			`openmw_nearby`
Lua package 'openmw.input' 2021-06-26 21:10:24 +00:00			`openmw_input`
Integrate Lua doc into sphinx doc (issue #5931) 2021-04-24 22:55:08 +00:00			`openmw_ui`
Update Lua docs 2021-11-01 17:39:18 +00:00			`openmw_camera`
moddable post-processing pipeline 2022-05-14 01:58:00 +00:00			`openmw_postprocessing`
Support rendering for navmesh update frequency as a heatmap 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. 2022-02-03 01:05:43 +00:00			`openmw_debug`
Add calendar.lua 2022-01-10 20:04:07 +00:00			`openmw_aux_calendar`
Integrate Lua doc into sphinx doc (issue #5931) 2021-04-24 22:55:08 +00:00			`openmw_aux_util`
Change terminology of gameSecond/gameHour to simulationTime/gameTime 2021-12-01 20:28:05 +00:00			`openmw_aux_time`
MWUI interface (resolve https://gitlab.com/OpenMW/openmw/-/issues/6594) 2022-05-03 17:36:49 +00:00			`openmw_aux_ui`
Control AI packages from Lua 2022-01-23 19:49:42 +00:00			`interface_ai`
Update Lua docs 2021-11-01 17:39:18 +00:00			`interface_camera`
MWUI interface (resolve https://gitlab.com/OpenMW/openmw/-/issues/6594) 2022-05-03 17:36:49 +00:00			`interface_mwui`
Document Settings interface, add scripts to CMakeLists 2022-05-01 14:57:33 +00:00			`interface_settings`
Implement pairs and ipairs for ui.content and ui.layers. Document all iterable types in a uniform way. 2022-02-21 20:43:27 +00:00			`iterables`
Documentation for Lua scripting 2021-02-23 20:45:03 +00:00

Integrate Lua doc into sphinx doc (issue #5931) 2021-04-24 22:55:08 +00:00			- :ref:`Engine handlers reference`
Lua UI API 2021-11-18 15:19:54 +00:00			- :ref:`User interface reference <User interface reference>`
Integrate Lua doc into sphinx doc (issue #5931) 2021-04-24 22:55:08 +00:00			- `Game object reference <openmw_core.html##(GameObject)>`_
			- `Cell reference <openmw_core.html##(Cell)>`_
Control AI packages from Lua 2022-01-23 19:49:42 +00:00			- :ref:`Built-in AI packages`
			- :ref:`Built-in events`
Documentation for Lua scripting 2021-02-23 20:45:03 +00:00
Integrate Lua doc into sphinx doc (issue #5931) 2021-04-24 22:55:08 +00:00			`API packages`
Update OpenMW Lua documentation 2021-04-02 17:42:19 +00:00
			`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.`

Support rendering for navmesh update frequency as a heatmap 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. 2022-02-03 01:05:43 +00:00			`.. include:: tables/packages.rst`
Documentation for Lua scripting 2021-02-23 20:45:03 +00:00
Integrate Lua doc into sphinx doc (issue #5931) 2021-04-24 22:55:08 +00:00			`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.

Support rendering for navmesh update frequency as a heatmap 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. 2022-02-03 01:05:43 +00:00			`.. include:: tables/aux_packages.rst`
Update Lua docs 2021-11-01 17:39:18 +00:00
			`Interfaces of built-in scripts`

Document Settings interface, add scripts to CMakeLists 2022-05-01 14:57:33 +00:00			`.. list-table::`
			`:widths: 20 20 60`
Update Lua docs 2021-11-01 17:39:18 +00:00
Document Settings interface, add scripts to CMakeLists 2022-05-01 14:57:33 +00:00			`* - 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.`
Styling for Settings 2022-05-14 10:27:30 +00:00			* - :ref:`MWUI <Interface MWUI>`
			`- by player scripts`
			`- Morrowind-style UI templates.`