SpriteComponent

Namespace: Murder.Components
Assembly: Murder.dll

public sealed struct SpriteComponent : IComponent

Implements: IComponent

⭐ Constructors

public SpriteComponent()

public SpriteComponent(Portrait portrait)

Parameters
portrait Portrait

public SpriteComponent(Guid guid, Vector2 offset, ImmutableArray<T> id, int ySortOffset, bool rotate, bool flip, OutlineStyle highlightStyle, float startTime, int targetSpriteBatch)

Parameters
guid Guid
offset Vector2
id ImmutableArray<T>
ySortOffset int
rotate bool
flip bool
highlightStyle OutlineStyle
startTime float
targetSpriteBatch int

⭐ Properties

AnimationGuid

public readonly Guid AnimationGuid;

The Guid of the Aseprite file.

Returns
Guid

AnimationStartedTime

public float AnimationStartedTime { get; public set; }

Returns
float

CurrentAnimation

public string CurrentAnimation { get; }

Current playing animation id.

Returns
string

FlipWithFacing

public readonly bool FlipWithFacing;

Returns
bool

HighlightStyle

public readonly OutlineStyle HighlightStyle;

Returns
OutlineStyle

NextAnimations

public readonly ImmutableArray<T> NextAnimations;

Returns
ImmutableArray<T>

Offset

public readonly Vector2 Offset;

(0,0) is top left and (1,1) is bottom right

Returns
Vector2

RotateWithFacing

public readonly bool RotateWithFacing;

Returns
bool

TargetSpriteBatch

public readonly int TargetSpriteBatch;

Returns
int

UseUnscaledTime

public readonly bool UseUnscaledTime;

Returns
bool

YSortOffset

public readonly int YSortOffset;

Returns
int

⭐ Methods

HasAnimation(string)

public bool HasAnimation(string animationName)

Parameters
animationName string

Returns
bool

IsPlaying(string)

public bool IsPlaying(string animationName)

Parameters
animationName string

Returns
bool

IsPlaying(String[])

public bool IsPlaying(String[] animations)

Parameters
animations string[]

Returns
bool

Play(bool, ImmutableArray)

public SpriteComponent Play(bool useScaledTime, ImmutableArray<T> id)

Parameters
useScaledTime bool
id ImmutableArray<T>

Returns
SpriteComponent

Play(bool, String[])

public SpriteComponent Play(bool useScaledTime, String[] id)

Parameters
useScaledTime bool
id string[]

Returns
SpriteComponent

PlayAfter(string)

public SpriteComponent PlayAfter(string id)

Parameters
id string

Returns
SpriteComponent

PlayOnce(string, bool)

public SpriteComponent PlayOnce(string id, bool useScaledTime)

Parameters
id string
useScaledTime bool

Returns
SpriteComponent

Reset()

public SpriteComponent Reset()

Returns
SpriteComponent

SetBatch(int)

public SpriteComponent SetBatch(int batch)

Parameters
batch int

Returns
SpriteComponent

WithSort(int)

public SpriteComponent WithSort(int sort)

Parameters
sort int

Returns
SpriteComponent

⚡