78 lines
2.0 KiB
Markdown
78 lines
2.0 KiB
Markdown
# *hud* library
|
||
|
||
```lua
|
||
-- Open player inventory.
|
||
hud.open_inventory()
|
||
|
||
-- Close inventory.
|
||
hud.close_inventory()
|
||
|
||
-- Open UI and inventory.
|
||
-- Throws an exception if has UI layout does not exists.
|
||
-- If invid is not specified, a virtual (temporary) inventory is created.
|
||
-- Returns the invid or id of the virtual inventory.
|
||
hud.open(
|
||
-- UI layout name
|
||
layoutid: str,
|
||
-- Don't open player inventory
|
||
[optional] disablePlayerInventory: bool,
|
||
-- Inventory that UI layout will be bound to
|
||
[optional] invid: int
|
||
) -> int
|
||
|
||
-- Returns true if specified layout is open.
|
||
hud.is_open(
|
||
layoutid: str
|
||
) -> bool
|
||
|
||
|
||
-- Open block UI and inventory.
|
||
-- Throws an exception if block has no UI layout.
|
||
-- Returns block inventory ID (if *"inventory-size"=0* a virtual
|
||
-- inventory will be created), and UI layout ID.
|
||
hud.open_block(x: int, y: int, z: int) -> int, str
|
||
```
|
||
|
||
> [!NOTE]
|
||
> Only one block may be open at same time
|
||
|
||
```lua
|
||
-- Show overlay with layout specified.
|
||
-- Shows player inventory also if playerinv is true.
|
||
-- Using `args` you can specify an array of parameter values that will be passed
|
||
-- to on_open of the overlay being shown.
|
||
hud.show_overlay(layoutid: str, playerinv: bool, [optional] args: table)
|
||
|
||
-- Add element to the screen.
|
||
-- The element will be removed on world close only.
|
||
-- inventory element will be bound to the player inventory.
|
||
hud.open_permanent(layoutid: str)
|
||
|
||
-- Remove an element from the screen.
|
||
hud.close(layoutid: str)
|
||
|
||
-- Get open block inventory ID or 0.
|
||
hud.get_block_inventory() -> int
|
||
|
||
-- Gives the ID of the player that the UI is bound to.
|
||
hud.get_player() -> int
|
||
|
||
-- Opens the pause menu
|
||
hud.pause()
|
||
|
||
-- Closes the pause menu.
|
||
hud.resume()
|
||
|
||
-- Returns true if pause menu is open.
|
||
hud.is_paused() -> bool
|
||
|
||
-- Returns true if inventory is open or overlay is shown.
|
||
hud.is_inventory_open() -> bool
|
||
|
||
-- Sets whether to allow pausing. If false, the pause menu will not pause the game.
|
||
hud.set_allow_pause(flag: bool)
|
||
|
||
-- Function that controls the named skeleton 'hand' (see gfx.skeletons)
|
||
hud.hand_controller: function()
|
||
```
|