Skip to main content
You cannot Instance this class with Instance.new()

​
Properties

​
Functions

​
TweenProperty(object, propertyName, value, time)

The TweenProperty is used to tween property of any object (if it is supported). An example: 
local TweenService = Game:GetService("TweenService")
local myTween = TweenService:Create()
myTween:TweenProperty(Map.Cube, "position", Vector3.new(5, 5, 5), 1.0)

​
Kill()

Kills the active tween. An example: 
local TweenService = Game:GetService("TweenService")
local myTween = TweenService:Create()
myTween:TweenProperty(Map.Cube, "position", Vector3.new(5, 5, 5), 1.0)
myTween:Kill()

​
Stop()

Stops an active tween. An example: 
local TweenService = Game:GetService("TweenService")
local myTween = TweenService:Create()
myTween:TweenProperty(Map.Cube, "position", Vector3.new(5, 5, 5), 5.0)
wait(2.5)
myTween:Stop() -- stopped the tween after 2.5 seconds. This can be resumed

​
Play()

Plays an inactive tween. An example: 
local TweenService = Game:GetService("TweenService")
local myTween = TweenService:Create()
myTween:TweenProperty(Map.Cube, "position", Vector3.new(5, 5, 5), 5.0)
wait(2.5)
myTween:Stop() -- stop the tween after 2.5 seconds
wait(2.5)
myTween:Play() -- play the tween after 2.5 seconds

​
Signals

​
OnTweenCompleted

Is played when a tween is completed. An example: 
local TweenService = Game:GetService("TweenService")
local myTween = TweenService:Create()
myTween:Connect("OnTweenCompleted", __SCRIPT__, "ExampleFunction")
myTween:TweenProperty(Map.Cube, "position", Vector3.new(5, 5, 5), 5.0)

function ExampleFunction() 
    myTween = nil
    printl("Finished!")
end