Renderers

docs/source/reference/lua-scripting/api.rst

@@ -8,6 +8,7 @@ Lua API reference
     engine_handlers
     user_interface
     aipackages
+    setting_renderers
     events
     openmw_util
     openmw_storage

docs/source/reference/lua-scripting/setting_renderers.rst

@@ -0,0 +1,126 @@
+Built-in Setting Renderers
+==========================
+
+textLine
+--------
+
+Single line text input
+
+**Argument**
+
+Table with the following optional fields:
+
+.. list-table::
+  :header-rows: 1
+  :widths: 20 20 60
+
+  * - name
+    - type (default)
+    - description
+  * - disabled
+    - bool (false)
+    - Disables changing the setting from the UI
+
+checkbox
+--------
+
+True / false (yes/no) toggle
+
+**Argument**
+
+Table with the following optional fields:
+
+.. list-table::
+  :header-rows: 1
+  :widths: 20 20 60
+
+  * - name
+    - type (default)
+    - description
+  * - disabled
+    - bool (false)
+    - Disables changing the setting from the UI
+  * - l10n
+    - string ('Interface')
+    - Localization context with display values for the true/false values
+  * - trueLabel
+    - string ('Yes')
+    - Localization key to display for the true value
+  * - falseLabel
+    - string ('No')
+    - Localization key to display for the false value
+
+number
+------
+
+Numeric input
+
+**Argument**
+
+Table with the following optional fields:
+
+.. list-table::
+  :header-rows: 1
+  :widths: 20 20 60
+
+  * - name
+    - type (default)
+    - description
+  * - disabled
+    - bool (false)
+    - Disables changing the setting from the UI
+  * - integer
+    - bool (false)
+    - Only allow integer values
+  * - min
+    - number (nil)
+    - If set, restricts setting values to numbers larger than min
+  * - max
+    - number (nil)
+    - If set, restricts setting values to numbers smaller than max
+
+select
+------
+
+A small selection box with two next / previous arrows on the sides
+
+**Argument**
+
+Table with the following optional fields:
+
+.. list-table::
+  :header-rows: 1
+  :widths: 20 20 60
+
+  * - name
+    - type (default)
+    - description
+  * - disabled
+    - bool (false)
+    - Disables changing the setting from the UI
+  * - l10n
+    - string (required)
+    - Localization context with display values for items
+  * - items
+    - #list<string> ({})
+    - List of options to choose from, all the viable values of the setting
+
+color
+-----
+
+Hex-code color input with a preview
+
+**Argument**
+
+Table with the following optional fields:
+
+.. list-table::
+  :header-rows: 1
+  :widths: 20 20 60
+
+  * - name
+    - type (default)
+    - description
+  * - disabled
+    - bool (false)
+    - Disables changing the setting from the UI