Class AnimationBehavior

Represents a behavior that enables sprite animations in the Genesis framework.

Inheritance

object

IGameBehavior

AnimationBehavior

Inherited Members

IGameBehavior.Parent

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: Genesis.Core.Behaviors

Assembly: Genesis.dll

Syntax

public class AnimationBehavior : IGameBehavior

Constructors

AnimationBehavior()

Initializes a new instance of the AnimationBehavior class.

Declaration

public AnimationBehavior()

AnimationBehavior(float, float, long, Texture)

Initializes a new instance of the AnimationBehavior class with specified parameters.

Declaration

public AnimationBehavior(float cells, float rows, long frameTime, Texture animationSheet)

Parameters

Type	Name	Description
float	cells	The number of cells (frames) in a row in the animation sheet.
float	rows	The number of rows in the animation sheet.
long	frameTime	The time in milliseconds between animation frames.
Texture	animationSheet	The texture containing the animation frames.

Properties

AnimationSheet

Gets or sets the texture containing the animation frames.

Declaration

public Texture AnimationSheet { get; set; }

Property Value

Type	Description
Texture

Animations

Gets or sets the list of animations available for this behavior.

Declaration

public List<Animation> Animations { get; set; }

Property Value

Type	Description
List<Animation>

Callbacks

Gets or sets the callbacks for the animation

Declaration

public List<AnimationCallback> Callbacks { get; set; }

Property Value

Type	Description
List<AnimationCallback>

Cells

Gets or sets the number of cells (frames) in a row in the animation sheet.

Declaration

public float Cells { get; set; }

Property Value

Type	Description
float

FrameTime

Gets or sets the time in milliseconds between animation frames.

Declaration

public long FrameTime { get; set; }

Property Value

Type	Description
long

Rows

Gets or sets the number of rows in the animation sheet.

Declaration

public float Rows { get; set; }

Property Value

Type	Description
float

SelectedAnimation

Gets or sets the currently selected animation.

Declaration

public Animation SelectedAnimation { get; set; }

Property Value

Type	Description
Animation

Methods

AddAnimation(Animation)

Adds an animation to the list of available animations.

Declaration

public void AddAnimation(Animation animation)

Parameters

Type	Name	Description
Animation	animation

AddCallback(string, int, AnimationEvent)

Adds an new animation callback to the animation behavior

Declaration

public void AddCallback(string animation, int frame, AnimationCallback.AnimationEvent animationEvent)

Parameters

Type	Name	Description
string	animation	The name from the animation
int	frame	The frame when the callback gets rised
AnimationCallback.AnimationEvent	animationEvent	The animation event

LoadAnimation(string)

Loads the specified animation by name.

Declaration

public void LoadAnimation(string name)

Parameters

Type	Name	Description
string	name	The name of the animation to load.

OnDestroy(Game, GameElement)

Called when the game behavior is being destroyed.

Declaration

public override void OnDestroy(Game game, GameElement parent)

Parameters

Type	Name	Description
Game	game	The game instance.
GameElement	parent	The parent game element.

Overrides

IGameBehavior.OnDestroy(Game, GameElement)

OnInit(Game, GameElement)

Called when the game element is initialized.

Declaration

public override void OnInit(Game game, GameElement parent)

Parameters

Type	Name	Description
Game	game
GameElement	parent

Overrides

IGameBehavior.OnInit(Game, GameElement)

OnRender(Game, GameElement)

Called when the game behavior is rendered.

Declaration

public override void OnRender(Game game, GameElement parent)

Parameters

Type	Name	Description
Game	game	The game instance.
GameElement	parent	The parent game element.

Overrides

IGameBehavior.OnRender(Game, GameElement)

OnUpdate(Game, GameElement)

Called when the game element is updated.

Declaration

public override void OnUpdate(Game game, GameElement parent)

Parameters

Type	Name	Description
Game	game
GameElement	parent

Overrides

IGameBehavior.OnUpdate(Game, GameElement)

Play()

Starts playing the animation.

Declaration

public void Play()

Stop()

Stops playing the animation.

Declaration

public void Stop()