Open Asterune
Tween

Tween

Controls playback of a property interpolation.

Behavior

Tween is returned by TweenService:Create. Creation does not start playback. Call Play to begin.

Other scripts and physics can change the same properties during playback. Anchor parts before tweening their transforms.

Summary

Members5
Properties1
Methods3
  • Cancel(): ()

    Stops playback, sets PlaybackState to Cancelled, and removes the active tween.

  • Pause(): ()

    Pauses playback while retaining progress.

  • Play(): ()

    Starts playback or resumes a paused tween.

Events1
  • Completed: RBXScriptSignalread only

    Fires when playback reaches its final endpoint and passes Enum.PlaybackState.Completed.

Properties

PlaybackState

Tween.PlaybackState: EnumItem

The current playback state, such as playing, paused, completed, or cancelled.

Methods

Cancel

Tween:Cancel(): ()

Stops playback, sets PlaybackState to Cancelled, and removes the active tween. Animated properties retain their current values. Completed does not fire.

Pause

Tween:Pause(): ()

Pauses playback while retaining progress. Call Play to resume.

Play

Tween:Play(): ()

Starts playback or resumes a paused tween. Has no effect if the tween is already playing.

Events

Completed

Tween.Completed: RBXScriptSignal

Fires when playback reaches its final endpoint and passes Enum.PlaybackState.Completed. Cancel does not fire this event. Indefinitely repeating tweens do not complete.

Operators

__type

Example

Luau
-- Requires an anchored Part named Door.
local TweenService = game:GetService("TweenService")
local door = workspace:WaitForChild("Door")
local tween = TweenService:Create(door, TweenInfo.new(1), { Transparency = 1 })
tween:Play()
tween:Pause()
tween:Cancel()

Used by

TweenService

Related APIs

TweenInfo · TweenService · Enum.EasingStyle