Skip to content

TweenService

Supported Class Services NotCreatable Service

Used to create Tweens which interpolate, or tween, the properties of instances.

2 Nova members · 1 modern Roblox members not implemented yet

Description

TweenService is used to create Tweens which interpolate, or tween, the properties of instances. Tweens can be used on any object with compatible property types, including:

TweenService.Create(), the primary constructor function, takes TweenInfo specifications about the tween and generates the Tween object which can then be used to play the tween.

Note that Tweens can interpolate multiple properties at the same time, but they must not be interpolating the same property. If two tweens attempt to modify the same property, the initial tween will be cancelled and overwritten by the most recent tween.

Inheritance

Object → Instance → TweenService

Nova inheritance: Instance → TweenService

Methods

Create Supported Function Creates a new Tween given the object whose properties are to be tweened, a TweenInfo, and a dictionary of goal property values.
TweenService:Create(Instance instance, TweenInfo tweenInfo, Dictionary propertyTable): Instance

Creates a new Tween given the object whose properties are to be tweened, a TweenInfo, and a dictionary of goal property values.

This constructor creates a new Tween from three arguments: the object to tween, the TweenInfo specifications, and a table containing the properties to tween and values to tween to.

The propertyTable parameter needs to be a dictionary where the keys are the string names of the property (for example Position, Transparency, or Color), and the values are the property targets at the end of the tween.

The Tween created using this function is unique to the object given as the instance parameter. To apply the same tween to another object, call this function again with the new object.

Roblox reference signature
TweenService:Create(instance: Instance, tweenInfo: TweenInfo, propertyTable: Dictionary): Tween

Roblox documentation

GetValue Supported Function Calculates a new alpha given an EasingStyle and EasingDirection.
TweenService:GetValue(double alpha, EasingStyle easingStyle, EasingDirection easingDirection): double

Calculates a new alpha given an EasingStyle and EasingDirection.

Returns a new alpha value for interpolating using the given alpha value, EasingStyle, and EasingDirection. The provided alpha value will be clamped between 0 and 1. This method raises an error if easingStyle is EasingStyle.Bezier or EasingStyle.Spring.

Roblox reference signature
TweenService:GetValue(alpha: float, easingStyle: EasingStyle, easingDirection: EasingDirection): float

Roblox documentation

Inherited members

Inherited from Instance: 8 properties, 36 methods, 7 events. They are documented on the base class page.

1 modern Roblox member(s) are not implemented yet — expand to inspect

Members declared by Roblox's TweenService class (or by a missing base class) that Nova does not expose. Use this list to scope a migration; the compatibility guide has the recommended workaround.

Methods

Member Signature Status Notes Flags
SmoothDamp TweenService:SmoothDamp(current: Variant, target: Variant, velocity: Variant, smoothTime: float, maxSpeed: float?, dt: float?): (Variant, Variant) Not yet Smoothly interpolates a value towards a target, simulating a critically damped spring. —

Roblox reference: TweenService

Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.