Class SceneContextScene<C, D>

Type Parameters

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

Index

Constructors

Accessors

current session state

Methods

enter leave reenter reset

Constructors

constructor

new SceneContextScene<
    C extends SessionContext<SceneSession<D>>,
    D extends SceneSessionData = SceneSessionData,
>(
    ctx: C,
    scenes: Map<string, BaseScene<C>>,
    options: Partial<SceneContextSceneOptions<D>>,
): 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 scenes/context.ts:39

Accessors

current

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

session

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

state

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

Methods

enter

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

leave

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

reenter

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

reset

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