Skip to main content

Interface: SpriteAnimationDefaultedOptions

Defined in: animations/components/sprite-animation-component.ts:19

Fields of SpriteAnimationEcsComponent with a sensible default; callers may omit these.

Extended by

Properties

animationFrameIndex

animationFrameIndex: number

Defined in: animations/components/sprite-animation-component.ts:23

The index of the currently displayed frame within the active animation clip.


frameDurationMilliseconds

frameDurationMilliseconds: number

Defined in: animations/components/sprite-animation-component.ts:33

How long each frame is displayed, in milliseconds, before playbackSpeed is applied. Must be greater than 0.


lastFrameChangeTimeInSeconds

lastFrameChangeTimeInSeconds: number

Defined in: animations/components/sprite-animation-component.ts:38

The Time.timeInSeconds value when the displayed frame last changed. Updated automatically by createSpriteAnimationEcsSystem.


playbackSpeed

playbackSpeed: number

Defined in: animations/components/sprite-animation-component.ts:28

Multiplier applied to frameDurationMilliseconds. Values greater than 1 play the animation faster and values between 0 and 1 play it slower. Must be greater than 0.