Tweens

Import Weave.Tween from the Weave module.

local Weave = require(ReplicatedStorage.Weave)
local Tween = Weave.Tween

Tween values Tween any Weave Value or Computed

local value = Value.new(0)
local tweenInfo = TweenInfo.new(1, Enum.EasingStyle.Linear)

local tweenValue = Tween(value, tweenInfo)

✨ Tween values update automatically ✨

value:set(5)

task.wait(0.5) -- wait half the duration

tweenValue:get() -- 2.5

Tweens follow the value of Weave state using an animation curve.

Usage¶

Call the Tween function with a Weave Value and a TweenInfo

local value = Value.new(0)
local tweenInfo = TweenInfo.new(0.3, Enum.EasingStyle.Quad)

local animated = Tween(value, tweenInfo)

You can :get() its value at any time.

print(animated:get()) --> 0.26425...

TweenInfo can also be a Weave Value or Computed

local goal = Value.new(0)
local tweenInfo = Value.new(TweenInfo.new(0.5, Enum.EasingStyle.Quad))

local animated = Tween(target, tweenInfo)

Tween can transition any number-based Luau type:

local partPosition = Value.new(Vector3.new())

local mousePosition = Value.new(Vector2.new())

local partColor = Value.new(Color3.new(0, 0, 0))

local framePosition = Value.new(UDim2.new(0.5, 0, 0, 0))

local modelPosition = Value.new(CFrame.new())

local tweenInfo = TweenInfo.new(0.5, Enum.EasingStyle.Quad)

local partTween  = Tween(partPosition, tweenInfo)
local mouseTween = Tween(mousePosition, tweenInfo)
local colorTween  = Tween(partPosition, tweenInfo)
local frameTween = Tween(framePosition, tweenInfo)
local modelTween = Tween(modelPosition, tweenInfo)