Scene

Defined in: Scene.ts:27

Scenes own entities and define lifecycle hooks. Each scene is a self-contained world with its own entity pool.

Extended by

• LoadingScene

Constructors

Constructor

new Scene(): Scene

Returns

Scene

Properties

defaultTransition?

readonly optional defaultTransition?: SceneTransition

Defined in: Scene.ts:41

Default transition used when this scene is the destination of a push/pop/replace.

---

name

abstract readonly name: string

Defined in: Scene.ts:29

Name for debugging/inspection.

---

pauseBelow

readonly pauseBelow: boolean = true

Defined in: Scene.ts:32

Whether scenes below this one in the stack should be paused. Default: true.

---

paused

paused: boolean = false

Defined in: Scene.ts:44

Manual pause flag. Set by game code to pause this scene regardless of stack position.

---

preload?

readonly optional preload?: readonly AssetHandle<unknown>[]

Defined in: Scene.ts:38

Asset handles to load before onEnter(). Override in subclasses.

---

timeScale

timeScale: number = 1

Defined in: Scene.ts:47

Time scale multiplier for this scene. 1.0 = normal, 0.5 = half speed. Default: 1.

---

transparentBelow

readonly transparentBelow: boolean = false

Defined in: Scene.ts:35

Whether scenes below this one should still render. Default: false.

Accessors

assets

Get Signature

get assets(): AssetManager

Defined in: Scene.ts:87

Convenience accessor for the AssetManager.

Returns

AssetManager

---

context

Get Signature

get context(): EngineContext

Defined in: Scene.ts:62

Access the EngineContext.

Returns

EngineContext

---

isPaused

Get Signature

get isPaused(): boolean

Defined in: Scene.ts:67

Whether this scene is effectively paused (manual pause or paused by stack).

Returns

boolean

---

isTransitioning

Get Signature

get isTransitioning(): boolean

Defined in: Scene.ts:81

Whether a scene transition is currently running.

Returns

boolean

Methods

_addExistingEntity()

_addExistingEntity(entity): void

Defined in: Scene.ts:166

Internal

Add an existing entity to this scene (used by Entity.addChild for auto-scene-membership).

Parameters

entity

Entity

Returns

void

---

_clearScopedServices()

_clearScopedServices(): void

Defined in: Scene.ts:306

Internal

Clear all scene-scoped services. Called by the SceneManager after afterExit hooks run, so plugin cleanup code still sees scoped state.

Returns

void

---

_destroyAllEntities()

_destroyAllEntities(): void

Defined in: Scene.ts:357

Internal

Destroy all entities — used during scene exit.

Returns

void

---

_flushDestroyQueue()

_flushDestroyQueue(): void

Defined in: Scene.ts:343

Internal

Flush the destroy queue — destroy pending entities. Called by the engine during the endOfFrame phase.

Returns

void

---

_onEntityEvent()

_onEntityEvent(eventName, data, entity): void

Defined in: Scene.ts:248

Internal

Called by Entity.emit() for bubbling entity events to the scene.

Parameters

eventName

string

data

unknown

entity

Entity

Returns

void

---

_queueDestroy()

_queueDestroy(entity): void

Defined in: Scene.ts:186

Internal

Add an entity to the destroy queue. Called by Entity.destroy().

Parameters

entity

Entity

Returns

void

---

_registerScoped()

_registerScoped<T>(key, value): void

Defined in: Scene.ts:288

Internal

Register a scene-scoped service. Called from a plugin’s beforeEnter hook to make per-scene state (render tree, physics world) resolvable via Component.use(key).

Type Parameters

T

T

Parameters

key

ServiceKey<T>

value

T

Returns

void

---

_resolveScoped()

_resolveScoped<T>(key): T | undefined

Defined in: Scene.ts:297

Internal

Resolve a scene-scoped service, or undefined if none was registered.

Type Parameters

T

T

Parameters

key

ServiceKey<T>

Returns

T | undefined

---

_setContext()

_setContext(context): void

Defined in: Scene.ts:314

