NGUI: Next-Gen UI kit  3.7.2
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Macros
UI2DSpriteAnimation Class Reference

Small script that makes it easy to create looping 2D sprite animations. More...

Inheritance diagram for UI2DSpriteAnimation:

Public Member Functions

void Play ()
 Continue playing the animation. If the animation has reached the end, it will restart from beginning More...
 
void Pause ()
 Pause the animation. More...
 
void ResetToBeginning ()
 Reset the animation to the beginning. More...
 

Public Attributes

bool ignoreTimeScale = true
 Should this animation be affected by time scale? More...
 
bool loop = true
 Should this animation be looped? More...
 
UnityEngine.Sprite[] frames
 Actual sprites used for the animation. More...
 

Protected Attributes

int framerate = 20
 How many frames there are in the animation per second. More...
 

Properties

bool isPlaying [get]
 Returns is the animation is still playing or not More...
 
int framesPerSecond [get, set]
 Animation framerate. More...
 

Detailed Description

Small script that makes it easy to create looping 2D sprite animations.

Member Function Documentation

void UI2DSpriteAnimation.Pause ( )

Pause the animation.

void UI2DSpriteAnimation.Play ( )

Continue playing the animation. If the animation has reached the end, it will restart from beginning

void UI2DSpriteAnimation.ResetToBeginning ( )

Reset the animation to the beginning.

Member Data Documentation

int UI2DSpriteAnimation.framerate = 20
protected

How many frames there are in the animation per second.

UnityEngine.Sprite [] UI2DSpriteAnimation.frames

Actual sprites used for the animation.

bool UI2DSpriteAnimation.ignoreTimeScale = true

Should this animation be affected by time scale?

bool UI2DSpriteAnimation.loop = true

Should this animation be looped?

Property Documentation

int UI2DSpriteAnimation.framesPerSecond
getset

Animation framerate.

bool UI2DSpriteAnimation.isPlaying
get

Returns is the animation is still playing or not


The documentation for this class was generated from the following file: