UI HUD

UI HUD

ManifestBereitgestellt von UiCore

A group of HUD modules anchored to one corner of the screen. One entry is one corner, on purpose: a HUD is read at the edges, and an author who wants modules in three corners writes three entries rather than repeating a corner on every module. The runtime composes every entry a player can see into a single screen. This is not a menu. Nothing opens, the player is never locked, there is no cursor and no click. What it borrows from menus is everything else — the grid, the layers, the lists, the bindings, the visibility — so a module and a menu cell line up to the pixel.

Felder

Feld	Typ	Standard	Beschreibung
corner	UiGridAnchor	TOP_LEFT	Corner this group is measured from; offsets count inwards from it on both axesWerte:TOP_LEFTTOP_RIGHTBOTTOM_LEFTBOTTOM_RIGHT
layers	List<UiLayerConfig>?	—	Layers of this group, from back to front; they may carry lists like a menu's UiLayerConfig (4) Feld Typ Standard Beschreibung layerId String — Layer identifier, unique inside the view components List<UiComponentConfig> empty Components of this layer UiComponentConfig (33) Feld Typ Standard Beschreibung componentId String — Component identifier, unique inside the layer binding String — Placeholder this component takes its value from; leave empty for static content icon String — Material whose picture is drawn before the text, for instance DIAMOND_SWORD background String — Panel image painted behind this component instead of a flat colour, for instance slate capabilities List<UiCapabilityOption> empty Hard requirements on the rendering channel; a channel that cannot serve one is excludedWerte:INVENTORY_MANIPULATIONDEPTHTEXT_INPUT visibility UiVisibilityConfig — Gating applied before the component is composed placement UiPlacementConfig — Where the component sits palette UiPaletteOption? NONE Tint from the shader palette; NONE is not drawnWerte:NONEFRAMESURFACESURFACE_LIGHTMUTEDBLUEBLUE_LIGHTCYANTEALGREENGREEN_LIGHTYELLOWORANGERED_DARKREDPURPLEWHITEBLACKINKSLATESTEELSTEEL_LIGHTMISTPAPERFORESTMINTGOLDAMBERWINECORALVIOLET hoverPalette UiPaletteOption NONE Tint while the cursor rests on it; NONE keeps the idle tintWerte:NONEFRAMESURFACESURFACE_LIGHTMUTEDBLUEBLUE_LIGHTCYANTEALGREENGREEN_LIGHTYELLOWORANGERED_DARKREDPURPLEWHITEBLACKINKSLATESTEELSTEEL_LIGHTMISTPAPERFORESTMINTGOLDAMBERWINECORALVIOLET disabledPalette UiPaletteOption NONE Tint while its criteria do not match; NONE keeps the idle tintWerte:NONEFRAMESURFACESURFACE_LIGHTMUTEDBLUEBLUE_LIGHTCYANTEALGREENGREEN_LIGHTYELLOWORANGERED_DARKREDPURPLEWHITEBLACKINKSLATESTEELSTEEL_LIGHTMISTPAPERFORESTMINTGOLDAMBERWINECORALVIOLET label String — Shown while the cursor rests on it, beside the screenPlatzhalterFarben text String — Drawn across the component in the vanilla fontPlatzhalter textPalette UiPaletteOption NONE Tint of that text; NONE draws it whiteWerte:NONEFRAMESURFACESURFACE_LIGHTMUTEDBLUEBLUE_LIGHTCYANTEALGREENGREEN_LIGHTYELLOWORANGERED_DARKREDPURPLEWHITEBLACKINKSLATESTEELSTEEL_LIGHTMISTPAPERFORESTMINTGOLDAMBERWINECORALVIOLET textEffect UiTextEffect — —Werte:NONEOUTLINE_FINESHINEGRADIENTGLOWPULSERELIEFBRUSHEDEMBERFROSTWAVERAINBOW textAlign UiTextAlign? LEFT How that text sits inside the component tooltip String — Shown at the view's tooltip anchor while the cursor rests here; one line per newlinePlatzhalter criteria List<Criteria> empty Conditions that must all hold for this component to answer a click onLeftClick List<Ref<TriggerableEntry>> empty Triggered on left click onRightClick List<Ref<TriggerableEntry>> empty Triggered on right click input UiInputConfig? — Asks the player to type a value before the click takes effect navigateTo String? — Node this button opens; leave empty for a button that does not navigate gauge UiGaugeConfig? — Draws this component as a bar filled from a placeholder, instead of a flat cell backgroundBinding String — Placeholder naming WHICH panel image to paint, for instance a level glyph; empty keeps the fixed one paletteBinding String — Placeholder naming WHICH tint to draw this component in, for instance a health bar that turns to ice; empty keeps the fixed one backgroundSquare Boolean false Keep the panel image square instead of filling the cell, which a wide screen would stretch textOffset Int 0 Nudge the text sideways by this many interface pixels, to line up with what a cell cannot textHalfRowDown Boolean false Draw the text half a row lower, so two lines sit closer than a whole cell apart textOffsetY Int 0 Signed pixel nudge up or down, from where the text is centred; HUD modules only stack String — Pile this joins: members share a row and slide apart, one cell per bar that has a value lineIcon String — Material whose picture closes the line, drawn at text height; empty for none textBackdrop UiPaletteOption NONE Tint laid behind the text, cut to the text's own width; NONE draws no backdropWerte:NONEFRAMESURFACESURFACE_LIGHTMUTEDBLUEBLUE_LIGHTCYANTEALGREENGREEN_LIGHTYELLOWORANGERED_DARKREDPURPLEWHITEBLACKINKSLATESTEELSTEEL_LIGHTMISTPAPERFORESTMINTGOLDAMBERWINECORALVIOLET image String — Logical pack image fitted inside this component while preserving its aspect ratio imageBinding String — Placeholder naming a logical pack image; empty keeps the fixed image visibility UiVisibilityConfig — Gating applied before the layer is composed UiVisibilityConfig (2) Feld Typ Standard Beschreibung permission String — Permission required to see this element; leave empty for none conditions List<UiConditionConfig> empty Fact comparisons that must all hold repeats List<UiRepeatConfig>? — Windows over numbered sources: lists, pages and scrolling UiRepeatConfig (11) Feld Typ Standard Beschreibung repeatId String — Identifier of this list, unique inside the layer; also the key its offset is stored under source String — Binding prefix; item 3 reads <source>.3 and its picture <source>.3.icon column Int 0 Column the window starts at row Int 0 Row the window starts at width Int 1 Columns the window spans height Int 1 Rows the window spans stepMode UiStepMode PAGE PAGE turns a whole window per gesture, ITEM moves one itemWerte:ITEMPAGE template UiComponentConfig — What one item looks like; its id, binding and position are supplied per item selectable Boolean? — Items answer a click; what the click does belongs to whoever provided the list itemWidth Int? — Cells one item spans across; a name needs several, a map square wants one itemHeight Int? — Cells one item spans down
visibility	UiVisibilityConfig?	—	Gating applied before the whole group is drawn UiVisibilityConfig (2) Feld Typ Standard Beschreibung permission String — Permission required to see this element; leave empty for none conditions List<UiConditionConfig> empty Fact comparisons that must all hold UiConditionConfig (3) Feld Typ Standard Beschreibung fact String — Fact name; an unwritten fact reads as zero comparison UiComparison EQUALS How the fact is compared to the thresholdWerte:EQUALSNOT_EQUALSLESS_THANGREATER_THANAT_MOSTAT_LEAST threshold Int 0 Value the fact is compared against
priority	Int	0	Drawn over groups with a lower value when two overlap

How to use it

A HUD group is a set of layers that stays on screen. Choose a corner: placements are then offsets counted inwards from that corner (for CENTRE, signed coordinates about the centre, with an even width coming out centred). Reuse the same components as a view; give gauges a source such as btcui_health_percent. Use priority to order overlapping groups and visibility (permission or fact conditions) to gate a group. A HUD group has no cursor and does not freeze the player; it is hidden while a view, dialogue, cinematic or the world map is open.