mwg API
    Preparing search index...

    Interface TransitionOptions

    how a transition is run; transition is the only required part

    interface TransitionOptions {
        duration?: number;
        easing?:
            | "linear"
            | "easeInQuad"
            | "easeOutQuad"
            | "easeInOutQuad"
            | "easeInCubic"
            | "easeOutCubic"
            | "easeInOutCubic"
            | Easing;
        interrupt?: boolean;
        onDone?: () => void;
        pause?: boolean;
        queue?: boolean;
        transition: SceneTransition;
    }
    Index
    duration? easing? interrupt? onDone? pause? queue? transition
    duration?: number

    seconds, counted in real time; 0.5 when omitted. Reduced motion skips the transition entirely

    easing?:
        | "linear"
        | "easeInQuad"
        | "easeOutQuad"
        | "easeInOutQuad"
        | "easeInCubic"
        | "easeOutCubic"
        | "easeInOutCubic"
        | Easing

    a name from Easing or a function of progress; easeInOutQuad when omitted

    interrupt?: boolean

    see queue: finish the running transition at once and play this one instead

    onDone?: () => void

    runs once, the frame the transition ends

    pause?: boolean

    hold the scene still while the transition plays; false when omitted

    queue?: boolean

    What happens when this transition is requested while another is already playing: by default the new request is ignored (its swap never runs and its onDone never fires). queue: true holds it until the running transition finishes, then plays it; interrupt: true finishes the running one at once (its onDone fires) and plays this one instead. interrupt wins when both are set.

    transition: SceneTransition

    Settings
    Member Visibility

    On This Page
    Properties