Class SceneContextScene<C, D>

Type parameters

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

Hierarchy

SceneContextScene

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new SceneContextScene<C, D>(ctx: C, scenes: Map<string, BaseScene<C>>, options: Partial<SceneContextSceneOptions<D>>): SceneContextScene<C, D>

- Defined in scenes/context.ts:37
Type parameters
- C: SessionContext<SceneSession<D>, C>
- D: SceneSessionData = SceneSessionData
Parameters
- ctx: C
- scenes: Map<string, BaseScene<C>>
- options: Partial<SceneContextSceneOptions<D>>
Returns SceneContextScene<C, D>

Properties

Private leaving

leaving: boolean = false

Private Readonly options

options: SceneContextSceneOptions<D>

Accessors

current

get current(): undefined | BaseScene<C>

- Defined in scenes/context.ts:73
Returns undefined | BaseScene<C>

session

get session(): D

- Defined in scenes/context.ts:50
Returns D

state

get state(): object
set state(value: object): void

- Defined in scenes/context.ts:65
Returns object
- Defined in scenes/context.ts:69
Parameters
- value: object
Returns void

Methods

enter

enter(sceneId: string, initialState?: object, silent?: boolean): Promise<unknown>

- Defined in scenes/context.ts:85
Parameters
- sceneId: string
- initialState: object = ...
- silent: boolean = false
Returns Promise<unknown>

leave

leave(): Promise<void>

- Defined in scenes/context.ts:121
Returns Promise<void>

reenter

reenter(): undefined | Promise<unknown>

- Defined in scenes/context.ts:114
Returns undefined | Promise<unknown>

reset

reset(): void

- Defined in scenes/context.ts:80
Returns void

Generated using TypeDoc