From 88049ffac65f5e2308f57a5b4d57e70d8d0daefd Mon Sep 17 00:00:00 2001 From: uramer Date: Mon, 8 Jan 2024 21:14:44 +0100 Subject: [PATCH] Document packages available in menu scripts --- files/lua_api/openmw/ambient.lua | 2 +- files/lua_api/openmw/core.lua | 4 ++-- files/lua_api/openmw/input.lua | 2 +- files/lua_api/openmw/ui.lua | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/files/lua_api/openmw/ambient.lua b/files/lua_api/openmw/ambient.lua index 917ec86c85..9601ecc076 100644 --- a/files/lua_api/openmw/ambient.lua +++ b/files/lua_api/openmw/ambient.lua @@ -1,6 +1,6 @@ --- -- `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 -- @usage local ambient = require('openmw.ambient') diff --git a/files/lua_api/openmw/core.lua b/files/lua_api/openmw/core.lua index 890532fc13..a4d8ecee45 100644 --- a/files/lua_api/openmw/core.lua +++ b/files/lua_api/openmw/core.lua @@ -1,6 +1,6 @@ --- --- `openmw.core` defines functions and types that are available in both local --- and global scripts. +-- `openmw.core` defines functions and types that are available in local, +-- global and menu scripts. -- @module core -- @usage local core = require('openmw.core') diff --git a/files/lua_api/openmw/input.lua b/files/lua_api/openmw/input.lua index 0a85602bcc..a34bc040da 100644 --- a/files/lua_api/openmw/input.lua +++ b/files/lua_api/openmw/input.lua @@ -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 -- @usage local input = require('openmw.input') diff --git a/files/lua_api/openmw/ui.lua b/files/lua_api/openmw/ui.lua index 451f919077..8582996c4f 100644 --- a/files/lua_api/openmw/ui.lua +++ b/files/lua_api/openmw/ui.lua @@ -1,6 +1,6 @@ --- -- `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 -- @usage -- local ui = require('openmw.ui')