UIText
Defined in: ui/src/UIText.ts:17
Lightweight wrapper around a PixiJS Text for use in UI panels.
Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new UIText(
props):UIText
Defined in: ui/src/UIText.ts:35
Parameters
Section titled “Parameters”Returns
Section titled “Returns”UIText
Properties
Section titled “Properties”displayObject
Section titled “displayObject”
readonlydisplayObject:DisplayContainer
Defined in: ui/src/UIText.ts:18
Implementation of
Section titled “Implementation of”yogaNode
Section titled “yogaNode”
readonlyyogaNode:Node
Defined in: ui/src/UIText.ts:19
Implementation of
Section titled “Implementation of”Accessors
Section titled “Accessors”visible
Section titled “visible”Get Signature
Section titled “Get Signature”get visible():
boolean
Defined in: ui/src/UIText.ts:139
Returns
Section titled “Returns”boolean
Set Signature
Section titled “Set Signature”set visible(
v):void
Defined in: ui/src/UIText.ts:143
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”Methods
Section titled “Methods”destroy()
Section titled “destroy()”destroy():
void
Defined in: ui/src/UIText.ts:198
Idempotent — a second call is a no-op.
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”mergeStyle()
Section titled “mergeStyle()”mergeStyle(
s):void
Defined in: ui/src/UIText.ts:135
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
Section titled “Parameters”Partial<TextStyle>
Returns
Section titled “Returns”void
setStyle()
Section titled “setStyle()”setStyle(
s):void
Defined in: ui/src/UIText.ts:119
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
Section titled “Parameters”Partial<TextStyle>
Returns
Section titled “Returns”void
setText()
Section titled “setText()”setText(
s?):void
Defined in: ui/src/UIText.ts:108
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
update()
Section titled “update()”update(
p):void
Defined in: ui/src/UIText.ts:148
Parameters
Section titled “Parameters”Partial<UITextProps>
Returns
Section titled “Returns”void