summaryrefslogtreecommitdiff
path: root/doc/lua_api.txt
diff options
context:
space:
mode:
authorv-rob <robinsonvincent89@gmail.com>2020-07-10 03:11:26 -0700
committerGitHub <noreply@github.com>2020-07-10 12:11:26 +0200
commitb1ff04e06da531dc52f6ee91e2967b39743033e6 (patch)
tree3d1af58d8c8003c5099122d0021b46d87c076c6f /doc/lua_api.txt
parent2384c10e104fd0c945f3677130e7d25c0a841482 (diff)
downloadminetest-b1ff04e06da531dc52f6ee91e2967b39743033e6.tar.gz
minetest-b1ff04e06da531dc52f6ee91e2967b39743033e6.tar.bz2
minetest-b1ff04e06da531dc52f6ee91e2967b39743033e6.zip
Formspec: Make dropdowns optionally return event based on index, not value (#9496)
Diffstat (limited to 'doc/lua_api.txt')
-rw-r--r--doc/lua_api.txt15
1 files changed, 12 insertions, 3 deletions
diff --git a/doc/lua_api.txt b/doc/lua_api.txt
index f2a83eca5..2ac4d6766 100644
--- a/doc/lua_api.txt
+++ b/doc/lua_api.txt
@@ -2443,7 +2443,7 @@ Elements
* `color` is color specified as a `ColorString`.
If the alpha component is left blank, the box will be semitransparent.
-### `dropdown[<X>,<Y>;<W>;<name>;<item 1>,<item 2>, ...,<item n>;<selected idx>]`
+### `dropdown[<X>,<Y>;<W>;<name>;<item 1>,<item 2>, ...,<item n>;<selected idx>;<index event>]`
* Show a dropdown field
* **Important note**: There are two different operation modes:
@@ -2454,8 +2454,12 @@ Elements
* Fieldname data is transferred to Lua
* Items to be shown in dropdown
* Index of currently selected dropdown item
+* `index event` (optional, allowed parameter since formspec version 4): Specifies the
+ event field value for selected items.
+ * `true`: Selected item index
+ * `false` (default): Selected item value
-### `dropdown[<X>,<Y>;<W>,<H>;<name>;<item 1>,<item 2>, ...,<item n>;<selected idx>]`
+### `dropdown[<X>,<Y>;<W>,<H>;<name>;<item 1>,<item 2>, ...,<item n>;<selected idx>;<index event>]`
* Show a dropdown field
* **Important note**: This syntax for dropdowns can only be used with the
@@ -2468,6 +2472,10 @@ Elements
* Fieldname data is transferred to Lua
* Items to be shown in dropdown
* Index of currently selected dropdown item
+* `index event` (optional, allowed parameter since formspec version 4): Specifies the
+ event field value for selected items.
+ * `true`: Selected item index
+ * `false` (default): Selected item value
### `checkbox[<X>,<Y>;<name>;<label>;<selected>]`
@@ -4491,7 +4499,8 @@ Call these functions only at load time!
* `button` and variants: If pressed, contains the user-facing button
text as value. If not pressed, is `nil`
* `field`, `textarea` and variants: Text in the field
- * `dropdown`: Text of selected item
+ * `dropdown`: Either the index or value, depending on the `index event`
+ dropdown argument.
* `tabheader`: Tab index, starting with `"1"` (only if tab changed)
* `checkbox`: `"true"` if checked, `"false"` if unchecked
* `textlist`: See `minetest.explode_textlist_event`