@pixi/3d
    Preparing search index...

    Interface AnimationPlayerOptions

    Options for creating an animation player

    const player = new AnimationPlayer({
      target: robot,
      animations: [walk, run],
      autoPlay: 'walk',
    });
    interface AnimationPlayerOptions {
        animations?: Record<string, Animation> | Animation[];
        autoPlay?: string | boolean;
        autoUpdate?: boolean;
        target: Container3D;
    }
    Index
    animations? autoPlay? autoUpdate? target
    animations?: Record<string, Animation> | Animation[]

    Animations to register, keyed as AnimationPlayer#addAnimations describes

    const player = new AnimationPlayer({ target: robot, animations: { walk, run } });
    autoPlay?: string | boolean

    Animation to start playing on construction

    true plays the first registered animation, and a string plays the animation registered under that label.

    const player = new AnimationPlayer({ target: robot, animations: [idle, walk], autoPlay: 'idle' });

    false
    autoUpdate?: boolean

    Whether playback advances on Ticker.shared; see AnimationPlayer#autoUpdate

    const player = new AnimationPlayer({ target: robot, animations: [walk], autoUpdate: false });

    app.ticker.add((ticker) => player.update(ticker));

    true
    target: Container3D

    Root of the hierarchy to animate; tracks find their nodes in its subtree, itself included

    const player = new AnimationPlayer({ target: robot, animations: [walk] });

    Settings
    Member Visibility

    On This Page
    Properties