Documentation
    Preparing search index...

    Interface MixerPlayOptions

    Per-playback policy for AnimationMixer.play.

    interface MixerPlayOptions {
        authority?: Node;
        loop?: number;
        onEvent?: AnimationEventListener;
        replayOnSeek?: boolean;
        rootMotion?: MixerRootMotionOptions;
        speed?: number;
    }
    Index
    authority?: Node

    The node whose §42 authority gates this playback's transform writes.

    Inferred when the target is a Node. A mixer aimed at something else — a material, a bare Transform, a plain object — cannot infer it (math and material objects carry no back-reference to a node), so declare it here if the clip writes into a node's transform through that target.

    loop?: number

    Number of total iterations: 1 (the default) plays the clip once, 3 plays it three times, Infinity never ends. The same counting as Timeline.loop, deliberately not Tween.repeat's "additional cycles".

    Called for every clip event this playback crosses (§16 semantics).

    replayOnSeek?: boolean

    Whether AnimationMixer.seek also fires the events it crosses forwards — §16's opt-in replay-on-seek policy.

    §16 words it per marker; a clip's AnimationEvent is plain authored data with no policy field (see ./clip.js), so the opt-in lives on the playback that owns the marker history instead. A caller who needs per-marker granularity filters inside MixerPlayOptions.onEvent, which receives the event and its index.

    Defaults to false: seeking is silent, and a backward seek fires nothing either way (crossing is a forward notion, §16).

    Extracts translation from one designated track and moves a node with it instead of writing it (§19, plan P7-5). See MixerRootMotionOptions for the semantics, the loop-aware derivation, and what is staged.

    Validated at AnimationMixer.play, where the clip's tracks are known.

    speed?: number

    Multiplier applied to every advance delta; finite and > 0. Default 1.