Skip to main content

Show a HUD

hexis.hud.panel replaces the current run's script panel. It accepts at most four sections and eight rows per section.

hexis.hud.panel({
sections = {
{
title = "Commissions",
rows = {
{
label = "Status",
value = "Mining",
icon = "minecraft:diamond_pickaxe",
},
{
label = "Progress",
value = "72%",
progress = 0.72,
},
},
},
},
})

Bounds

  • Section title: at most 28 characters.
  • Row label: at most 26 characters.
  • Row value: at most 32 characters.
  • Progress: clamped from 0 through 1.
  • Icon: optional namespaced item ID such as minecraft:writable_book.

Publish a new panel when the displayed state changes. Do not update it every render frame. Hexis renders the last immutable panel and clears it when the run stops.

A HUD belongs to screen space. In-world labels, outlines, and zones are a different presentation surface and are not public API 4 members at the current snapshot.

See Test Commissions for a composed HUD source.