Class SceneContextScene<C, D>

Type Parameters

C extends SessionContext<SceneSession<D>>
D extends SceneSessionData = SceneSessionData

Hierarchy

SceneContextScene

Index

Constructors

Properties

ctx leaving options scenes

Accessors

current session state

Methods

enter leave reenter reset

Constructors

constructor

new SceneContextScene<C, D>(ctx, scenes, options): SceneContextScene<C, D>
Type Parameters
- C extends SessionContext<SceneSession<D>>
- D extends SceneSessionData = SceneSessionData
Parameters
- ctx: C
- scenes: Map<string, BaseScene<C>>
- options: Partial<SceneContextSceneOptions<D>>
Returns SceneContextScene<C, D>
- Defined in src/scenes/context.ts:39

Properties

`Private` `Readonly` ctx

ctx: C

`Private` leaving

leaving: boolean = false

`Private` `Readonly` options

options: SceneContextSceneOptions<D>

`Private` `Readonly` scenes

scenes: Map<string, BaseScene<C>>

Accessors

current

get current(): undefined | BaseScene<C>
Returns undefined | BaseScene<C>
- Defined in src/scenes/context.ts:73

session

get session(): D
Returns D
- Defined in src/scenes/context.ts:50

state

get state(): object
Returns object
- Defined in src/scenes/context.ts:65
set state(value): void
Parameters
- value: object
Returns void
- Defined in src/scenes/context.ts:69

Methods

enter

enter(sceneId, initialState?, silent?): Promise<unknown>
Parameters
- sceneId: string
- initialState: object = {}
- silent: boolean = false
Returns Promise<unknown>
- Defined in src/scenes/context.ts:85

leave

leave(): Promise<void>
Returns Promise<void>
- Defined in src/scenes/context.ts:117

reenter

reenter(): undefined | Promise<unknown>
Returns undefined | Promise<unknown>
- Defined in src/scenes/context.ts:110

reset

reset(): void
Returns void
- Defined in src/scenes/context.ts:80

Generated using TypeDoc