mirror of
https://github.com/OpenMW/openmw.git
synced 2025-07-08 05:11:37 +00:00
Fix doc typos and add menu package to necessary lists
This commit is contained in:
parent
b9afd7245c
commit
94d782c4be
6 changed files with 15 additions and 3 deletions
|
@ -27,6 +27,7 @@ Lua API reference
|
||||||
openmw_camera
|
openmw_camera
|
||||||
openmw_postprocessing
|
openmw_postprocessing
|
||||||
openmw_debug
|
openmw_debug
|
||||||
|
openmw_menu
|
||||||
openmw_aux_calendar
|
openmw_aux_calendar
|
||||||
openmw_aux_util
|
openmw_aux_util
|
||||||
openmw_aux_time
|
openmw_aux_time
|
||||||
|
|
|
@ -9,6 +9,7 @@ Engine handler is a function defined by a script, that can be called by the engi
|
||||||
|
|
||||||
.. list-table::
|
.. list-table::
|
||||||
:widths: 20 80
|
:widths: 20 80
|
||||||
|
|
||||||
* - onInterfaceOverride(base)
|
* - onInterfaceOverride(base)
|
||||||
- | Called if the current script has an interface and overrides an interface
|
- | Called if the current script has an interface and overrides an interface
|
||||||
| (``base``) of another script.
|
| (``base``) of another script.
|
||||||
|
@ -87,6 +88,7 @@ Engine handler is a function defined by a script, that can be called by the engi
|
||||||
|
|
||||||
.. list-table::
|
.. list-table::
|
||||||
:widths: 20 80
|
:widths: 20 80
|
||||||
|
|
||||||
* - onFrame(dt)
|
* - onFrame(dt)
|
||||||
- | Called every frame (even if the game is paused) right after
|
- | Called every frame (even if the game is paused) right after
|
||||||
| processing user input. Use it only for latency-critical stuff
|
| processing user input. Use it only for latency-critical stuff
|
||||||
|
@ -131,6 +133,7 @@ Engine handler is a function defined by a script, that can be called by the engi
|
||||||
|
|
||||||
.. list-table::
|
.. list-table::
|
||||||
:widths: 20 80
|
:widths: 20 80
|
||||||
|
|
||||||
* - onKeyPress(key)
|
* - onKeyPress(key)
|
||||||
- | `Key <openmw_input.html##(KeyboardEvent)>`_ is pressed.
|
- | `Key <openmw_input.html##(KeyboardEvent)>`_ is pressed.
|
||||||
| Usage example:
|
| Usage example:
|
||||||
|
@ -142,6 +145,7 @@ Engine handler is a function defined by a script, that can be called by the engi
|
||||||
|
|
||||||
.. list-table::
|
.. list-table::
|
||||||
:widths: 20 80
|
:widths: 20 80
|
||||||
|
|
||||||
* - onStateChanged()
|
* - onStateChanged()
|
||||||
- | Called whenever the current game changes
|
- | Called whenever the current game changes
|
||||||
| (i. e. the result of `getState <openmw_menu.html##(getState)>`_ changes)
|
| (i. e. the result of `getState <openmw_menu.html##(getState)>`_ changes)
|
||||||
|
|
|
@ -4,4 +4,4 @@ Package openmw.menu
|
||||||
.. include:: version.rst
|
.. include:: version.rst
|
||||||
|
|
||||||
.. raw:: html
|
.. raw:: html
|
||||||
:file: generated_html/openmw_ambient.html
|
:file: generated_html/openmw_menu.html
|
||||||
|
|
|
@ -29,6 +29,8 @@
|
||||||
+------------------------------------------------------------+--------------------+---------------------------------------------------------------+
|
+------------------------------------------------------------+--------------------+---------------------------------------------------------------+
|
||||||
|:ref:`openmw.ui <Package openmw.ui>` | by player scripts | | Controls :ref:`user interface <User interface reference>`. |
|
|:ref:`openmw.ui <Package openmw.ui>` | by player scripts | | Controls :ref:`user interface <User interface reference>`. |
|
||||||
+------------------------------------------------------------+--------------------+---------------------------------------------------------------+
|
+------------------------------------------------------------+--------------------+---------------------------------------------------------------+
|
||||||
|
|:ref:`openmw.menu <Package openmw.menu>` | by menu scripts | | Main menu functionality, such as managing game saves |
|
||||||
|
+------------------------------------------------------------+--------------------+---------------------------------------------------------------+
|
||||||
|:ref:`openmw.camera <Package openmw.camera>` | by player scripts | | Controls camera. |
|
|:ref:`openmw.camera <Package openmw.camera>` | by player scripts | | Controls camera. |
|
||||||
+------------------------------------------------------------+--------------------+---------------------------------------------------------------+
|
+------------------------------------------------------------+--------------------+---------------------------------------------------------------+
|
||||||
|:ref:`openmw.postprocessing <Package openmw.postprocessing>`| by player scripts | | Controls post-process shaders. |
|
|:ref:`openmw.postprocessing <Package openmw.postprocessing>`| by player scripts | | Controls post-process shaders. |
|
||||||
|
|
|
@ -91,7 +91,7 @@ return {
|
||||||
registerPage = registerPage,
|
registerPage = registerPage,
|
||||||
---
|
---
|
||||||
-- @function [parent=#Settings] registerRenderer Register a renderer,
|
-- @function [parent=#Settings] registerRenderer Register a renderer,
|
||||||
-- only avaialable in menu scripts (DEPRECATED in player scripts)
|
-- only available in menu scripts (DEPRECATED in player scripts)
|
||||||
-- @param #string key
|
-- @param #string key
|
||||||
-- @param #function renderer A renderer function, receives setting's value,
|
-- @param #function renderer A renderer function, receives setting's value,
|
||||||
-- a function to change it and an argument from the setting options
|
-- a function to change it and an argument from the setting options
|
||||||
|
|
|
@ -9,6 +9,9 @@
|
||||||
-- @field [parent=#STATE] Running
|
-- @field [parent=#STATE] Running
|
||||||
-- @field [parent=#STATE] Ended
|
-- @field [parent=#STATE] Ended
|
||||||
|
|
||||||
|
---
|
||||||
|
-- All possible game states returned by @{#menu.getState}
|
||||||
|
-- @field [parent=#menu] #STATE STATE
|
||||||
|
|
||||||
---
|
---
|
||||||
-- Current game state
|
-- Current game state
|
||||||
|
@ -63,3 +66,5 @@
|
||||||
---
|
---
|
||||||
-- Exit the game
|
-- Exit the game
|
||||||
-- @function [parent=#menu] quit
|
-- @function [parent=#menu] quit
|
||||||
|
|
||||||
|
return nil
|
||||||
|
|
Loading…
Reference in a new issue