UIPanel

Defined in: ui/src/UIPanel.ts:344

Root UI panel component. Added to an entity via entity.add(new UIPanel({…})). Provides builder methods (.text(), .button(), .panel()) for constructing UI trees. Layout is driven by UILayoutSystem each frame.

Extends

Component

Constructors

Constructor

new UIPanel(opts?): UIPanel

Defined in: ui/src/UIPanel.ts:352

Parameters

opts?

UIPanelOptions

Returns

UIPanel

Overrides

Component.constructor

Properties

_anchor

readonly _anchor: Anchor | undefined

Defined in: ui/src/UIPanel.ts:346

Internal

_layer

readonly _layer: string | undefined

Defined in: ui/src/UIPanel.ts:348

Internal

_node

readonly _node: PanelNode

Defined in: ui/src/UIPanel.ts:345

Internal

_offset

readonly _offset: object

Defined in: ui/src/UIPanel.ts:347

Internal

x

x: number

y

y: number

_positioning

readonly _positioning: "anchor" | "transform"

Defined in: ui/src/UIPanel.ts:349

Internal

enabled

enabled: boolean

Defined in: core/dist/index.d.ts:1872

Whether this component is active. Disabled components are skipped by ComponentUpdateSystem.

Inherited from

Component.enabled

entity

entity: Entity

Defined in: core/dist/index.d.ts:1870

Back-reference to the owning entity. Set by the engine when the component is added to an entity. Do not set manually.

Inherited from

Component.entity

Accessors

container

Get Signature

get container(): Container

Defined in: ui/src/UIPanel.ts:363

The PixiJS Container for this panel.

Returns

Container

context

Get Signature

get context(): EngineContext

Defined in: core/dist/index.d.ts:1885

Access the EngineContext from the entity’s scene. Throws if the entity is not in a scene.

Returns

EngineContext

Inherited from

Component.context

scene

Get Signature

get scene(): Scene

Defined in: core/dist/index.d.ts:1880

Access the entity’s scene. Throws if the entity is not in a scene. Prefer this over threading through this.entity.scene in component code.

Returns

Scene

Inherited from

Component.scene

visible

Get Signature

get visible(): boolean

Defined in: ui/src/UIPanel.ts:423

Whether this panel is visible.

Returns

boolean

Set Signature

set visible(v): void

Defined in: ui/src/UIPanel.ts:427

Parameters

v

boolean

Returns

void

Methods

_runCleanups()

_runCleanups(): void

Defined in: core/dist/index.d.ts:1926

Internal

Run and clear all registered cleanups. Called by Entity.remove() and Entity._performDestroy() before onRemove/onDestroy.

Returns

void

Inherited from

Component._runCleanups

addCleanup()

protected addCleanup(fn): void

Defined in: core/dist/index.d.ts:1920

Parameters

fn

() => void

Returns

void

Inherited from

Component.addCleanup

addElement()

addElement(child): void

Defined in: ui/src/UIPanel.ts:405

Append an arbitrary UIElement (e.g. UIImage, UIProgressBar, UICheckbox) as the last child. Prefer the .text(), .button(), and .panel() builders for those element types — they’re shorter.

Parameters

child

UIElement

Returns

void

afterRestore()?

optional afterRestore(data, resolve): void

Defined in: core/dist/index.d.ts:1940

Called after onAdd() during save/load restoration. Apply state that depends on onAdd() having run.

Parameters

data

unknown

resolve

SnapshotResolver

Returns

void

Inherited from

Component.afterRestore

button()

button(label, opts): UIButton

Defined in: ui/src/UIPanel.ts:386

Add a button element.

Parameters

label

string

opts

Omit<UIButtonProps, "children">

Returns

UIButton

fixedUpdate()?

optional fixedUpdate(dt): void

Defined in: core/dist/index.d.ts:1936

Called every fixed timestep by the built-in ComponentUpdateSystem.

Parameters

dt

number

Returns

void

Inherited from

Component.fixedUpdate

insertElementBefore()

insertElementBefore(child, before): void

Defined in: ui/src/UIPanel.ts:418

Insert child immediately before before in this panel’s child list. Falls back to append if before isn’t a current child.

Parameters

child

UIElement

before

UIElement

Returns

void

listen()

protected listen<T>(entity, token, handler): void

Defined in: core/dist/index.d.ts:1912

Subscribe to events on any entity, auto-unsubscribe on removal.

