UI reference

The components that set up a screen, the icon set asset, the bases for your own HUD panels and windows, the presenters that read units for them, and the theme, icon and tooltip API. For how to use it, see UI.

VtUiRoot

Component. Add it with Add Component → Vantage → UI → VtUiRoot. Adds UIDocument automatically.

The root of a screen’s UI: six layers in a fixed order on the UI Document, so nameplates stay under the HUD, windows over it, menus over windows, dialogs and toasts over menus, and the tooltip in front of everything, whichever order components add themselves in. Every layer fills the screen and ignores the pointer itself, so clicks between panels reach the game.

Scripting API

VtUiNavigation

Component. Add it with Add Component → Vantage → UI → VtUiNavigation.

The stack of open screens: windows, menus and dialogs. Push a screen to open it on top, and the Cancel input, Esc or the gamepad’s east button, pops the top one, so every window closes the same way. While anything is open the player’s gameplay input is held, so a key that opens a bag does not also cast, and focus moves to the screen that just opened and back to the one below when it closes.

Inspector fields

Scripting API

VtTooltipHost

Component. Add it with Add Component → Vantage → UI → VtTooltipHost.

Puts the screen’s one VtTooltip on the tooltip layer of the VtUiRoot and hands it to VtTooltips.Host, so every element attached with VtTooltips.Attach shows its tooltip there. Add it next to the root; without it tooltips are silently off.

Inspector fields

Scripting API

VtMapArea

Component. Add it with Add Component → Vantage → UI → VtMapArea.

A stretch of ground a minimap can draw, read through VtMinimapPresenter: its size on the XZ plane around this object, the picture of it and the name the minimap shows while the player is inside.

Inspector fields

General

Capture

Scripting API

VtMapMarker

Component. Add it with Add Component → Vantage → UI → VtMapMarker.

Puts an icon on the minimap at this object, read through VtMinimapPresenter: a vendor, a dungeon entrance, a waypoint. On a unit it replaces the unit’s dot.

Inspector fields

Scripting API

VtIconSet

Asset. Create it with Create → Vantage → UI → Icon Set.

The icons the UI refers to by id. The package ships one with the Lucide glyphs that its own components use; VtIcons looks ids up there. Make your own set for extra icons and install it with VtIcons.Install; set fallback to the shipped set, or leave it empty, and ids your set lacks still resolve through the shipped one.

Inspector fields

Scripting API

VtHudPanel

Abstract component base.

Base of every HUD controller: builds its element once, puts it in a region of the VtUiRoot on the same object, or the scene’s root, and builds it again when the UI Document rebuilds its root. Subclasses build in Build and refresh in Refresh, which runs every frame while the panel is shown.

Inspector fields

Scripting API

VtWindowPanel

Abstract component base.

Base of every window controller: builds a VtWindow once on a layer of the VtUiRoot, opens and closes it through the VtUiNavigation when the scene has one, so Esc and the gamepad close it and gameplay input is held while it is open, and refreshes it every frame while it is open. Subclasses fill the window in BuildContent and update it in Refresh.

Inspector fields

Scripting API

VtUnitFramePresenter

Class.

Reads a unit into a VtUnitFrameState: name, level, death, every pool, the active buffs folded by definition, and the cast or channel in progress. Bind it to a unit once and read every frame. No UI types, so any view can draw it.

Scripting API

VtResourceBarPresenter

Class.

Reads one amount of a unit into a VtResourceBarState: a pool with its name and numbers, the experience with the level and the numbers or “Max level”, or the cast in progress with the ability and the seconds left. Bind it to a unit once and read every frame. No UI types, so any view can draw it.

Scripting API

VtXpPresenter

Static class.

Reads a unit’s level and experience into a VtXpState. A unit without a VtUnitLevel reads as its definition’s level with no experience.

Scripting API

VtActionBarPresenter

Class.

