Animated Sprite (Deprecated)

Location: Component->Aquaphobia->Common->AnimatedSprite

Description: This component displays a single material texture and has the capability to set up animations. It should be applied to basically everything that is able to be seen on screen.

At runtime this class works by connecting with a Sprite Manger that using the attached material or Linked Sprite Manager if the Sprite Is Mobile box is checked. If no manager exists yet then a new one is created.

Note: Since a new Sprite Manager has to be created for each unique Sprite Material in a scene, any effort taken to compress multiple related sprite sheets (Such as background layers) into a single sheet will give a performance boost during gameplay.

Note To Artist: Textures imported into Unity are automatically scaled to be the nearest power of two. So for making animated sprites it would be best to keep the sheet size as a power of two so frame sizes will remain consistent. Sheets can be a maximum size of 2048x2048

Special Note: Sprite Manager was not made by the Aquaphobia team. It was found here. Any changes made to the code have been marked.

Variables:

Sprite Material: Material that contains a sprites texture
Animations: List of animation that the Sprite Material contains (greater detail below)
Sprite Frame Size: Vector2 representing the size of frame used from Sprite Material that is displayed on screen – This item really gets used to display a single frame texture if no animations are set up
Sprite Scaling: Vector2 representing the size of the sprite displayed on screen
Sprite Is Mobile: check this box if the sprite will move frequently. It tells the game at runtime to update the sprites position automatically. Otherwise any change in position will have to be handled manually in code through another script.

Animations – This is where the sprites animations will really be stored. The Size field needs to be set to the number of animations held on the sheet and then each item has several extra variables

Name: The name of the animation
Start Frame Position: Vector2 representing the texture coordinate of the top left pixel of the first frame of the animation
Frame Size: Vector2 representing the size of each frame in the animation ( all frame sizes must be equal in a single animation, but don’t have to be the same for each animation on a sprite sheet)
Number of Columns: The number of columns that contain a portion of this animation
Number of Rows: The number of rows that contain a portion of this animation
Total Number of Frames: the total number of frames the animation contains
FPS: The number of frames to advance per second for this animation such
Loop Cycles: The number of times to loop through the animation before stopping (-1 being a special case that will loop infinitely)

Scripting:

Properties:

bool IsAtEnd – Returns true when an animation has reached the end of its Loop Cycles
bool FlippedHorizontally - Inicates if the sprite animations are flipped horzontally. On setting the value this will adjust the sprites UVs so it's facing the given direction.
!UVAnimation CurrentAnimation - Read only access to the currently playing animation.
SpriteManager Manager - Read only access to the Sprite Manager of this sprite.
Sprite Sprite - Read only access to the Sprite of this animated sprite.

Functions:

void PlayAnimation(int index) - Plays the animation at the given index or throws a Debug log message if the index is invalid.
void PlayAnimation(string animName) - Plays the animation with the given name or throws a debug log message if no such animation exists.
void PlayAnimationInReverse(int index) - Plays the animation at the given index in reverse or throws a Debug log message if the index is invalid.
void PlayAnimationInReverse(string animName) - Plays the animation with the given name in reverse or throws a debug log message if no such animation exists.
void RemoveSpriteFromScene() - Removes the animated sprite from the scene
void PlaceInFrontOf(AnimatedSprite otherSprite) - If both Animated Sprites use the same Sprite Manager, this will ensure that this animated sprite is being drawn in front of the other sprite.