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

Play the specified tween on click. More...

Inheritance diagram for UIPlayTween:

Public Member Functions

void Play (bool forward)
 Activate the tweeners. More...
 

Public Attributes

GameObject tweenTarget
 Target on which there is one or more tween. More...
 
int tweenGroup = 0
 If there are multiple tweens, you can choose which ones get activated by changing their group. More...
 
Trigger trigger = Trigger.OnClick
 Which event will trigger the tween. More...
 
Direction playDirection = Direction.Forward
 Direction to tween in. More...
 
bool resetOnPlay = false
 Whether the tween will be reset to the start or end when activated. If not, it will continue from where it currently is. More...
 
bool resetIfDisabled = false
 Whether the tween will be reset to the start if it's disabled when activated. More...
 
EnableCondition ifDisabledOnPlay = EnableCondition.DoNothing
 What to do if the tweenTarget game object is currently disabled. More...
 
DisableCondition disableWhenFinished = DisableCondition.DoNotDisable
 What to do with the tweenTarget after the tween finishes. More...
 
bool includeChildren = false
 Whether the tweens on the child game objects will be considered. More...
 
List< EventDelegateonFinished = new List<EventDelegate>()
 Event delegates called when the animation finishes. More...
 

Static Public Attributes

static UIPlayTween current
 

Detailed Description

Play the specified tween on click.

Member Function Documentation

void UIPlayTween.Play ( bool  forward)

Activate the tweeners.

Member Data Documentation

UIPlayTween UIPlayTween.current
static
DisableCondition UIPlayTween.disableWhenFinished = DisableCondition.DoNotDisable

What to do with the tweenTarget after the tween finishes.

EnableCondition UIPlayTween.ifDisabledOnPlay = EnableCondition.DoNothing

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

bool UIPlayTween.includeChildren = false

Whether the tweens on the child game objects will be considered.

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

Event delegates called when the animation finishes.

Direction UIPlayTween.playDirection = Direction.Forward

Direction to tween in.

bool UIPlayTween.resetIfDisabled = false

Whether the tween will be reset to the start if it's disabled when activated.

bool UIPlayTween.resetOnPlay = false

Whether the tween will be reset to the start or end when activated. If not, it will continue from where it currently is.

Trigger UIPlayTween.trigger = Trigger.OnClick

Which event will trigger the tween.

int UIPlayTween.tweenGroup = 0

If there are multiple tweens, you can choose which ones get activated by changing their group.

GameObject UIPlayTween.tweenTarget

Target on which there is one or more tween.


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