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

Mainly an internal script used by UIButtonPlayAnimation, but can also be used to call the specified function on the game object after it finishes animating. More...

Inheritance diagram for ActiveAnimation:

Public Member Functions

void Finish ()
 Immediately finish playing the animation. More...
 
void Reset ()
 Manually reset the active animation to the beginning. More...
 

Static Public Member Functions

static ActiveAnimation Play (Animation anim, string clipName, Direction playDirection, EnableCondition enableBeforePlay, DisableCondition disableCondition)
 Play the specified animation on the specified object. More...
 
static ActiveAnimation Play (Animation anim, string clipName, Direction playDirection)
 Play the specified animation. More...
 
static ActiveAnimation Play (Animation anim, Direction playDirection)
 Play the specified animation. More...
 
static ActiveAnimation Play (Animator anim, string clipName, Direction playDirection, EnableCondition enableBeforePlay, DisableCondition disableCondition)
 Play the specified animation on the specified object. More...
 

Public Attributes

List< EventDelegateonFinished = new List<EventDelegate>()
 Event delegates called when the animation finishes. More...
 
GameObject eventReceiver
 
string callWhenFinished
 

Static Public Attributes

static ActiveAnimation current
 Active animation that resulted in the event notification. More...
 

Properties

bool isPlaying [get]
 Whether the animation is currently playing. More...
 

Detailed Description

Mainly an internal script used by UIButtonPlayAnimation, but can also be used to call the specified function on the game object after it finishes animating.

Member Function Documentation

void ActiveAnimation.Finish ( )

Immediately finish playing the animation.

static ActiveAnimation ActiveAnimation.Play ( Animation  anim,
string  clipName,
Direction  playDirection,
EnableCondition  enableBeforePlay,
DisableCondition  disableCondition 
)
static

Play the specified animation on the specified object.

static ActiveAnimation ActiveAnimation.Play ( Animation  anim,
string  clipName,
Direction  playDirection 
)
static

Play the specified animation.

static ActiveAnimation ActiveAnimation.Play ( Animation  anim,
Direction  playDirection 
)
static

Play the specified animation.

static ActiveAnimation ActiveAnimation.Play ( Animator  anim,
string  clipName,
Direction  playDirection,
EnableCondition  enableBeforePlay,
DisableCondition  disableCondition 
)
static

Play the specified animation on the specified object.

void ActiveAnimation.Reset ( )

Manually reset the active animation to the beginning.

Member Data Documentation

string ActiveAnimation.callWhenFinished
ActiveAnimation ActiveAnimation.current
static

Active animation that resulted in the event notification.

GameObject ActiveAnimation.eventReceiver
List<EventDelegate> ActiveAnimation.onFinished = new List<EventDelegate>()

Event delegates called when the animation finishes.

Property Documentation

bool ActiveAnimation.isPlaying
get

Whether the animation is currently playing.


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