Class KaylaScene

Hierarchy (View Summary)

KaylaScene
- KaylaScene

Index

Constructors

Methods

getLayers getFibers getEntities getScene getGame getOrCreateLayer getSortedLayers setLayerVisible handleDraw drawHandler attachTo spawn getRoot createFiber detach tickHandler

Constructors

constructor

new KaylaScene(scene: LeaSceneII): KaylaInternals.KaylaScene
Parameters
- scene: LeaSceneII
Returns KaylaInternals.KaylaScene
- Defined in src/kayla-internals.ts:2278

Methods

getLayers

getLayers(): Map<string, KaylaLayerInfo>
Returns Map<string, KaylaLayerInfo>
- Defined in src/kayla-internals.ts:2287

getFibers

getFibers(): KaylaFiber<{}, Record<string, KaylaExportables>>[]
Exposes all the dangerous fibers.

Returns KaylaFiber<{}, Record<string, KaylaExportables>>[]
- Defined in src/kayla-internals.ts:2296

getEntities

getEntities(): KaylaRectEntity[]
Exposes all the entities dangerously.

Returns KaylaRectEntity[]
- Defined in src/kayla-internals.ts:2303

getScene

getScene(): LeaSceneII
Returns the underlying LEA scene instance.

Returns LeaSceneII
- Defined in src/kayla-internals.ts:2310

getGame

getGame(): KaylaInternals.KaylaGame
Exposes the game object.

Returns KaylaInternals.KaylaGame
- Defined in src/kayla-internals.ts:2317

getOrCreateLayer

getOrCreateLayer(name: string, defaultZ?: number): KaylaLayerInfo
Parameters
- name: string
- defaultZ: number = 0
Returns KaylaLayerInfo
- Defined in src/kayla-internals.ts:2321

getSortedLayers

getSortedLayers(): KaylaLayerInfo[]
Returns KaylaLayerInfo[]
- Defined in src/kayla-internals.ts:2333

setLayerVisible

setLayerVisible(name: string, visible: boolean): void
Parameters
- name: string
- visible: boolean
Returns void
- Defined in src/kayla-internals.ts:2339

`Protected`handleDraw

handleDraw(ctx: CanvasRenderingContext2D): void
Draws all entities in z-order (higher z = drawn later).
Parameters
- ctx: CanvasRenderingContext2D
  The 2D rendering context
Returns void
- Defined in src/kayla-internals.ts:2349

`Private`drawHandler

drawHandler(ctx: CanvasRenderingContext2D): void
Parameters
- ctx: CanvasRenderingContext2D
Returns void
- Defined in src/kayla-internals.ts:2406

attachTo

attachTo(game: KaylaInternals.KaylaGame): void
Attaches this scene to a game instance.
Parameters
- game: KaylaInternals.KaylaGame
  The game to attach to
Returns void
- Defined in src/kayla-internals.ts:2415

spawn

spawn(elem: KaylaElement<any>): Promise<void>
Dangerous: Call this function only ONCE.

There is no way to unmount a spawned root.

Mounts a root component tree into the scene.

Triggers component execution, entity creation, and hook registration.
Parameters
- elem: KaylaElement<any>
  Root Kayla element (usually JSX)
Returns Promise<void>
- Defined in src/kayla-internals.ts:2431

getRoot

getRoot(): UnsafeKaylaFiber
Returns UnsafeKaylaFiber
- Defined in src/kayla-internals.ts:2442

`Private`createFiber

createFiber(
elem: KaylaElement<any>,
): KaylaFiber<any, Record<string, KaylaExportables>>
Parameters
- elem: KaylaElement<any>
Returns KaylaFiber<any, Record<string, KaylaExportables>>
- Defined in src/kayla-internals.ts:2446

detach

detach(): void
Detaches this scene from its game (if attached).

Returns void
- Defined in src/kayla-internals.ts:2453

`Private`tickHandler

tickHandler(): void
Returns void
- Defined in src/kayla-internals.ts:2459