Skip to content

UiToolbar

The UiToolbar class renders the bottom HUD toolbar containing inventory items (weapons/utilities) and building placement buttons. It delegates to UiToolbarItem for inventory items and UiToolbarBuilding for buildings.

UiToolbar private

Extends UiComponent.

Properties

NameTypeDescription
uiUiCurrent Ui instance. Inherited from UiComponent.
componentElemHTMLElementThe root #hud-toolbar DOM element. Inherited from UiComponent.
inventoryElemHTMLElementThe .hud-toolbar-inventory container for item buttons.
buildingsElemHTMLElementThe .hud-toolbar-buildings container for building buttons.
toolbarInventoryRecord<string, UiToolbarItem>Map of item IDs to their UiToolbarItem instances.
toolbarBuildingsRecord<string, UiToolbarBuilding>Map of building IDs to their UiToolbarBuilding instances.

Methods

constructor()

ts
function constructor(ui: Ui): void

Creates UiToolbarItem instances for all items with onToolbar set in the schema, and UiToolbarBuilding instances for all buildings in the building schema. Binds equipOrUseItem, startPlacingBuilding, and placeBuilding event listeners.

onTriggerEquipOrUseItem()

ts
function onTriggerEquipOrUseItem(itemId: string, itemTier: number): void

Sends an EquipItem RPC and emits itemEquippedOrUsed on the Ui instance.

onStartPlacingBuilding()

ts
function onStartPlacingBuilding(buildingId: string): void

Cancels all active overlays (BuildingOverlay.stopWatching(), SpellOverlay.cancelCasting()) and starts placement via PlacementOverlay.startPlacing().

onPlaceBuilding()

ts
function onPlaceBuilding(): void

Delegates to PlacementOverlay.placeBuilding().