TweenInfo

The TweenInfo data type stores parameters for TweenService:Create() to specify the behavior of the tween. The properties of a TweenInfo cannot be written to after its creation.

Constructors

Name	Type / Returns	Description
TweenInfo.new		Creates a new `TweenInfo` from the provided parameters.

TweenInfo.new

Creates a new TweenInfo from the provided parameters.

Parameters

Name	Type	Default	Description
time	number	1	Duration for the tween, in seconds.
easingStyle	EasingStyle	Enum.EasingStyle.Quad	Easing style for the tween.
easingDirection	EasingDirection	Enum.EasingDirection.Out	The direction in which the tween executes.
repeatCount	number	0	Number of times the tween should repeat. `-1` repeats indefinitely.
reverses	bool	false	Whether the tween should reverse to the starting values once it reaches its targets.
delayTime	number	0	Time of delay until the tween begins, in seconds.

Properties

Name	Type / Returns	Description
TweenInfo.EasingDirection	EasingDirection	The direction in which the tween executes.
TweenInfo.Time	number	Duration of the tween, in seconds.
TweenInfo.DelayTime	number	Time of delay until the tween begins, in seconds.
TweenInfo.RepeatCount	number	Number of times the tween repeats.
TweenInfo.EasingStyle	EasingStyle	The style in which the tween executes.
TweenInfo.Reverses	bool	Whether or not the tween interpolates in reverse tween once the initial tween completes.

TweenInfo.EasingDirection

The direction in which the tween executes.

Field	Value
type	EasingDirection

TweenInfo.Time

Duration of the tween, in seconds.

Field	Value
type	number

TweenInfo.DelayTime

Time of delay until the tween begins, in seconds.

Field	Value
type	number

TweenInfo.RepeatCount

Number of times the tween repeats. -1 indicates indefinite repetition.

Field	Value
type	number

TweenInfo.EasingStyle

The style in which the tween executes.

Field	Value
type	EasingStyle

TweenInfo.Reverses

Whether or not the tween interpolates in reverse tween once the initial tween completes.

Field	Value
type	bool