LoadingSceneProgressBar

Defined in: ui/src/LoadingSceneProgressBar.ts:61

Ready-made loading progress bar for use inside a LoadingScene.

Spawn it from the scene’s onEnter, then call this.startLoading() to kick off the load:

class Boot extends LoadingScene {
  readonly target = new GameScene();
  override onEnter() {
    this.spawn(LoadingSceneProgressBar);
    this.startLoading();
  }
}

Subscribes to scene:loading:progress internally and updates a UIProgressBar. For spinners, animated text, or other custom visuals, write your own component that subscribes to the same event.

Extends

Entity

Constructors

Constructor

new LoadingSceneProgressBar(name?, tags?): LoadingSceneProgressBar

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

Parameters

name?

string

tags?

Iterable<string, any, any>

Returns

LoadingSceneProgressBar

Inherited from

Entity.constructor

Properties

id

readonly id: number

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

Unique auto-incrementing ID.

Inherited from

Entity.id

name

readonly name: string

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

Display name for debugging.

Inherited from

Entity.name

[TRAITS_KEY]

static [TRAITS_KEY]: Set<symbol>

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

Inherited from

Entity.[TRAITS_KEY]

Accessors

children

Get Signature

get children(): ReadonlyMap<string, Entity>

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

Named children as a read-only map. Empty map if no children.

Returns

ReadonlyMap<string, Entity>

Inherited from

Entity.children

isDestroyed

Get Signature

get isDestroyed(): boolean

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

True if destroy() has been called.

Returns

boolean

Inherited from

Entity.isDestroyed

parent

Get Signature

get parent(): Entity | null

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

The parent entity, or null if this is a root entity.

Returns

Entity | null

Inherited from

Entity.parent

scene

Get Signature

get scene(): Scene

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

The scene this entity belongs to. Throws if the entity is not attached to a scene — which in practice only happens before scene.spawn / addChild wires it up, or after destroy() tears it down. Inside lifecycle methods (setup, component onAdd, update, etc.) this is always safe to access.

For the rare case where you genuinely need to inspect whether an entity has a scene (e.g. defensive code in systems iterating a query result), use tryScene instead.

Returns

Scene

Inherited from

Entity.scene

tryScene

Get Signature

get tryScene(): Scene | null

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

The scene this entity belongs to, or null if detached.

Returns

Scene | null

Inherited from

Entity.tryScene

Methods

_performDestroy()

_performDestroy(): void

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

Internal

Internal: perform actual destruction — remove all components and clear state. Called by Scene during endOfFrame flush.

Returns

void

Inherited from

Entity._performDestroy

_setScene()

_setScene(scene, callbacks): void

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

Internal

Internal: set the scene and callbacks. Called by Scene.spawn().

Parameters

scene

Scene | null

callbacks

EntityCallbacks | null

Returns

void

Inherited from

Entity._setScene

add()

add<C>(component): C

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

Add a component instance. Returns the component for chaining.

Type Parameters

C

C extends Component

Parameters

component

C

Returns

C

Inherited from

Entity.add

addChild()

addChild(name, child): void

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

Add a named child entity. Auto-adds to parent’s scene if not already in one.

Parameters

name

string

child

Entity

Returns

void

Inherited from

Entity.addChild

afterRestore()?

optional afterRestore(data, resolve): void

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

Called after components are restored during save/load. Rebuild non-serializable state here.

Parameters

data

unknown

resolve

SnapshotResolver

Returns

void

Inherited from

Entity.afterRestore

destroy()

destroy(): void

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

Mark for deferred destruction. Actual cleanup happens at end of frame.

Returns

void

Inherited from

Entity.destroy

emit()

Call Signature

emit(token): void

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

Emit a typed event on this entity. Bubbles to the scene.

Parameters

token

EventToken<void>

Returns

void

Inherited from

Entity.emit

Call Signature

emit<T>(token, data): void

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

Emit a typed event on this entity. Bubbles to the scene.

Type Parameters

T

T

Parameters

token

EventToken<T>

data

T

Returns

void

Inherited from

Entity.emit

get()

get<C>(cls): C

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

Get a component by class. Throws if not found.

Type Parameters

C

C extends Component

Parameters

cls

ComponentClass<C>

Returns

C

Inherited from

Entity.get

getAll()

getAll(): Iterable<Component>

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

Get all components as an iterable.

Returns

Iterable<Component>

Inherited from

Entity.getAll

getChild()

getChild(name): Entity

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

Get a child by name. Throws if not found.

Parameters

name

string

Returns

Entity

Inherited from

Entity.getChild

has()

has(cls): boolean

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

Check if entity has a component of the given class.

Parameters

cls

ComponentClass

Returns

boolean

Inherited from

Entity.has

hasTrait()

hasTrait<T>(token): this is LoadingSceneProgressBar & T

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

Check if this entity’s class implements a given trait. Acts as a type guard.

Type Parameters

T

T

Parameters

token

TraitToken<T>

Returns

this is LoadingSceneProgressBar & T

Inherited from

Entity.hasTrait

on()

on<T>(token, handler): () => void

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

Subscribe to a typed event on this entity. Returns an unsubscribe function.

Type Parameters

T

T

Parameters

token

EventToken<T>

handler

(data) => void

Returns

() => void

Inherited from

Entity.on

remove()

remove(cls): void

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

Remove a component by class.

Parameters

cls

ComponentClass

Returns

void

Inherited from

Entity.remove

removeChild()

removeChild(name): Entity

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

Remove a named child. Returns the detached entity.

Parameters

name

string

Returns

Entity

Inherited from

Entity.removeChild

serialize()?

optional serialize(): unknown

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

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

Returns

unknown

Inherited from

Entity.serialize

setup()

setup(opts?): void

Defined in: ui/src/LoadingSceneProgressBar.ts:62

Optional setup method. Called by scene.spawn(Class, params) after the entity is wired to its scene, so components can access services. Override in subclasses — do NOT use the constructor for component setup.

Parameters

opts?

LoadingSceneProgressBarOptions = {}

Returns

void

Overrides

Entity.setup

spawnChild()

Call Signature

spawnChild(name): Entity

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

Spawn a new entity in this entity’s scene and add it as a named child. Combines scene.spawn(...) + this.addChild(name, ...) in one call — the idiomatic way to compose entity trees (logical root + visual body

UI sibling + …).

Mirrors the overload shape of Scene.spawn: pass an Entity subclass (with optional setup params), a Blueprint, or omit for an anonymous base Entity.

this.spawnChild("body", EnemyBody, { color: 0xff6b6b });
this.spawnChild("hp", EnemyHealthBar);

Parameters

name

string

Returns

Entity

Inherited from

Entity.spawnChild

Call Signature

spawnChild<E>(name, Class): E

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

UI sibling + …).

Mirrors the overload shape of Scene.spawn: pass an Entity subclass (with optional setup params), a Blueprint, or omit for an anonymous base Entity.

this.spawnChild("body", EnemyBody, { color: 0xff6b6b });
this.spawnChild("hp", EnemyHealthBar);

Type Parameters

E

E extends Entity

Parameters

name

string

Class

() => E

Returns

E

Inherited from

Entity.spawnChild

Call Signature

spawnChild<E, P>(name, Class, params): E

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

UI sibling + …).

Mirrors the overload shape of Scene.spawn: pass an Entity subclass (with optional setup params), a Blueprint, or omit for an anonymous base Entity.

this.spawnChild("body", EnemyBody, { color: 0xff6b6b });
this.spawnChild("hp", EnemyHealthBar);

Type Parameters

E

E extends Entity

P

P

Parameters

name

string

Class

() => E & object

params

P

Returns

E

Inherited from

Entity.spawnChild

Call Signature

spawnChild<P>(name, blueprint, params): Entity

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

UI sibling + …).

Mirrors the overload shape of Scene.spawn: pass an Entity subclass (with optional setup params), a Blueprint, or omit for an anonymous base Entity.

this.spawnChild("body", EnemyBody, { color: 0xff6b6b });
this.spawnChild("hp", EnemyHealthBar);

Type Parameters

P

P

Parameters

name

string

blueprint

Blueprint<P>

params

P

Returns

Entity

Inherited from

Entity.spawnChild

Call Signature

spawnChild(name, blueprint): Entity

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

UI sibling + …).

Mirrors the overload shape of Scene.spawn: pass an Entity subclass (with optional setup params), a Blueprint, or omit for an anonymous base Entity.

this.spawnChild("body", EnemyBody, { color: 0xff6b6b });
this.spawnChild("hp", EnemyHealthBar);

Parameters

name

string

blueprint

Blueprint<void>

Returns

Entity

Inherited from

Entity.spawnChild

tryGet()

tryGet<C>(cls): C | undefined

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

Get a component by class, or undefined if not found.

Type Parameters

C

C extends Component

Parameters

cls

ComponentClass<C>

Returns

C | undefined

Inherited from

Entity.tryGet

tryGetChild()

tryGetChild(name): Entity | undefined

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

Get a child by name, or undefined if not found.

Parameters

name

string

Returns

Entity | undefined

Inherited from

Entity.tryGetChild