Type Parameters

T

T

Parameters

entity

Entity

token

EventToken<T>

handler

(data) => void

Returns

void

Inherited from

Component.listen

listenScene()

protected listenScene<T>(token, handler): void

Defined in: core/dist/index.d.ts:1918

Subscribe to scene-level events, auto-unsubscribe on removal. Handlers fire for bubbled entity events (entity = source) and scene.emit events (entity = undefined).

Type Parameters

T

T

Parameters

token

EventToken<T>

handler

(data, entity?) => void

Returns

void

Inherited from

Component.listenScene

onAdd()

onAdd(): void

Defined in: ui/src/UIPanel.ts:431

Called when the component is added to an entity.

Returns

void

Overrides

Component.onAdd

onDestroy()

onDestroy(): void

Defined in: ui/src/UIPanel.ts:462

Called when the component is destroyed (entity destroyed or component removed).

Returns

void

Overrides

Component.onDestroy

onRemove()?

optional onRemove(): void

Defined in: core/dist/index.d.ts:1930

Called when the component is removed from an entity.

Returns

void

Inherited from

Component.onRemove

panel()

panel(opts?): PanelNode

Defined in: ui/src/UIPanel.ts:391

Add a nested child panel.

Parameters

opts?

PanelProps

Returns

PanelNode

removeElement()

removeElement(child): void

Defined in: ui/src/UIPanel.ts:410

Remove a previously added element. No-op if the element isn’t a child.

Parameters

child

UIElement

Returns

void

scrollView()

scrollView(opts?): ScrollViewNode

Defined in: ui/src/UIPanel.ts:396

Add a nested scrollable viewport.

Parameters

opts?

ScrollViewProps

Returns

ScrollViewNode

serialize()

serialize(): UIPanelOptions

Defined in: ui/src/UIPanel.ts:467

Return a JSON-serializable snapshot of this component’s state. Used by the save system.

Returns

UIPanelOptions

Overrides

Component.serialize

service()

protected service<T>(key): T

Defined in: core/dist/index.d.ts:1902

Lazy proxy-based service resolution. Can be used at field-declaration time:

readonly input = this.service(InputManagerKey);

The actual resolution is deferred until first property access.

Type Parameters

T

T extends object

Parameters

key

ServiceKey<T>

Returns

T

Inherited from

Component.service

setPointerHandlers()

setPointerHandlers(handlers): void

Defined in: ui/src/UIPanel.ts:376

Set this panel’s pointer / hover handlers (onHover, onPointerOver, onPointerOut) after construction — forwarded to the underlying node. (update() can’t double as the prop setter here: on a Component it’s the per-frame lifecycle hook the engine calls.) Like the element update, a present key replaces that handler and an absent key leaves it intact, so a partial setPointerHandlers({ onHover }) won’t drop the others. Handy for wiring attachTooltip: panel.setPointerHandlers({ onHover: tip.setActive }).

Parameters

handlers

PointerEventProps

Returns

void

sibling()

protected sibling<C>(cls): C

Defined in: core/dist/index.d.ts:1910

Lazy proxy-based sibling component resolution. Can be used at field-declaration time:

readonly anim = this.sibling(AnimatedSpriteComponent);

The actual resolution is deferred until first property access.

Type Parameters

C

C extends Component

Parameters

cls

ComponentClass<C>

Returns

C

Inherited from

Component.sibling

text()

text(content, style?): UIText

Defined in: ui/src/UIPanel.ts:381

Add a text element.

Parameters

content

string

style?

Partial<TextStyleOptions>

Returns

UIText

update()?

optional update(dt): void

Defined in: core/dist/index.d.ts:1934

Called every frame by the built-in ComponentUpdateSystem.

Parameters

dt

number

Returns

void

Inherited from

Component.update

use()

protected use<T>(key): T

Defined in: core/dist/index.d.ts:1893

Resolve a service by key, cached after first lookup. Scene-scoped values (registered via scene._registerScoped) take precedence over engine scope. A key declared with scope: "scene" that falls back to engine scope emits a one-shot dev warning — almost always signals a missed beforeEnter hook.

Type Parameters

T

T

Parameters

key

ServiceKey<T>

Returns

T

Inherited from

Component.use

fromSnapshot()

static fromSnapshot(data): UIPanel

Defined in: ui/src/UIPanel.ts:471

Parameters

data

UIPanelOptions

Returns

UIPanel