Reads a unit’s VtAbilityHotkeys into a list of VtActionSlotState: the ability, its key, the cooldown with the global cooldown folded in, whether it is affordable and whether it is being aimed. Bind once, read every frame; the list is reused.

Scripting API

VtStatListPresenter

Static class.

Reads the rows of a stat list off a unit’s modifiers and formats their values. No UI types, so any view can draw them.

Scripting API

VtInventoryPresenter

Class.

Reads a unit’s bag into a VtInventoryState: every entry with its count and durability, whether the unit can put it on and why not, whether it can be used, and the wallet in sort order. Bind it to a unit once and read every frame. No UI types, so any view can draw it.

Scripting API

VtEquipmentPresenter

Class.

Reads a unit’s worn gear into a VtEquipmentState: every slot with the item in it and its durability, and every set the unit wears a piece of with the pieces worn and the tier that is active. Bind it to a unit once and read every frame. No UI types, so any view can draw it.

Scripting API

VtQuestLogPresenter

Class.

Reads a unit’s VtUnitQuestLog into a VtQuestLogState: the quests grouped by where they stand, their time limits and repeat cooldowns, and each objective’s line and progress. Bind it to a unit once and read whenever the panel refreshes. No UI types, so any view can draw it.

Scripting API

VtDialoguePresenter

Class.

Reads a unit’s VtUnitDialogue into a VtDialogueState: the speaker, the line, the answers with their kind and whether they are locked, and whether the line continues or ends the conversation. Bind it to a unit once and read whenever the window refreshes. No UI types, so any view can draw it.

Scripting API

VtCraftingPresenter

Class.

Reads a unit into a VtCraftingState: its crafting skills with level and experience, the recipes it knows plus the ones the window is configured with, every recipe’s ingredients against what it carries, why a recipe cannot be crafted, the craft in progress and the station it stands at. Bind it to a unit once and read every frame. No UI types, so any view can draw it.

Scripting API

VtTalentPresenter

Class.

Reads a unit into a VtTalentState: its level, the talent and attribute points it has left, every attribute the tree allows with its total and whether a point may go in, and every talent with its rank, what it needs and why it cannot be learned. Bind it to a unit once and read every frame. No UI types, so any view can draw it.

Scripting API

VtBuildPresenter

Class.

The reading side of a build menu: reads a unit into a VtBuildState with the category tabs, the pieces in the chosen category, whether each can be built and why not, every cost line against the unit’s cost source, and the piece being placed. Select starts placing a piece. Bind it to a unit once and read every frame. No UI types, so any view can draw it.

Scripting API

VtSelectionPresenter

Class.

Reads a VtUnitSelection and its VtControlGroups into a VtSelectionState: the selected units with their health and which one is the primary, and the control groups with their sizes and whether the selection is in them. Bind it once and read every frame. No UI types, so any view can draw it.

Scripting API

VtThreatPresenter

Class.

Reads the threat table a player wants to see into a VtThreatState: the table of the unit the viewer has selected, or else of the unit it is fighting, with every attacker sorted from highest threat to lowest and each row’s share of the top. Bind it to the viewer once and read every frame. No UI types, so any view can draw it.

Scripting API

VtInteractionPresenter

Class.

Finds the nearest thing a player can right-click — a quest giver, a vendor, a crafting station, a dropped item or a resource node — and describes it for the interaction prompt. Looking for them is a scene scan, so it happens on demand through Rescan; Read only measures the units found last time, which is cheap enough for every frame.

Scripting API

VtMinimapPresenter

Class.

Reads what a minimap shows around a unit into a VtMinimapState: the map area it stands in, itself, the units around it by their relation to it, quest givers with something for it, the places and people its active quests send it to, and the VtMapMarkers in the scene. Units and markers in the fog of war show by their own rule. No UI types, so any view can draw it.

Scripting API

VtTooltipContent

Class.

