Class SpriteAnimator

Definition

Namespace: StardewUI.Animation
Assembly: StardewUI.dll

Animates the sprite of an Image, using equal duration for all frames in a list.

public class SpriteAnimator

Inheritance
Object ⇦ SpriteAnimator

Name	Description
SpriteAnimator(Image)	Initializes a new instance of SpriteAnimator that animates the sprite on a specified image.

Name	Description
FrameDuration	Duration of each frame.
Frames	Frames to animate through.
Paused	Whether or not to pause animation. If `true`, the animator will hold at the current position and not progress until set to `false` again.
StartDelay	Delay before advancing from the first frame to the next frames.

Name	Description
Reset()	Resets the animation to the first frame, and waits any StartDelay required again.
Tick(TimeSpan)	Advances the animation.

Initializes a new instance of SpriteAnimator that animates the sprite on a specified image.

public SpriteAnimator(StardewUI.Widgets.Image image);

image Image
The image to animate.

Duration of each frame.

public System.TimeSpan FrameDuration { get; set; }

Frames to animate through.

public System.Collections.Generic.IReadOnlyList<StardewUI.Graphics.Sprite> Frames { get; set; }

Whether or not to pause animation. If true, the animator will hold at the current position and not progress until set to false again.

public bool Paused { get; set; }

Delay before advancing from the first frame to the next frames.

public System.TimeSpan StartDelay { get; set; }

Repeats on every loop, but only applies to the first frame of each loop.

Resets the animation to the first frame, and waits any StartDelay required again.

public void Reset();

Advances the animation.

public void Tick(System.TimeSpan elapsed);

elapsed TimeSpan
The time elapsed since the previous tick.