1
0
mirror of https://gitlab.com/OpenMW/openmw.git synced 2025-03-29 22:20:33 +00:00

Document packages available in menu scripts

This commit is contained in:
uramer 2024-01-08 21:14:44 +01:00
parent a3fd1b3d6f
commit 88049ffac6
4 changed files with 5 additions and 5 deletions

View File

@ -1,6 +1,6 @@
--- ---
-- `openmw.ambient` controls background sounds, specific to given player (2D-sounds). -- `openmw.ambient` controls background sounds, specific to given player (2D-sounds).
-- Can be used only by local scripts, that are attached to a player. -- Can be used only by menu scripts and local scripts, that are attached to a player.
-- @module ambient -- @module ambient
-- @usage local ambient = require('openmw.ambient') -- @usage local ambient = require('openmw.ambient')

View File

@ -1,6 +1,6 @@
--- ---
-- `openmw.core` defines functions and types that are available in both local -- `openmw.core` defines functions and types that are available in local,
-- and global scripts. -- global and menu scripts.
-- @module core -- @module core
-- @usage local core = require('openmw.core') -- @usage local core = require('openmw.core')

View File

@ -1,5 +1,5 @@
--- ---
-- `openmw.input` can be used only in scripts attached to a player. -- `openmw.input` can be used only in menu scripts and scripts attached to a player.
-- @module input -- @module input
-- @usage local input = require('openmw.input') -- @usage local input = require('openmw.input')

View File

@ -1,6 +1,6 @@
--- ---
-- `openmw.ui` controls user interface. -- `openmw.ui` controls user interface.
-- Can be used only by local scripts, that are attached to a player. -- Can be used only by menu scripts and local scripts, that are attached to a player.
-- @module ui -- @module ui
-- @usage -- @usage
-- local ui = require('openmw.ui') -- local ui = require('openmw.ui')