Archive/openmw
0
0
Fork 0
mirror of https://gitlab.com/OpenMW/openmw.git synced 2025-04-29 05:17:58 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions 48

[Lua] Update documentation

Browse source
This commit is contained in:
Petr Mikheev 2022-03-13 00:38:36 +01:00
parent 0f84bfde51
commit 9af49cfa68
6 changed files with 483 additions and 145 deletions
Download patch file Download diff file Expand all files Collapse all files

3
docs/source/reference/lua-scripting/api.rst
View file

@ -12,6 +12,7 @@ Lua API reference
openmw_util
openmw_storage
openmw_core
openmw_types
openmw_async
openmw_query
openmw_world
@ -56,6 +57,8 @@ Player scripts are local scripts that are attached to a player.
+---------------------------------------------------------+--------------------+---------------------------------------------------------------+
|:ref:`openmw.core <Package openmw.core>` | everywhere | | Functions that are common for both global and local scripts |
+---------------------------------------------------------+--------------------+---------------------------------------------------------------+
|:ref:`openmw.types <Package openmw.types>` | everywhere | | Functions for specific types of game objects. |
+---------------------------------------------------------+--------------------+---------------------------------------------------------------+
|: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. |

5
docs/source/reference/lua-scripting/openmw_types.rst Normal file
View file

@ -0,0 +1,5 @@
Package openmw.types
====================
.. raw:: html
:file: generated_html/openmw_types.html

2
docs/source/reference/lua-scripting/overview.rst
View file

@ -353,6 +353,8 @@ Player scripts are local scripts that are attached to a player.
+---------------------------------------------------------+--------------------+---------------------------------------------------------------+
|:ref:`openmw.core <Package openmw.core>` | everywhere | | Functions that are common for both global and local scripts |
+---------------------------------------------------------+--------------------+---------------------------------------------------------------+
|:ref:`openmw.types <Package openmw.types>` | everywhere | | Functions for specific types of game objects. |
+---------------------------------------------------------+--------------------+---------------------------------------------------------------+
|: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. |