SplitTextComponent

Defined in: packages/renderer/src/SplitTextComponent.ts:109

Displays text split into per-character / per-word / per-line display objects, for animated and rich text — typewriter reveals, per-letter colour / wave, staggered line entrances. Wraps Pixi v8’s SplitText (canvas) / SplitBitmapText (bitmap); the segments are exposed as SplitTextComponent.chars, SplitTextComponent.words, and SplitTextComponent.lines for the game to animate directly.

For static or simple dynamic strings prefer TextComponent — a single display object is cheaper and SplitText re-layout on every text change is not free.

Pixi marks SplitText experimental; its char spacing can differ slightly from Text (browser kerning is lost once glyphs are split).

Experimental

This API should not be used in production and may be trimmed from a public release.

Extends

• Component

Constructors

Constructor

new SplitTextComponent(options): SplitTextComponent

Defined in: packages/renderer/src/SplitTextComponent.ts:124

Experimental

This API should not be used in production and may be trimmed from a public release.

Parameters

options

SplitTextComponentOptions

Returns

SplitTextComponent

Overrides

Component.constructor

Properties

enabled

enabled: boolean

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

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

Experimental

This API should not be used in production and may be trimmed from a public release.

Inherited from

Component.enabled

---

entity

entity: Entity

Defined in: packages/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.

Experimental

This API should not be used in production and may be trimmed from a public release.

Inherited from

Component.entity

---

isBitmap

readonly isBitmap: boolean

Defined in: packages/renderer/src/SplitTextComponent.ts:113

Whether this renders with a bitmap font (SplitBitmapText).

Experimental

This API should not be used in production and may be trimmed from a public release.

---

layerName

readonly layerName: string

Defined in: packages/renderer/src/SplitTextComponent.ts:114

Experimental

This API should not be used in production and may be trimmed from a public release.

---

splitText

readonly splitText: SplitText | SplitBitmapText

Defined in: packages/renderer/src/SplitTextComponent.ts:111

The underlying Pixi SplitText / SplitBitmapText container.

Experimental

This API should not be used in production and may be trimmed from a public release.

Accessors

alpha

Get Signature

get alpha(): number

Defined in: packages/renderer/src/SplitTextComponent.ts:253

Experimental

This API should not be used in production and may be trimmed from a public release.

Returns

number

Set Signature

set alpha(alpha): void

Defined in: packages/renderer/src/SplitTextComponent.ts:250

Opacity (0-1).

Experimental

This API should not be used in production and may be trimmed from a public release.

Parameters

alpha

number

Returns

void

---

charAnchor

Get Signature

get charAnchor(): SegmentAnchor

Defined in: packages/renderer/src/SplitTextComponent.ts:219

Experimental

This API should not be used in production and may be trimmed from a public release.

Returns

SegmentAnchor

Set Signature

set charAnchor(anchor): void

Defined in: packages/renderer/src/SplitTextComponent.ts:215

Transform origin for each character (normalized 0–1).

Experimental

This API should not be used in production and may be trimmed from a public release.

Parameters

anchor

SegmentAnchor

Returns

void

---

chars

Get Signature

get chars(): (Text | BitmapText)[]

Defined in: packages/renderer/src/SplitTextComponent.ts:175

Individual character segments (Text or BitmapText), in reading order.

Experimental

This API should not be used in production and may be trimmed from a public release.

Returns

(Text | BitmapText)[]

---

context

Get Signature

get context(): EngineContext

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

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

Experimental

This API should not be used in production and may be trimmed from a public release.

Returns

EngineContext

Inherited from

Component.context

---

lineAnchor

Get Signature

get lineAnchor(): SegmentAnchor

Defined in: packages/renderer/src/SplitTextComponent.ts:237

Experimental

This API should not be used in production and may be trimmed from a public release.

Returns

SegmentAnchor

Set Signature

set lineAnchor(anchor): void

Defined in: packages/renderer/src/SplitTextComponent.ts:233

Transform origin for each line (normalized 0–1).

Experimental

This API should not be used in production and may be trimmed from a public release.

Parameters

anchor

SegmentAnchor

Returns

void

---

lines

Get Signature

get lines(): Container<ContainerChild>[]

Defined in: packages/renderer/src/SplitTextComponent.ts:185

Line-group containers, each holding its word containers.

Experimental

This API should not be used in production and may be trimmed from a public release.

Returns

Container<ContainerChild>[]

---

renderObject

Get Signature

get renderObject(): Container

Defined in: packages/renderer/src/SplitTextComponent.ts:322

The underlying Pixi display object.

Experimental

This API should not be used in production and may be trimmed from a public release.

Returns

Container

---

scene

Get Signature

get scene(): Scene

Defined in: packages/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.

Experimental

This API should not be used in production and may be trimmed from a public release.

Returns

Scene

Inherited from

Component.scene

---

tint

Get Signature

get tint(): number

Defined in: packages/renderer/src/SplitTextComponent.ts:245

Experimental

This API should not be used in production and may be trimmed from a public release.

Returns

number

Set Signature

set tint(color): void

Defined in: packages/renderer/src/SplitTextComponent.ts:242

Tint color applied to the whole text (cascades to every segment).

Experimental

This API should not be used in production and may be trimmed from a public release.

Parameters

color

number

Returns

void

---

wordAnchor

Get Signature

get wordAnchor(): SegmentAnchor

Defined in: packages/renderer/src/SplitTextComponent.ts:228

Experimental

This API should not be used in production and may be trimmed from a public release.

Returns

SegmentAnchor

Set Signature

set wordAnchor(anchor): void

Defined in: packages/renderer/src/SplitTextComponent.ts:224

Transform origin for each word (normalized 0–1).

