summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorSmallJoker <mk939@ymail.com>2019-09-10 21:18:42 +0200
committerSmallJoker <mk939@ymail.com>2019-09-14 19:43:08 +0200
commit9acd36bf9981cf9cb8e82785508d6eb7f010cc77 (patch)
tree6f0fae04efa009e8fd0a13dd0ab613c8010ae764 /doc
parentb0baa698a495cc990ce5d9c22763957f1138aed3 (diff)
downloadminetest-9acd36bf9981cf9cb8e82785508d6eb7f010cc77.tar.gz
minetest-9acd36bf9981cf9cb8e82785508d6eb7f010cc77.tar.bz2
minetest-9acd36bf9981cf9cb8e82785508d6eb7f010cc77.zip
Formspecs: Introduce formspec_version to mods
Diffstat (limited to 'doc')
-rw-r--r--doc/lua_api.txt14
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/lua_api.txt b/doc/lua_api.txt
index 7fae20603..b809e18c3 100644
--- a/doc/lua_api.txt
+++ b/doc/lua_api.txt
@@ -1959,6 +1959,15 @@ Examples
Elements
--------
+### `formspec_version[<version>]`
+
+* Set the formspec version to a certain number. If not specified,
+ version 1 is assumed.
+* Must be specified before `size` element.
+* Clients older than this version can neither show newer elements nor display
+ elements with new arguments correctly.
+* Available since feature `formspec_version_element`.
+
### `size[<W>,<H>,<fixed_size>]`
* Define the size of the menu in inventory slots
@@ -1995,6 +2004,7 @@ Elements
### `real_coordinates[<bool>]`
+* INFORMATION: Enable it automatically using `formspec_version` version 2 or newer.
* When set to true, all following formspec elements will use the new coordinate system.
* If used immediately after `size`, `position`, `anchor`, and `no_prepend` elements
(if present), the form size will use the new coordinate system.
@@ -2114,6 +2124,7 @@ Elements
image shall be sized 8 times 16px times 4 times 16px
* If `auto_clip` is `true`, the background is clipped to the formspec size
(`x` and `y` are used as offset values, `w` and `h` are ignored)
+* Available since formspec version 2
### `pwdfield[<X>,<Y>;<W>,<H>;<name>;<label>]`
@@ -3788,6 +3799,8 @@ Utilities
-- Specifies whether binary data can be uploaded or downloaded using
-- the HTTP API (5.1.0)
httpfetch_binary_data = true,
+ -- Whether formspec_version[<version>] may be used (5.1.0)
+ formspec_version_element = true,
}
* `minetest.has_feature(arg)`: returns `boolean, missing_features`
@@ -3807,6 +3820,7 @@ Utilities
avg_jitter = 0.03, -- average packet time jitter
connection_uptime = 200, -- seconds since client connected
protocol_version = 32, -- protocol version used by client
+ formspec_version = 2, -- supported formspec version
-- following information is available on debug build only!!!
-- DO NOT USE IN MODS
--ser_vers = 26, -- serialization version used by client