Documentation
    Preparing search index...

    Interface AnimationStateOptions

    How one state's clip or blend tree is played (§18 states).

    interface AnimationStateOptions {
        blendTree?: BlendTree;
        clip?: AnimationClip;
        loop?: number;
        speed?: number;
    }
    Index
    blendTree?: BlendTree

    A parameter-driven mix of clips (PH-9). Mutually exclusive with AnimationStateOptions.clip.

    The clip this state poses. Mutually exclusive with AnimationStateOptions.blendTree.

    loop?: number

    Total iterations of the clip, as AnimationMixer.loop counts them: 1 plays once, 3 three times, Infinity forever. Default Infinity — the §18 example's idle/walk/run are all cycles — after which the state holds the clip's final pose rather than resetting or vanishing.

    speed?: number

    Multiplier on this state's own clock, finite and > 0. Default 1. Composes with AnimationController.speed, which scales the whole machine including the transition clock.