mirror/openmw
1
0
Fork 0
mirror of https://github.com/OpenMW/openmw.git synced 2025-02-02 00:45:33 +00:00
Code Issues Releases Wiki Activity

Document ui.registerSettingsPage

Browse source
This commit is contained in:
uramer 2022-02-01 19:26:05 +01:00
parent ef1e72dc17
commit 2185fd29c5
1 changed files with 12 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
files/lua_api/openmw/ui.lua
View file

@ -36,6 +36,11 @@
-- @param #Layout layout -- @param #Layout layout
-- @return #Element -- @return #Element
---
-- Adds a settings page to main menu setting's Scripts tab.
-- @function [parent=#ui] regregisterSettingsPageister
-- @param #SettingsPage page
--- ---
-- Layout -- Layout
-- @type Layout -- @type Layout
@ -137,4 +142,11 @@
-- @field openmw.util#Vector2 offset Position of the mouse cursor relative to the widget -- @field openmw.util#Vector2 offset Position of the mouse cursor relative to the widget
-- @field #number button Mouse button which triggered the event (could be nil) -- @field #number button Mouse button which triggered the event (could be nil)
---
-- Settings page parameters, passed as an argument to uyi.registerSettingsPage
-- @type SettingsPage
-- @field #string name Name of the page, displayed in the list, used for search
-- @field #string searchHints Additional keywords used in search, not displayed anywhere
-- @field #Element element The page's UI, which will be attached to the settings tab. The root widget has to have a fixed size (set `size` field in `props`, see Widget documentation, `relativeSize` is ignored)
return nil return nil