Docs

UI Nodes

Docs Index

Purpose

UI nodes are data-only scene nodes based on UiBox. Use them to build panels, buttons, labels, layouts, grids, and tree lists that scripts can drive through signals and node data.

UI Nodes explains behavior, constraints, and practical usage so implementation decisions stay consistent across scripts and scenes.

API Source

Functions

signal_connect!signal_emit!with_node_mut!set_node_name!

Enums

UiAnchorUiSizeMode

Constants

UiBox: base UI type

Types

UiBoxNodeIDScriptContext

Usage Pattern

[play_button][UiButton]    size = (220, 48)    hover_signals = ["menu_button_hover"]    pressed_signals = ["play_down"]    click_signals = ["play_clicked"][/UiButton][/play_button]

Key Details

UiBox is the base type for all UI nodes.

UiButton emits named hover, pressed, released, and click signals plus custom signal lists.

UiTextBox and UiTextBlock emit hover, focus, and text_changed signals.

Layout fields support anchors, size modes, min/max clamps, padding, margin, alignment, and z order.