aboutsummaryrefslogtreecommitdiff
path: root/display_api/API.md
diff options
context:
space:
mode:
authorPierre-Yves Rollo <dev@pyrollo.com>2019-03-14 09:48:27 +0100
committerPierre-Yves Rollo <dev@pyrollo.com>2019-03-14 09:48:27 +0100
commit89fc7f863ddcf86eeeb129b65b0708f5bb6f4cb3 (patch)
tree92079ae9873843e6d85fcacb1ce762dca4e39668 /display_api/API.md
parent6162f49bc1f846f8cf46b0ad9e31327e1a373b56 (diff)
downloaddisplay_modpack_no_craft-89fc7f863ddcf86eeeb129b65b0708f5bb6f4cb3.tar.gz
display_modpack_no_craft-89fc7f863ddcf86eeeb129b65b0708f5bb6f4cb3.zip
Fixed API documentation (height replaced by top)
Diffstat (limited to 'display_api/API.md')
-rw-r--r--display_api/API.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/display_api/API.md b/display_api/API.md
index acfd867..2dfff21 100644
--- a/display_api/API.md
+++ b/display_api/API.md
@@ -47,9 +47,9 @@ This is a helper to register entities used for display.
### Display_entities fields
`on_display_update` is a callback in charge of setting up entity texture. If not set, entity will have no texture and will be displayed as unknown item.\
-`depth`, `right` and `height`: Entity position regarding to node facedir/wallmounted main axis.\
+`depth`, `right` and `top`: Entity position regarding to node facedir/wallmounted main axis.\
Values for these fields can be any number between -1.5 and 1.5 (default value is 0). Position 0,0,0 is the center of the node.\
-`depth` goes from front (-0.5) to rear (0.5), `height` goes from bottom (-0.5) to top (0.5) and `right` goes from left (-0.5) to right (0.5).\
+`depth` goes from front (-0.5) to rear (0.5), `top` goes from bottom (-0.5) to top (0.5) and `right` goes from left (-0.5) to right (0.5).\
`yaw`: Entity yaw in radians, regarding to main axis. Default is 0, aligned to node face.
In order to avoid flickering text, it's better to have text a little behind node surface. A good spacing value is given by `display_api.entity_spacing` variable.
@@ -80,7 +80,7 @@ In order to avoid flickering text, it's better to have text a little behind node
depth = 0.3,
on_display_update = my_display_update1 },
["mymod:entity1"] = {
- depth = 0.2, height = 0.1,
+ depth = 0.2, top = 0.1,
on_display_update = my_display_update2 },
},
...