Skip to content

Class: EntityAnimationPlayer ​

Defined in: packages/minerender/src/entity/scene/EntityAnimationPlayer.ts:29

Poses part groups from a keyframe animation the way vanilla does: every update restores the default pose of each animated part, then adds the sampled offsets to its position, Euler angles and scale. It owns no timer; the owner advances it.

Constructors ​

Constructor ​

ts
new EntityAnimationPlayer(): EntityAnimationPlayer;

Returns ​

EntityAnimationPlayer

Accessors ​

animation ​

Get Signature ​

ts
get animation(): EntityAnimation | undefined;

Defined in: packages/minerender/src/entity/scene/EntityAnimationPlayer.ts:37

Returns ​

EntityAnimation | undefined


time ​

Get Signature ​

ts
get time(): number;

Defined in: packages/minerender/src/entity/scene/EntityAnimationPlayer.ts:41

Returns ​

number

Methods ​

advance() ​

ts
advance(deltaSeconds): boolean;

Defined in: packages/minerender/src/entity/scene/EntityAnimationPlayer.ts:91

Parameters ​

ParameterType
deltaSecondsnumber

Returns ​

boolean


clear() ​

ts
clear(): void;

Defined in: packages/minerender/src/entity/scene/EntityAnimationPlayer.ts:78

Forgets the animation without touching the parts, for parts that no longer exist.

Returns ​

void


play() ​

ts
play(
   layers, 
   animation, 
   options?
): void;

Defined in: packages/minerender/src/entity/scene/EntityAnimationPlayer.ts:49

Starts an animation on the named parts below each layer root. The current pose of a part becomes its default; bones without a matching part are skipped.

Parameters ​

ParameterType
layersObject3D<Object3DEventMap>[]
animationEntityAnimation
optionsEntityAnimationOptions

Returns ​

void


setTime() ​

ts
setTime(seconds): boolean;

Defined in: packages/minerender/src/entity/scene/EntityAnimationPlayer.ts:84

Parameters ​

ParameterType
secondsnumber

Returns ​

boolean


stop() ​

ts
stop(): boolean;

Defined in: packages/minerender/src/entity/scene/EntityAnimationPlayer.ts:66

Restores the default poses. Returns whether an animation was active.

Returns ​

boolean