minetest
/
minetest
mirror of https://github.com/minetest/minetest.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Fix HUD image (waypoint) docs

This commit is contained in:
Lars Müller 2024-01-10 19:32:49 +01:00 committed by GitHub
parent 4bf95703a0
commit 7bae8ab838
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 14 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
doc/lua_api.md
View File

@ -1678,10 +1678,12 @@ type are ignored.
Displays an image on the HUD. Displays an image on the HUD.
* `scale`: The scale of the image, with 1 being the original texture size. * `scale`: The scale of the image, with `{x = 1, y = 1}` being the original texture size.
Only the X coordinate scale is used (positive values). The `x` and `y` fields apply to the respective axes.
Negative values represent that percentage of the screen it Positive values scale the source image.
should take; e.g. `x=-100` means 100% (width). Negative values represent percentages relative to screen dimensions.
Example: `{x = -20, y = 3}` means the image will be drawn 20% of screen width wide,
and 3 times as high as the source image is.
* `text`: The name of the texture that is displayed. * `text`: The name of the texture that is displayed.
* `alignment`: The alignment of the image. * `alignment`: The alignment of the image.
* `offset`: offset in pixels from position. * `offset`: offset in pixels from position.
@ -1748,10 +1750,12 @@ Displays distance to selected world position.
Same as `image`, but does not accept a `position`; the position is instead determined by `world_pos`, the world position of the waypoint. Same as `image`, but does not accept a `position`; the position is instead determined by `world_pos`, the world position of the waypoint.
* `scale`: The scale of the image, with 1 being the original texture size. * `scale`: The scale of the image, with `{x = 1, y = 1}` being the original texture size.
Only the X coordinate scale is used (positive values). The `x` and `y` fields apply to the respective axes.
Negative values represent that percentage of the screen it Positive values scale the source image.
should take; e.g. `x=-100` means 100% (width). Negative values represent percentages relative to screen dimensions.
Example: `{x = -20, y = 3}` means the image will be drawn 20% of screen width wide,
and 3 times as high as the source image is.
* `text`: The name of the texture that is displayed. * `text`: The name of the texture that is displayed.
* `alignment`: The alignment of the image. * `alignment`: The alignment of the image.
* `world_pos`: World position of the waypoint. * `world_pos`: World position of the waypoint.

3
games/devtest/mods/testhud/init.lua
View File

@ -152,7 +152,8 @@ minetest.register_chatcommand("hudwaypoints", {
type = "image_waypoint", type = "image_waypoint",
text = "testhud_waypoint.png", text = "testhud_waypoint.png",
world_pos = player:get_pos(), world_pos = player:get_pos(),
scale = {x = 3, y = 3}, -- 20% of screen width, 3x image height
scale = {x = -20, y = 3},
offset = {x = 0, y = -32} offset = {x = 0, y = -32}
} }
if not player_waypoints[name] then if not player_waypoints[name] then