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

Document Settings interface, add scripts to CMakeLists

Browse source
This commit is contained in:
uramer 2022-05-01 16:57:33 +02:00
parent 1b62dda9f6
commit cd3535cd63
7 changed files with 171 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -27,6 +27,7 @@ Lua API reference
interface_ai
interface_camera
interface_mwui
interface_settings
iterables
@ -94,12 +95,19 @@ Sources can be found in ``resources/vfs/openmw_aux``. In theory mods can overrid
**Interfaces of built-in scripts**
+---------------------------------------------------------+--------------------+---------------------------------------------------------------+
| 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. |
+---------------------------------------------------------+--------------------+---------------------------------------------------------------+
.. 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.

6
docs/source/reference/lua-scripting/interface_settings.rst Normal file
View file

@ -0,0 +1,6 @@
Interface Settings
==================
.. raw:: html
:file: generated_html/scripts_omw_settings_player.html

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

@ -460,15 +460,22 @@ The order in which the scripts are started is important. So if one mod should ov
**Interfaces of built-in scripts**
+---------------------------------------------------------+--------------------+---------------------------------------------------------------+
| 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. |
+---------------------------------------------------------+--------------------+---------------------------------------------------------------+
.. 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.
Event system
============