Type Alias SceneOptions<T>

Scene options

type SceneOptions<T extends MaybeGenericSceneSetup> = {
    close_on?: keyof SceneEventMap | (keyof SceneEventMap)[];
    defaultProps: Parameters<T>[0];
    duration?: number;
    frame_ms: number;
    record_frame_times?: boolean;
    root: HTMLDivElement;
    timer?: SceneTimer;
}

Type Parameters

T extends MaybeGenericSceneSetup

Properties

`Optional`close_on

close_on?: keyof SceneEventMap | (keyof SceneEventMap)[]

Close on specific events

defaultProps

defaultProps: Parameters<T>[0]

Default props

`Optional`duration

duration?: number

Scene duration in milliseconds

frame_ms

frame_ms: number

Frame duration in milliseconds

`Optional`record_frame_times

record_frame_times?: boolean

Whether to record frame times

root

root: HTMLDivElement

Root element

`Optional`timer

timer?: SceneTimer

Control display timing