Internal

Set the engine context. Called by SceneManager when the scene is pushed.

Parameters

context

EngineContext

Returns

void

---

afterRestore()?

optional afterRestore(data, resolve): void

Defined in: Scene.ts:278

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

Parameters

data

unknown

resolve

SnapshotResolver

Returns

void

---

destroyEntity()

destroyEntity(entity): void

Defined in: Scene.ts:178

Mark an entity for destruction. Deferred to endOfFrame flush.

Parameters

entity

Entity

Returns

void

---

findEntities()

Call Signature

findEntities<T>(filter): Entity & T[]

Defined in: Scene.ts:213

Find entities matching a filter. Trait filter narrows the return type.

Type Parameters

T

T

Parameters

filter

EntityFilter & object

Returns

Entity & T[]

Call Signature

findEntities(filter?): Entity[]

Defined in: Scene.ts:214

Find entities matching a filter. Trait filter narrows the return type.

Parameters

filter?

EntityFilter

Returns

Entity[]

---

findEntitiesByTag()

findEntitiesByTag(tag): Entity[]

Defined in: Scene.ts:204

Find entities by tag.

Parameters

tag

string

Returns

Entity[]

---

findEntity()

findEntity(name): Entity | undefined

Defined in: Scene.ts:196

Find entity by name (first match).

Parameters

name

string

Returns

Entity | undefined

---

getEntities()

getEntities(): ReadonlySet<Entity>

Defined in: Scene.ts:191

Get all active entities.

Returns

ReadonlySet<Entity>

---

on()

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

Defined in: Scene.ts:227

Subscribe to bubbled entity events at the scene level. Handler receives (data, emittingEntity).

Type Parameters

T

T

Parameters

token

EventToken<T>

handler

(data, entity) => void

Returns

() => void

---

onEnter()?

optional onEnter(): void

Defined in: Scene.ts:263

Called when the scene is entered (after preload completes).

Returns

void

---

onExit()?

optional onExit(): void

Defined in: Scene.ts:266

Called when the scene is exited (popped or replaced).

Returns

void

---

onPause()?

optional onPause(): void

Defined in: Scene.ts:269

Called when a scene is pushed on top of this one.

Returns

void

---

onProgress()?

optional onProgress(ratio): void

Defined in: Scene.ts:260

Called during asset preloading with progress ratio (0→1).

Parameters

ratio

number

Returns

void

---

onResume()?

optional onResume(): void

Defined in: Scene.ts:272

Called when the scene above is popped, restoring this scene.

Returns

void

---

serialize()?

optional serialize(): unknown

Defined in: Scene.ts:275

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

Returns

unknown

---

service()

protected service<T>(key): T

Defined in: Scene.ts:98

Lazy proxy-based service resolution. Can be used at field-declaration time:

readonly layers = this.service(RenderLayerManagerKey);

The actual resolution is deferred until first property access.

Type Parameters

T

T extends object

Parameters

key

ServiceKey<T>

Returns

T

---

spawn()

Call Signature

spawn(name?): Entity

Defined in: Scene.ts:117

Spawn a new entity in this scene.

Parameters

name?

string

Returns

Entity

Call Signature

spawn<P>(blueprint, params): Entity

Defined in: Scene.ts:118

Spawn a new entity in this scene.

Type Parameters

P

P

Parameters

blueprint

Blueprint<P>

params

P

Returns

Entity

Call Signature

spawn(blueprint): Entity

Defined in: Scene.ts:119

Spawn a new entity in this scene.

Parameters

blueprint

Blueprint<void>

Returns

Entity

Call Signature

spawn<E, P>(Class, params): E

Defined in: Scene.ts:121

Spawn an entity subclass with setup params.

Type Parameters

E

E extends Entity

P

P

Parameters

Class

() => E & object

params

P

Returns

E

Call Signature

spawn<E>(Class): E

Defined in: Scene.ts:126

Spawn an entity subclass without setup params.

Type Parameters

E

E extends Entity

Parameters

Class

() => E

Returns

E