Class SpriteAnimator<T>

Image-base animation model.

Type Parameters

T

Implements

Animatable

Constructors

constructor

new SpriteAnimator<T>(animations, textureManager): SpriteAnimator<T>
Type Parameters
- T
Parameters
- animations: SpriteAnimationData[]
  The animation list data used to initialize the animator
- textureManager: AnimationFrameTextureManager<T>
  The game image manager
Returns SpriteAnimator<T>
- Defined in GDJS/Runtime/SpriteAnimator.ts:321

Methods

getAngle

getAngle(angle): number
Parameters
- angle: number
Returns number
Deprecated
- Defined in GDJS/Runtime/SpriteAnimator.ts:703

getAnimationDuration

getAnimationDuration(): number
Returns number
The duration of the current animation in seconds.
Implementation of Animatable.getAnimationDuration
- Defined in GDJS/Runtime/SpriteAnimator.ts:637

getAnimationElapsedTime

getAnimationElapsedTime(): number
Returns number
The elapsed time from the start of the animation in seconds.
Implementation of Animatable.getAnimationElapsedTime
- Defined in GDJS/Runtime/SpriteAnimator.ts:610

getAnimationFrameCount

getAnimationFrameCount(): number
Returns number
- Defined in GDJS/Runtime/SpriteAnimator.ts:645

getAnimationFrameIndex

getAnimationFrameIndex(): number
Get the index of the current frame displayed by the animation

Returns number
newFrame The index of the frame being displayed
- Defined in GDJS/Runtime/SpriteAnimator.ts:606

getAnimationIndex

getAnimationIndex(): number
Get the index of the animation being played.

Returns number
The index of the new animation being played
Implementation of Animatable.getAnimationIndex
- Defined in GDJS/Runtime/SpriteAnimator.ts:489

getAnimationName

getAnimationName(): string
Get the name of the animation being played.

Returns string
The name of the new animation being played
Implementation of Animatable.getAnimationName
- Defined in GDJS/Runtime/SpriteAnimator.ts:510

getAnimationSpeedScale

getAnimationSpeedScale(): number
Returns number
Implementation of Animatable.getAnimationSpeedScale
- Defined in GDJS/Runtime/SpriteAnimator.ts:564

getCurrentFrame

getCurrentFrame(): null | SpriteAnimationFrame<T>
Returns null | SpriteAnimationFrame<T>
Returns the current frame or null if the current animation doesn't have any frame.
- Defined in GDJS/Runtime/SpriteAnimator.ts:416

getDirectionOrAngle

getDirectionOrAngle(angle): number
Parameters
- angle: number
Returns number
Deprecated
- Defined in GDJS/Runtime/SpriteAnimator.ts:689

getNetworkSyncData

getNetworkSyncData(): SpriteAnimatorNetworkSyncData
Returns SpriteAnimatorNetworkSyncData
- Defined in GDJS/Runtime/SpriteAnimator.ts:392

hasAnimationEnded

hasAnimationEnded(): boolean
Return true if animation has ended. The animation had ended if:
- it's not configured as a loop;
- the current frame is the last frame;
- the last frame has been displayed long enough.
Returns boolean
Implementation of Animatable.hasAnimationEnded
- Defined in GDJS/Runtime/SpriteAnimator.ts:530

hasAnimationEndedLegacy

hasAnimationEndedLegacy(): boolean
Returns boolean
Deprecated
Return true if animation has ended. Prefer using hasAnimationEnded. This method returns true as soon as the animation enters the last frame, not at the end of the last frame.
- Defined in GDJS/Runtime/SpriteAnimator.ts:741

invalidateFrame

invalidateFrame(): void
Returns void
- Defined in GDJS/Runtime/SpriteAnimator.ts:333

isAnimationPaused

isAnimationPaused(): boolean
Returns boolean
Implementation of Animatable.isAnimationPaused
- Defined in GDJS/Runtime/SpriteAnimator.ts:552

pauseAnimation

pauseAnimation(): void
Returns void
Implementation of Animatable.pauseAnimation
- Defined in GDJS/Runtime/SpriteAnimator.ts:556

reinitialize

reinitialize(animations): void
Parameters
- animations: SpriteAnimationData[]
Returns void
- Defined in GDJS/Runtime/SpriteAnimator.ts:340

resumeAnimation

resumeAnimation(): void
Returns void
Implementation of Animatable.resumeAnimation
- Defined in GDJS/Runtime/SpriteAnimator.ts:560

setAngle

setAngle(oldAngle, angle): null | number
Parameters
- oldAngle: number
- angle: number
Returns null | number
Deprecated
- Defined in GDJS/Runtime/SpriteAnimator.ts:717

setAnimationElapsedTime

setAnimationElapsedTime(time): boolean
Set the elapsed time from the start of the animation in seconds.
Parameters
- time: number
  The time in seconds
Returns boolean
Implementation of Animatable.setAnimationElapsedTime
- Defined in GDJS/Runtime/SpriteAnimator.ts:614

setAnimationFrameIndex

setAnimationFrameIndex(newFrameIndex): boolean
Change the current frame displayed by the animation
Parameters
- newFrameIndex: number
  The index of the frame to be displayed
Returns boolean
- Defined in GDJS/Runtime/SpriteAnimator.ts:576

setAnimationIndex

setAnimationIndex(newAnimation): boolean
Change the animation being played.
Parameters
- newAnimation: number
  The index of the new animation to be played
Returns boolean
Implementation of Animatable.setAnimationIndex
- Defined in GDJS/Runtime/SpriteAnimator.ts:493

setAnimationName

setAnimationName(newAnimationName): boolean
Change the animation being played.
Parameters
- newAnimationName: string
  The name of the new animation to be played
Returns boolean
Implementation of Animatable.setAnimationName
- Defined in GDJS/Runtime/SpriteAnimator.ts:517

setAnimationSpeedScale

setAnimationSpeedScale(ratio): void
Parameters
- ratio: number
Returns void
Implementation of Animatable.setAnimationSpeedScale
- Defined in GDJS/Runtime/SpriteAnimator.ts:568

setDirectionOrAngle

setDirectionOrAngle(oldValue, newValue): null | number
Change the angle (or direction index) of the object
Parameters
- oldValue: number
  The old angle
- newValue: number
  The new angle (or direction index) to be applied
Returns null | number
Deprecated
- Defined in GDJS/Runtime/SpriteAnimator.ts:662

setOnFrameChangeCallback

setOnFrameChangeCallback(callback): void
Register a listener to frame changes.

It's useful for custom objects as they don't drive this class themselves.
Parameters
- callback: (() => void)
  Called each time getCurrentFrame changes.
  - - (): void
    - Returns void
Returns void
- Defined in GDJS/Runtime/SpriteAnimator.ts:485

step

step(timeDelta): boolean
Update the current frame of the object according to the elapsed time on the scene.
Parameters
- timeDelta: number
  in seconds
Returns boolean
- Defined in GDJS/Runtime/SpriteAnimator.ts:445

updateFromNetworkSyncData

updateFromNetworkSyncData(networkSyncData): void
Parameters
- networkSyncData: SpriteAnimatorNetworkSyncData
Returns void
- Defined in GDJS/Runtime/SpriteAnimator.ts:403

updateFromObjectData

updateFromObjectData(oldAnimations, newAnimations): boolean
Parameters
- oldAnimations: SpriteAnimationData[]
- newAnimations: SpriteAnimationData[]
Returns boolean
- Defined in GDJS/Runtime/SpriteAnimator.ts:366