Interface AnimatedTextureFileProvider

Controls an animated texture resource. Can be accessed from Texture.control on an animated texture. See also: 2D Animation Guide.

Example

// Plays an animated sprite
//@input Component.SpriteVisual spriteVisual

var loops = 100;
var offset = 0.0;

var provider = script.spriteVisual.mainPass.baseTex.control;
provider.play(loops, offset);
interface AnimatedTextureFileProvider {
    duration: number;
    isAutoplay: boolean;
    isPingPong: boolean;
    isReversed: boolean;
    clone(): AnimatedTextureFileProvider;
    getAspect(): number;
    getCurrentPlayingFrame(): number;
    getDuration(): number;
    getFramesCount(): number;
    getHeight(): number;
    getLoadStatus(): LoadStatus;
    getTypeName(): string;
    getWidth(): number;
    isFinished(): boolean;
    isOfType(type: string): boolean;
    isPaused(): boolean;
    isPlaying(): boolean;
    isSame(other: ScriptObject): boolean;
    pause(): void;
    pauseAtFrame(frameIndex: number): void;
    play(loops: number, offset: number): void;
    playFromFrame(frameIndex: number, loops: number): void;
    resume(): void;
    setOnFinish(eventCallback: ((animatedTexture: AnimatedTextureFileProvider) => void)): void;
    stop(): void;
}

Hierarchy (view full)

Properties

duration isAutoplay isPingPong isReversed

Methods

clone getAspect getCurrentPlayingFrame getDuration getFramesCount getHeight getLoadStatus getTypeName getWidth isFinished isOfType isPaused isPlaying isSame pause pauseAtFrame play playFromFrame resume setOnFinish stop

Properties

duration

duration: number

Length of the animation in seconds.

isAutoplay

isAutoplay: boolean

Returns whether the animation was set to automatically play and loop.

isPingPong

isPingPong: boolean

If enabled, the animation will alternate between normal and reverse each time it loops.

isReversed

isReversed: boolean

Whether the animation plays in reverse.

Methods

clone

getAspect

  • getAspect(): number

  • Returns the texture's aspect ratio, which is calculated as width / height.

    Returns number

getCurrentPlayingFrame

  • getCurrentPlayingFrame(): number

  • Returns the index of the frame that is currently playing.

    Returns number

getDuration

  • getDuration(): number

  • Returns how long the animation is in seconds.

    Returns number

getFramesCount

  • getFramesCount(): number

  • Returns the number of frames in the animation.

    Returns number

getHeight

getLoadStatus

getTypeName

getWidth

  • getWidth(): number

  • Returns the width of the texture in pixels.

    Returns number

isFinished

  • isFinished(): boolean

  • Returns whether the animation is finished playing.

    Returns boolean

isOfType

  • isOfType(type): boolean

  • Returns true if the object matches or derives from the passed in type.

    Parameters

    • type: string

    Returns boolean

isPaused

  • isPaused(): boolean

  • Returns whether the animation is currently paused.

    Returns boolean

isPlaying

  • isPlaying(): boolean

  • Returns whether the animation is currently playing.

    Returns boolean

isSame

  • isSame(other): boolean

  • Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

    Parameters

    Returns boolean

pause

  • pause(): void

  • Pauses the animation.

    Returns void

pauseAtFrame

  • pauseAtFrame(frameIndex): void

  • Pauses the animation at frame frameIndex.

    Parameters

    • frameIndex: number

    Returns void

play

  • play(loops, offset): void

  • Plays the animation loops times, starting with an offset of offset seconds.

    Parameters

    • loops: number
    • offset: number

    Returns void

playFromFrame

  • playFromFrame(frameIndex, loops): void

  • Start playing the animation from frame frameIndex, loops times.

    Parameters

    • frameIndex: number
    • loops: number

    Returns void

resume

  • resume(): void

  • Resumes a paused animation from the frame that was last played.

    Returns void

setOnFinish

  • setOnFinish(eventCallback): void

  • Sets the callback function to be called whenever the animation stops playing.

    Parameters

    Returns void

stop

  • stop(): void

  • Stops the animation.

    Returns void

Settings

Member Visibility

On This Page

Properties
Methods