Experimental

This API should not be used in production and may be trimmed from a public release.

Parameters

anchor

SegmentAnchor

Returns

void

---

words

Get Signature

get words(): Container<ContainerChild>[]

Defined in: packages/renderer/src/SplitTextComponent.ts:180

Word-group containers, each holding its character segments.

Experimental

This API should not be used in production and may be trimmed from a public release.

Returns

Container<ContainerChild>[]

Methods

_runCleanups()

_runCleanups(): void

Defined in: packages/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: packages/core/dist/index.d.ts:1920

Register a cleanup function to run when this component is removed or destroyed.

Experimental

This API should not be used in production and may be trimmed from a public release.

Parameters

fn

() => void

Returns

void

Inherited from

Component.addCleanup

---

afterRestore()?

optional afterRestore(data, resolve): void

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

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

Experimental

This API should not be used in production and may be trimmed from a public release.

Parameters

data

unknown

resolve

SnapshotResolver

Returns

void

Inherited from

Component.afterRestore

---

fixedUpdate()?

optional fixedUpdate(dt): void

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

Called every fixed timestep by the built-in ComponentUpdateSystem.

Experimental

This API should not be used in production and may be trimmed from a public release.

Parameters

dt

number

Returns

void

Inherited from

Component.fixedUpdate

---

inspectRender()

inspectRender(): SplitTextRenderFacet

Defined in: packages/renderer/src/SplitTextComponent.ts:310

Derived render facet for the Inspector. Beyond the shared world-space bounds and container-level visible, this walks the per-character segments and reports glyphs (one { visible } per char in reading order) plus visibleText — the substring currently painted. This is the read-only window into a typewriter reveal: where serialize() reports the full declared string, visibleText reports only the glyphs whose chars[i].visible is still on. Not part of serialize(); see computeRenderFacet for the bounds coordinate space.

Note: Pixi’s chars array (and therefore glyphs / visibleText) contains only the rendered glyph segments — whitespace is laid out via words/lines and is NOT a char. So visibleText strips spaces: a fully revealed "Hello world" reports "Helloworld". Use it to compare which glyphs are on screen, not to reconstruct the original string verbatim.

Experimental

This API should not be used in production and may be trimmed from a public release.

Returns

SplitTextRenderFacet

---

listen()

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

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

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

Experimental

This API should not be used in production and may be trimmed from a public release.

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: packages/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).

Experimental

This API should not be used in production and may be trimmed from a public release.

Type Parameters

T

T

Parameters

token

EventToken<T>

handler

(data, entity?) => void

Returns

void

Inherited from

Component.listenScene

---

onAdd()

onAdd(): void

Defined in: packages/renderer/src/SplitTextComponent.ts:326

Called when the component is added to an entity.

Experimental

This API should not be used in production and may be trimmed from a public release.

Returns

void

Overrides

Component.onAdd

---

onDestroy()

onDestroy(): void

Defined in: packages/renderer/src/SplitTextComponent.ts:333

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

Experimental

This API should not be used in production and may be trimmed from a public release.

Returns

void

Overrides

Component.onDestroy

---

onRemove()?

optional onRemove(): void

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

Called when the component is removed from an entity.

Experimental

This API should not be used in production and may be trimmed from a public release.

Returns

void

Inherited from

Component.onRemove

---

resplit()

resplit(): void

Defined in: packages/renderer/src/SplitTextComponent.ts:210

Re-split now. Only needed when constructed with autoSplit: false — after mutating text / style, call this to apply the change in one pass.

Experimental

This API should not be used in production and may be trimmed from a public release.

Returns

void

---

serialize()

serialize(): SplitTextData

Defined in: packages/renderer/src/SplitTextComponent.ts:257

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

Experimental

This API should not be used in production and may be trimmed from a public release.

Returns

SplitTextData

Overrides

Component.serialize

---

service()

protected service<T>(key): T

Defined in: packages/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.

Experimental

This API should not be used in production and may be trimmed from a public release.

Type Parameters

T

T extends object

Parameters

key

ServiceKey<T>

Returns

T

Inherited from

Component.service

---

setStyle()

setStyle(style): void

Defined in: packages/renderer/src/SplitTextComponent.ts:195

Replace the text style (re-splits when autoSplit is on).

Experimental

This API should not be used in production and may be trimmed from a public release.

Parameters

style

TextStyleOptions

Returns

void

---

setText()

setText(value): void

Defined in: packages/renderer/src/SplitTextComponent.ts:190

Replace the displayed string (re-splits when autoSplit is on).

Experimental

This API should not be used in production and may be trimmed from a public release.

Parameters

value

string

Returns

void

---

sibling()

protected sibling<C>(cls): C

Defined in: packages/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.

Experimental

This API should not be used in production and may be trimmed from a public release.

Type Parameters

C

C extends Component

Parameters

cls

ComponentClass<C>

Returns

C

Inherited from

Component.sibling

---

update()?

optional update(dt): void

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

Called every frame by the built-in ComponentUpdateSystem.

Experimental

This API should not be used in production and may be trimmed from a public release.

Parameters

dt

number

Returns

void

Inherited from

Component.update

---

use()

protected use<T>(key): T

Defined in: packages/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.

Experimental

This API should not be used in production and may be trimmed from a public release.

Type Parameters

T

T

Parameters

key

ServiceKey<T>

Returns

T

Inherited from

Component.use

---

fromSnapshot()

static fromSnapshot(data): SplitTextComponent

Defined in: packages/renderer/src/SplitTextComponent.ts:277

Experimental

This API should not be used in production and may be trimmed from a public release.

Parameters

data

SplitTextData

Returns

SplitTextComponent