Class Animator

Namespace

MonoEight.Core.Sprite

Assembly

MonoEight.Template.dll

A Component that renders animated sprites by cycling through frames form a SpriteSheet.

public class Animator : SpriteRenderer, IDisposable

Inheritance

object

Component

SpriteRenderer

Animator

Implements

IDisposable

Inherited Members

SpriteRenderer.Texture

SpriteRenderer.Offset

SpriteRenderer.Color

SpriteRenderer.Rotation

SpriteRenderer.Origin

SpriteRenderer.Scale

SpriteRenderer.SpriteEffects

SpriteRenderer.Layer

SpriteRenderer.Draw(SpriteBatch)

Component.IsActive

Component.ShouldDestroy

Component.GameObject

Component.Position

Component.Scene

Component.Initialize()

Component.LoadContent()

Component.InternalInitialize()

Component.InternalLoadContent()

Component.InternalUpdate()

Component.InternalDraw(SpriteBatch)

Component.Destroy()

Component.Dispose()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

Animator(SpriteSheet)

Initializes a new instance of the Animator class with a default animation using all frames in the sheet.

public Animator(SpriteSheet spriteSheet)

Parameters

spriteSheet SpriteSheet

The source sprite sheet containing the frames.

Animator(SpriteSheet, Animation[])

Initializes a new instance of the Animator class with a given set of named animations.

public Animator(SpriteSheet spriteSheet, Animation[] animations)

Parameters

spriteSheet SpriteSheet

The source sprite sheet containing the frames.

animations Animation[]

The array of animations to register.

Exceptions

Exception

Thrown if the animations array is empty.

Fields

OnChanged

Invoked when the current animation is switched to a new one. Provides the name of the new animation.

public Action<string> OnChanged

Field Value

Action<string>

OnFinished

Invoked when a non-looping animation reaches its final frame. Provides the name of the finished animation.

public Action<string> OnFinished

Field Value

Action<string>

OnLooped

Invoked when the current animation completes a cycle and loops back to the start.

public Action OnLooped

Field Value

Action

OnPlayed

Invoked when playback starts or resumes.

public Action OnPlayed

Field Value

Action

OnStopped

Invoked when playback is stopped manually or when a non looping animation finishes.

public Action OnStopped

Field Value

Action

Properties

FrameDuration

Gets or sets the default duration, in seconds, for each frame. Used only for the default animation created in the constructor.

public float FrameDuration { get; init; }

Property Value

float

Loop

Gets or sets a value indicating whether the default animation should loop. Used only for the default animation created in the constructor.

public bool Loop { get; init; }

Property Value

bool

Methods

Pause()

Pauses playback.

public void Pause()

Play()

Starts or resumes playback of the current animation.

public void Play()

Play(string)

Switches to the given animation and starts playback from the beginning.

public void Play(string animationName)

Parameters

animationName string

The name of the animation to play.

Remarks

If the specified animation is already playing, this method does nothing, unless Stop() was called previously.

Exceptions

Exception

Thrown if the animation name is not found.

Resume()

Resumes playback from the current frame.

public void Resume()

Stop()

Stops playback. The sprite remains on the current frame.

public void Stop()

Update()

Called once per frame to update game logic.

protected override void Update()