Skip to content

TweenObject

An object that represents tween

Properties

  • Looped: boolean
  • Parallel: boolean
  • SpeedScale: number
  • IsRunning: boolean
  • ElapsedTime: number

Methods

SetDirection(dir: TweenDirectionEnum) → TweenObject

Set the direction of this tween. This function returns a TweenObject which means you can stack it with other functions.

SetTrans(trans: TweenTransitionEnum) → TweenObject

Set the transition of this tween. This function returns a TweenObject which means you can stack it with other functions.

TweenPosition(target: Dynamic, destination: Vector3, time: number) → nil

Tweens the position of a Dynamic.

TweenRotation(target: Dynamic, destination: Vector3, time: number) → nil

Tweens the rotation of a Dynamic.

TweenSize(target: Dynamic, destination: Vector3, time: number) → nil

Tweens the size of a Dynamic.

TweenColor(from: Color, to: Color, time: number, callback: function) → nil

Tweens a color between two specified values.

TweenNumber(from: number, to: number, time: number, callback: function) → nil

Tweens a number between two specified values.

TweenVector2(from: Vector2, to: Vector2, time: number, callback: function) → nil

Tweens a Vector2 between two specified values.

TweenVector3(from: Vector3, to: Vector3, time: number, callback: function) → nil

Tweens a Vector3 between two specified values.

TweenQuaternion(from: Quaternion, to: Quaternion, time: number, callback: function) → nil

Tweens a Quaternion between two specified values.

Play() → nil

Play this tween

Pause() → nil

Pause this tween

Stop() → nil

Stop this tween

Interval(sec: number) → nil

Creates a delay in the tween.

Chain() → TweenObject

Chain a tween if parallel is set to true

Cancel(callFinsihed: boolean) → nil

Cancel this tween

Events

  • Finished: Fires when this tween has finished
  • Canceled: Fires when this tween has been canceled