Interface Animatable

interface Animatable {
    getAnimationDuration(): number;
    getAnimationElapsedTime(): number;
    getAnimationIndex(): number;
    getAnimationName(): string;
    getAnimationSpeedScale(): number;
    hasAnimationEnded(): boolean;
    isAnimationPaused(): boolean;
    pauseAnimation(): void;
    resumeAnimation(): void;
    setAnimationElapsedTime(time): void;
    setAnimationIndex(animationIndex): void;
    setAnimationName(newAnimationName): void;
    setAnimationSpeedScale(ratio): void;
}

Implemented by

Index

Methods

getAnimationDuration getAnimationElapsedTime getAnimationIndex getAnimationName getAnimationSpeedScale hasAnimationEnded isAnimationPaused pauseAnimation resumeAnimation setAnimationElapsedTime setAnimationIndex setAnimationName setAnimationSpeedScale

Methods

getAnimationDuration

getAnimationDuration(): number
Returns number
The duration of the current animation in seconds.
- Defined in GDJS/Runtime/object-capabilities/AnimatableBehavior.ts:65

getAnimationElapsedTime

getAnimationElapsedTime(): number
Returns number
The elapsed time from the start of the animation in seconds.
- Defined in GDJS/Runtime/object-capabilities/AnimatableBehavior.ts:54

getAnimationIndex

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

Returns number
The index of the new animation being played
- Defined in GDJS/Runtime/object-capabilities/AnimatableBehavior.ts:12

getAnimationName

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

Returns string
The name of the new animation being played
- Defined in GDJS/Runtime/object-capabilities/AnimatableBehavior.ts:24

getAnimationSpeedScale

getAnimationSpeedScale(): number
Returns number
- Defined in GDJS/Runtime/object-capabilities/AnimatableBehavior.ts:47

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
- Defined in GDJS/Runtime/object-capabilities/AnimatableBehavior.ts:39

isAnimationPaused

isAnimationPaused(): boolean
Returns boolean
- Defined in GDJS/Runtime/object-capabilities/AnimatableBehavior.ts:41

pauseAnimation

pauseAnimation(): void
Returns void
- Defined in GDJS/Runtime/object-capabilities/AnimatableBehavior.ts:43

resumeAnimation

resumeAnimation(): void
Returns void
- Defined in GDJS/Runtime/object-capabilities/AnimatableBehavior.ts:45

setAnimationElapsedTime

setAnimationElapsedTime(time): void
Set the elapsed time from the start of the animation in seconds.
Parameters
- time: number
  The time in seconds
Returns void
- Defined in GDJS/Runtime/object-capabilities/AnimatableBehavior.ts:60

setAnimationIndex

setAnimationIndex(animationIndex): void
Change the animation being played.
Parameters
- animationIndex: number
  The index of the new animation to be played
Returns void
- Defined in GDJS/Runtime/object-capabilities/AnimatableBehavior.ts:18

setAnimationName

setAnimationName(newAnimationName): void
Change the animation being played.
Parameters
- newAnimationName: string
  The name of the new animation to be played
Returns void
- Defined in GDJS/Runtime/object-capabilities/AnimatableBehavior.ts:30

setAnimationSpeedScale

setAnimationSpeedScale(ratio): void
Parameters
- ratio: number
Returns void
- Defined in GDJS/Runtime/object-capabilities/AnimatableBehavior.ts:49