UIText

Defined in: ui/src/UIText.ts:24

Lightweight wrapper around a PixiJS Text for use in UI panels.

Extends

• UIElementBase

Constructors

Constructor

new UIText(props): UIText

Defined in: ui/src/UIText.ts:58

Parameters

props

UITextProps

Returns

UIText

Overrides

UIElementBase.constructor

Properties

_transform

readonly _transform: ElementTransform

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

Internal

Inherited from

UIElementBase._transform

---

displayObject

readonly displayObject: DisplayContainer

Defined in: ui/src/UIText.ts:25

Overrides

UIElementBase.displayObject

---

yogaNode

readonly yogaNode: Node

Defined in: ui/src/UIText.ts:26

Overrides

UIElementBase.yogaNode

Accessors

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

UIElementBase.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

UIElementBase.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

UIElementBase.transformOrigin

---

visible

Get Signature

get visible(): boolean

Defined in: ui/src/UIText.ts:229

Returns

boolean

Set Signature

set visible(v): void

Defined in: ui/src/UIText.ts:233

Parameters

v

boolean

Returns

void

Overrides

UIElementBase.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

UIElementBase.zIndex

Methods

_inspectState()

_inspectState(): object

Defined in: ui/src/UIText.ts:311

Internal

What the Inspector reports for this label: whether it takes part in focus navigation, which is off unless the game asked for it, and whether it holds focus right now. A test reads this instead of a screenshot.

Returns

object

focusable

focusable: boolean

focused

focused: boolean

---

applyLayout()

applyLayout(): void

Defined in: ui/src/UIText.ts:174

Wrap — or truncate — a text Yoga laid out without measuring. Yoga calls a measure function only when an axis is left to measure, and that callback is the only other place word wrap is switched on and the truncated string is built. Both axes pinned leaves nothing to measure, and so does one pinned axis with the other filled by the default stretch alignment, which is what a plain panel does. Without this such a text renders one long unbroken line, and a truncating one renders its whole source past the slot edge.

Runs only when the computed width moved, because truncation binary-searches the text width and Pixi re-measures the block on every style write.

Returns

void

---

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

UIElementBase.applyTransformProps

---

destroy()

destroy(): void

Defined in: ui/src/UIText.ts:316

Idempotent — a second call is a no-op.

Returns

void

Overrides

UIElementBase.destroy

---

mergeStyle()

mergeStyle(s): void

Defined in: ui/src/UIText.ts:225

Patch the current style: merge s over the properties already set (construction or a prior setStyle/mergeStyle) and re-apply. Unlike setStyle, properties you don’t pass are preserved — handy for an imperative recolour (mergeStyle({ fill })) that keeps the font, size, weight, etc.

Parameters

s

Partial<TextStyle>

Returns

void

---

setStyle()

setStyle(s): void

Defined in: ui/src/UIText.ts:206

Replace the text style. Unset properties fall back to the engine + UI defaults (then Pixi’s), so this is a full replace, not a patch — to change a few properties while keeping the rest, use mergeStyle.

Parameters

s

Partial<TextStyle>

Returns

void

---

setText()

setText(s?): void

Defined in: ui/src/UIText.ts:153

Parameters

s?

string

Returns

void

---

update()

update(p): void

Defined in: ui/src/UIText.ts:238

Parameters

p

Partial<UITextProps>

Returns

void

Overrides

UIElementBase.update