PixiCheckbox

Whether the wrapped widget answers the player. One that only displays a value keeps its view’s own event mode and stays out of navigation unless focusable asks for it.

Returns

boolean

Inherited from

PixiUIBase.interactive

pressed

Get Signature

get protected pressed(): boolean

Defined in: ui/src/pixi-ui/PixiUIBase.ts:217

Whether any device is holding the widget down: the pointer, a confirm press from a focus scope, or both.

Returns

boolean

Inherited from

PixiUIBase.pressed

rotation

Get Signature

get rotation(): number

Defined in: ui/src/UIElementBase.ts:50

See LayoutProps.rotation.

Returns

number

Set Signature

set rotation(value): void

Defined in: ui/src/UIElementBase.ts:54

Parameters

value

number

Returns

void

Inherited from

PixiUIBase.rotation

scale

Get Signature

get scale(): Readonly<{ x: number; y: number; }>

Defined in: ui/src/UIElementBase.ts:41

See LayoutProps.scale.

Returns

Readonly<{ x: number; y: number; }>

Set Signature

set scale(value): void

Defined in: ui/src/UIElementBase.ts:45

Parameters

value

number | { x: number; y: number; }

Returns

void

Inherited from

PixiUIBase.scale

transformOrigin

Get Signature

get transformOrigin(): Readonly<{ x: number; y: number; }>

Defined in: ui/src/UIElementBase.ts:32

See LayoutProps.transformOrigin.

Returns

Readonly<{ x: number; y: number; }>

Set Signature

set transformOrigin(value): void

Defined in: ui/src/UIElementBase.ts:36

Parameters

value

number | { x: number; y: number; }

Returns

void

Inherited from

PixiUIBase.transformOrigin

visible

Get Signature

get visible(): boolean

Defined in: ui/src/pixi-ui/PixiUIBase.ts:64

Returns

boolean

Set Signature

set visible(v): void

Defined in: ui/src/pixi-ui/PixiUIBase.ts:68

Parameters

v

boolean

Returns

void

Inherited from

PixiUIBase.visible

zIndex

Get Signature

get zIndex(): number

Defined in: ui/src/UIElementBase.ts:59

See LayoutProps.zIndex.

Returns

number

Set Signature

set zIndex(value): void

Defined in: ui/src/UIElementBase.ts:63

Parameters

value

number

Returns

void

Inherited from

PixiUIBase.zIndex

Methods

_inspectState()

_inspectState(): object

Defined in: ui/src/pixi-ui/PixiUIBase.ts:399

Internal

Returns

object

disabled

disabled: boolean

focusable

focusable: boolean

focused

focused: boolean

Inherited from

PixiUIBase._inspectState

activate()

activate(): void

Defined in: ui/src/pixi-ui/PixiCheckbox.ts:38

Toggle the box. checked routes through the widget’s own switch, which emits onCheck and so the bridged onChange; update({ checked }) keeps using forceCheck, the setter @pixi/ui documents as the silent one.

Returns

void

Overrides

PixiUIBase.activate

adjust()?

protected optional adjust(direction): boolean

Defined in: ui/src/pixi-ui/PixiUIBase.ts:249

Step the widget’s own value along direction, returning true only when the press was consumed. A stepper at its end returns false, so the press moves focus out of the widget.

Parameters

direction

FocusDirection

Returns

boolean

Inherited from

PixiUIBase.adjust

applyLayout()

applyLayout(): void

Defined in: ui/src/pixi-ui/PixiUIBase.ts:308

Returns

void

Inherited from

PixiUIBase.applyLayout

applyTransformProps()

protected applyTransformProps(props): void

Defined in: ui/src/UIElementBase.ts:27

Apply the four transform props present in props. A present key holding undefined resets that prop to its default. Throws before writing anything if a value is not finite.

Parameters

props

LayoutProps

Returns

void

Inherited from

PixiUIBase.applyTransformProps

bridgeSignal()

protected bridgeSignal<F>(signal, key, kind, newProps): void

Defined in: ui/src/pixi-ui/PixiUIBase.ts:317

