summaryrefslogtreecommitdiff
path: root/doc/lua_api.txt
diff options
context:
space:
mode:
authorHugues Ross <hugues.ross@gmail.com>2020-02-15 10:33:18 -0500
committerGitHub <noreply@github.com>2020-02-15 15:33:18 +0000
commit7ce21788f86d489d6dc08d9b2d3f6e3f8495b64e (patch)
treeb3388dad101a3b6b4edee239a21bdc662071faca /doc/lua_api.txt
parentee7d35760242824fd6b00a6ab1d9a2e6e5873d2c (diff)
downloadminetest-7ce21788f86d489d6dc08d9b2d3f6e3f8495b64e.tar.gz
minetest-7ce21788f86d489d6dc08d9b2d3f6e3f8495b64e.tar.bz2
minetest-7ce21788f86d489d6dc08d9b2d3f6e3f8495b64e.zip
Add animated_image[] formspec element (#9258)
Diffstat (limited to 'doc/lua_api.txt')
-rw-r--r--doc/lua_api.txt11
1 files changed, 11 insertions, 0 deletions
diff --git a/doc/lua_api.txt b/doc/lua_api.txt
index 75a083bdd..fe5b1a626 100644
--- a/doc/lua_api.txt
+++ b/doc/lua_api.txt
@@ -2133,6 +2133,15 @@ Elements
* Show an image
+### `animated_image[<X>,<Y>;<W>,<H>;<texture name>:<frame count>,<frame duration>]`
+
+* Show an animated image. The image is drawn like a "vertical_frames" tile
+ animation (See Tile animation definition), but uses a frame count/duration
+ for simplicity
+* `<texture name>` is the image to use
+* `<frame count>` is the number of frames animating the image
+* `<frame duration>` is in milliseconds
+
### `item_image[<X>,<Y>;<W>,<H>;<item name>]`
* Show an inventory image of registered item/node
@@ -2580,6 +2589,8 @@ Some types may inherit styles from parent types.
### Valid Properties
+* animated_image
+ * noclip - boolean, set to true to allow the element to exceed formspec bounds.
* box
* noclip - boolean, set to true to allow the element to exceed formspec bounds.
* Default to false in formspec_version version 3 or higher