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

Play the specified animation on click. More...

Inheritance diagram for UIPlayAnimation:

Public Member Functions

void Play (bool forward)
 Start playing the animation. More...
 
void Play (bool forward, bool onlyIfDifferent)
 Start playing the animation. More...
 

Public Attributes

Animation target
 Target animation to activate. More...
 
Animator animator
 Target animator system. More...
 
string clipName
 Optional clip name, if the animation has more than one clip. More...
 
Trigger trigger = Trigger.OnClick
 Which event will trigger the animation. More...
 
Direction playDirection = Direction.Forward
 Which direction to animate in. More...
 
bool resetOnPlay = false
 Whether the animation's position will be reset on play or will continue from where it left off. More...
 
bool clearSelection = false
 Whether the selected object (this button) will be cleared when the animation gets activated. More...
 
EnableCondition ifDisabledOnPlay = EnableCondition.DoNothing
 What to do if the target game object is currently disabled. More...
 
DisableCondition disableWhenFinished = DisableCondition.DoNotDisable
 What to do with the target when the animation finishes. More...
 
List< EventDelegateonFinished = new List<EventDelegate>()
 Event delegates called when the animation finishes. More...
 

Static Public Attributes

static UIPlayAnimation current = null
 

Detailed Description

Play the specified animation on click.

Member Function Documentation

void UIPlayAnimation.Play ( bool  forward)

Start playing the animation.

void UIPlayAnimation.Play ( bool  forward,
bool  onlyIfDifferent 
)

Start playing the animation.

Member Data Documentation

Animator UIPlayAnimation.animator

Target animator system.

bool UIPlayAnimation.clearSelection = false

Whether the selected object (this button) will be cleared when the animation gets activated.

string UIPlayAnimation.clipName

Optional clip name, if the animation has more than one clip.

UIPlayAnimation UIPlayAnimation.current = null
static
DisableCondition UIPlayAnimation.disableWhenFinished = DisableCondition.DoNotDisable

What to do with the target when the animation finishes.

EnableCondition UIPlayAnimation.ifDisabledOnPlay = EnableCondition.DoNothing

What to do if the target game object is currently disabled.

List<EventDelegate> UIPlayAnimation.onFinished = new List<EventDelegate>()

Event delegates called when the animation finishes.

Direction UIPlayAnimation.playDirection = Direction.Forward

Which direction to animate in.

bool UIPlayAnimation.resetOnPlay = false

Whether the animation's position will be reset on play or will continue from where it left off.

Animation UIPlayAnimation.target

Target animation to activate.

Trigger UIPlayAnimation.trigger = Trigger.OnClick

Which event will trigger the animation.


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