Interface: SpriteAnimationEcsComponent
Defined in: animations/components/sprite-animation-component.ts:44
ECS-style component interface for sprite animations.
Extends
Properties
animationClipHandle
animationClipHandle:
number
Defined in: animations/components/sprite-animation-component.ts:12
Handle for the active AnimationClip in the AssetRegistry passed to createSpriteAnimationEcsSystem.
Inherited from
SpriteAnimationRequiredOptions.animationClipHandle
animationFrameIndex
animationFrameIndex:
number
Defined in: animations/components/sprite-animation-component.ts:23
The index of the currently displayed frame within the active animation clip.
Inherited from
SpriteAnimationDefaultedOptions.animationFrameIndex
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.
Inherited from
SpriteAnimationDefaultedOptions.frameDurationMilliseconds
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.
Inherited from
SpriteAnimationDefaultedOptions.lastFrameChangeTimeInSeconds
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.