Class Entity.Animated
An entity that is a an animated surface.
Inherited Members
Namespace: SadConsole.Entities
Assembly: SadConsole.dll
Syntax
[DataContract]
public class Entity.AnimatedConstructors
Animated(AnimatedScreenObject)
Creates a new instance of this type from an animated screen surface.
Declaration
public Animated(AnimatedScreenObject surface)Parameters
| Type | Name | Description |
|---|---|---|
| AnimatedScreenObject | surface | The animation to use. |
Properties
Animation
The animation associated with this animated entity.
Declaration
[DataMember]
public AnimatedScreenObject Animation { get; }Property Value
| Type | Description |
|---|---|
| AnimatedScreenObject |
CustomCollisionRectangle
A relative collision rectangle that you can specify. Defaults to the size of the animation surface.
Declaration
[DataMember]
public Rectangle CustomCollisionRectangle { get; set; }Property Value
| Type | Description |
|---|---|
| Rectangle |
Remarks
This rectangle should be declared without using the animation center. Only apply the center when you're testing for collision and reading this rectangle.
DefaultCollisionRectangle
Represents the collision rectangle for this animated surface which is the size of the animation frame.
Declaration
public Rectangle DefaultCollisionRectangle { get; }Property Value
| Type | Description |
|---|---|
| Rectangle |
IsDirty
When true, indicates that this animation is dirty and needs to be redrawn.
Declaration
public bool IsDirty { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
Methods
Update(TimeSpan)
Updates the Animation.
Declaration
public void Update(TimeSpan delta)Parameters
| Type | Name | Description |
|---|---|---|
| TimeSpan | delta | The time that has elapsed since this method was last called. |