Bridge a @pixi/ui Signal to a callback prop. Only reconnects if ref changed.

Type Parameters

F

F extends (…args) => void

Parameters

signal

connect

(cb) => void

disconnect

(cb) => void

key

string

kind

string

newProps

Record<string, unknown>

Returns

void

Inherited from

PixiUIBase.bridgeSignal

destroy()

destroy(): void

Defined in: ui/src/pixi-ui/PixiUIBase.ts:407

Returns

void

Inherited from

PixiUIBase.destroy

disconnectAll()

protected disconnectAll(): void

Defined in: ui/src/pixi-ui/PixiCheckbox.ts:56

Override in subclass to disconnect all signals on destroy.

Returns

void

Overrides

PixiUIBase.disconnectAll

disconnectBridgedSignal()

protected disconnectBridgedSignal<F>(signal, key): void

Defined in: ui/src/pixi-ui/PixiUIBase.ts:353

Type Parameters

F

F extends (…args) => void

Parameters

signal

disconnect

(cb) => void

key

string

Returns

void

Inherited from

PixiUIBase.disconnectBridgedSignal

focusOutlineBox()

protected focusOutlineBox(): UIFocusOutlineBox

Defined in: ui/src/pixi-ui/PixiUIBase.ts:281

The rectangle the focus outline is drawn around, in this element’s own space, which is measured in layout pixels.

A widget layout sizes is outlined around both its layout box and everything it draws, so a part reaching outside the box is inside the outline. A widget that keeps its own size is outlined around what it draws. A widget whose drawn extent moves with its value overrides this with a box that holds every value, so the outline stays still.

Returns

UIFocusOutlineBox

Inherited from

PixiUIBase.focusOutlineBox

fromViewSpace()

protected fromViewSpace(box): UIFocusOutlineBox

Defined in: ui/src/pixi-ui/PixiUIBase.ts:297

Map a rectangle from the widget view’s own space into this element’s.

Parameters

intrinsicSize()

protected intrinsicSize(): object

Defined in: ui/src/pixi-ui/PixiUIBase.ts:257

The size layout gives this widget when nothing constrains it. A composite that hides or reparents its parts — a dropdown lifting its open list out of this container — overrides this so the space it takes in the flow does not depend on which part is on screen.

Returns

object

height

height: number

width

width: number

Inherited from

PixiUIBase.intrinsicSize

invalidateSize()

protected invalidateSize(): void

Defined in: ui/src/pixi-ui/PixiUIBase.ts:373

Re-measure on the next layout pass. Yoga caches a measure function’s result, so a prop that changes the widget’s intrinsic size (its text, its item list) leaves the old size in the tree until the node is dirtied.

Returns

void

Inherited from

PixiUIBase.invalidateSize

setPressed()?

protected optional setPressed(pressed): void

Defined in: ui/src/pixi-ui/PixiUIBase.ts:242

Show the widget’s pressed face while a device holds it down, and its resting face once every device has let go. A widget with no pressed face leaves it out.

true arrives again where the widget has repainted itself under a press that is still held, so an implementation sets the face and never toggles it.

Parameters

pressed

boolean

Returns

void

Inherited from

PixiUIBase.setPressed

sizedByLayout()

protected sizedByLayout(): boolean

Defined in: ui/src/pixi-ui/PixiCheckbox.ts:29

A composite of an icon beside a label, so it keeps its own size.

Returns

boolean

Overrides

PixiUIBase.sizedByLayout

update()

update(props): void

Defined in: ui/src/pixi-ui/PixiCheckbox.ts:42

Parameters

props

Record<string, unknown>

Returns

void

Overrides

PixiUIBase.update

updateBase()

protected updateBase(props): void

Defined in: ui/src/pixi-ui/PixiUIBase.ts:378

Apply layout props, visible, and store prevProps. Call at end of subclass update().

Parameters

props

Record<string, unknown>

Returns

void

Inherited from

PixiUIBase.updateBase

Coding agents: fetch https://yage.dev/llms.txt first and prefer the Markdown references it links over these HTML pages. This page's Markdown counterpart is /llms/packages/ui.md.