PsyTask | API Docs
    Preparing search index...

    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

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

    Close on specific events

    defaultProps: Parameters<T>[0]

    Default props

    duration?: number

    Scene duration in milliseconds

    frame_ms: number

    Frame duration in milliseconds

    record_frame_times?: boolean

    Whether to record frame times

    Root element

    timer?: SceneTimer

    Control display timing