What a tooltip shows, with no UI types: a title, a subtitle, label and value rows and free lines. VtItemTooltip and VtAbilityTooltip build one from a definition; a tooltip element draws it. Reuse an instance with Clear to avoid allocations.

Scripting API

VtAbilityTooltip

Static class.

Builds the tooltip of an ability: its name, how it targets, the cost, cast time, cooldown, range and area, what its effects do, such as “Damage 40 – 55 Fire” or “Applies Burning”, and its description. No UI types; a tooltip element draws the result.

Scripting API

VtItemTooltip

Static class.

Builds the tooltip of an item: its name, rarity and slot, every stat and attribute bonus, the set it belongs to with the pieces worn, its requirements marked when the viewer does not meet them, what using it does, its value and its description. No UI types; a tooltip element draws the result.

Scripting API

VtBuffTooltip

Static class.

Builds the tooltip of a buff on a unit: its name, the stacks, the time left, every stat and attribute it changes, what it does each tick, and its description. No UI types; a tooltip element draws the result.

Scripting API

VtTooltips

Static class.

The one tooltip a screen shows, and the wiring that puts it up. Give Host the VtTooltip sitting on the tooltip layer, then hand any element a source of content with Attach: the tooltip follows the pointer and the focus, so a player on a gamepad reads the same text as a player on a mouse.

Scripting API

VtTheme

Static class.

Switches the Vantage theme at runtime. Each option is a class on the element you pass, normally UIDocument.rootVisualElement, and the Vantage theme style sheet redefines the --vt- colour, radius and font variables for that class, so everything under the element follows.

Scripting API

VtUiStates

Static class.

The state classes every Vantage component and every panel of your own shares, so one rule in the theme styles selected and disabled-looking elements wherever they appear: chips, rows, buttons and list entries.

Scripting API

VtIcons

Static class.

Where VtIcon and every Vantage component look an icon id up. The shipped Resources/VtIconSet holds the Lucide glyphs the package uses. Install puts your own VtIconSet in front of it: ids it has win, ids it lacks fall through to the shipped set, so you can replace one glyph or add a hundred without copying the rest.

Scripting API

VtUiLayouts

Static class.

Default layouts for panels built on VtHudPanel, one UXML file each under any Resources/VtLayouts folder. A panel clones its layout and finds its parts by name, so a layout of your own with the same names, set on the panel’s Layout field, changes how the panel is arranged without any code.

Scripting API

VtIconEntry

Serializable class.

One icon in a VtIconSet: an id and the image drawn for it.

Inspector fields

Enums

VtUiLayer

The layers of a screen, from the back to the front.

VtUiRegion

A place on the HUD layer for panels that just need a corner or an edge.

VtMapMarkerTint

Which colour a VtMapMarker takes on the minimap.

VtMapMarkerReveal

When a VtMapMarker shows through the fog of war.

VtBarSource

What a resource bar reads from its unit.

VtResourceKind

The kind of a resource pool on a unit, such as health, mana, stamina or rage. A unit definition lists the pools it has; read one with VtUnitStats.GetPool.

VtProgressKind

The colour of a VtProgressBar’s fill.

VtStatFormat

How a stat list prints a value.

VtEquipmentSlot

The set of equipment slots an item can occupy on a unit. Used as the key for the slot map on VtUnitEquipment and as the source-id suffix when equipped items push their modifiers / attributes / traits ("equipment_<slot>").

VtBuildFailureReason

Why a builder call was refused or a placement is invalid.

VtTooltipLineKind

How a tooltip line reads.

VtTargetingMode

How an VtAbilityDefinition picks its target.

VtDamageType

The element of an attack — routed through the corresponding resistX stat on VtCoreStats in VtUnitStats.TakeDamage.

VtTooltipPlacement

Where a tooltip goes relative to the element it explains.

VtThemeMode

Light or dark colours.

VtThemeAccent

The colour of the accent, used for primary buttons, selected states and progress.

VtThemeRadius

Corner radius of cards and controls.