aboutsummaryrefslogtreecommitdiff
path: root/doc/client_lua_api.txt
diff options
context:
space:
mode:
authorElias Fleckenstein <eliasfleckenstein@web.de>2020-11-28 20:13:20 +0100
committerElias Fleckenstein <eliasfleckenstein@web.de>2020-11-28 20:13:20 +0100
commit5bead7daaf1782ecb142a57ac57bd8ba405ba150 (patch)
tree0b45d1b643ff4f44d3e8e9949e00f06c93811531 /doc/client_lua_api.txt
parentf825cf0e35966869fe22ae0629a1c7256160add4 (diff)
downloaddragonfireclient-5bead7daaf1782ecb142a57ac57bd8ba405ba150.tar.xz
Added minetest.close_formspec
Diffstat (limited to 'doc/client_lua_api.txt')
-rw-r--r--doc/client_lua_api.txt8
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/client_lua_api.txt b/doc/client_lua_api.txt
index f14b8eceb..9ce553ca1 100644
--- a/doc/client_lua_api.txt
+++ b/doc/client_lua_api.txt
@@ -1107,6 +1107,14 @@ Passed to `HTTPApiTable.fetch` callback. Returned by
* Reference to the camera object. See [`Camera`](#camera) class reference for methods.
* `minetest.show_formspec(formname, formspec)` : returns true on success
* Shows a formspec to the player
+* `minetest.close_formspec(formname)`
+ * `formname`: has to exactly match the one given in `show_formspec`, or the
+ formspec will not close.
+ * calling `show_formspec(formname, "")` is equal to this
+ expression.
+ * to close a formspec regardless of the formname, call
+ `minetest.close_formspec("")`.
+ **USE THIS ONLY WHEN ABSOLUTELY NECESSARY!**
* `minetest.display_chat_message(message)` returns true on success
* Shows a chat message to the current player.