TweenObject¶
An object that represents tween
Not newable
This object cannot be created by scripts using Instance.New().
Properties¶
Looped : boolean¶
Determines if this tween is looped
Parallel : boolean¶
Determines if this tween will run all the tweens in parallel
SpeedScale : number¶
Determines the speed scale of this tween
IsRunning : boolean¶
Returns whether or not this tween is running
ElapsedTime : number¶
Returns the elapsed time of this tween
Methods¶
SetDirection → TweenObject¶
Parameters: dir [ TweenDirection ]
Set the direction of this tween. This function returns a TweenObject which means you can stack it with other functions.
SetTrans → TweenObject¶
Parameters: trans [ TweenTransition ]
Set the transition of this tween. This function returns a TweenObject which means you can stack it with other functions.
TweenPosition → nil¶
Tweens the position of a Dynamic.
TweenRotation → nil¶
Tweens the rotation of a Dynamic.
TweenSize → nil¶
Tweens the size of a Dynamic.
TweenColor → nil¶
Tweens a color between two specified values.
TweenNumber → nil¶
Parameters
from [ number ]
to [ number ]
time [ number ]
callback [ function ]
Tweens a number between two specified values.
TweenVector2 → nil¶
Tweens a Vector2 between two specified values.
TweenVector3 → nil¶
Tweens a Vector3 between two specified values.
Play → nil¶
Parameters: ``
Play this tween
Pause → nil¶
Parameters: ``
Pause this tween
Stop → nil¶
Parameters: ``
Stop this tween
Interval → nil¶
Parameters: sec [ number ]
Creates a delay in the tween.
Chain → TweenObject¶
Parameters: ``
Chain a tween if parallel is set to true
Cancel → nil¶
Parameters: callFinsihed [ boolean? ]
Cancel this tween
Events¶
Finished¶
Parameters: ``
Fires when this tween has finished
Canceled¶
Parameters: ``
Fires when this tween has been canceled