Tween
CreatorHub

The Tween object controls the playback of an interpolation.

Memory category	Instances

Member index 2

History		Member
553		Instance: Instance
553		TweenInfo: TweenInfo
5 members inherited from TweenBase
553		PlaybackState: PlaybackState
573		Cancel(): null
573		Pause(): null
573		Play(): null
462		Completed(playbackState: PlaybackState)
63 members inherited from Instance
553		Archivable: bool
553		Attributes: string
553		AttributesReplicate: string
553		AttributesSerialize: BinaryString
635		Capabilities: SecurityCapabilities
553		DataCost: int
619		DefinesCapabilities: bool
553		HistoryId: UniqueId
553		Name: string
553		Parent: Instance
553		PropertyStatusStudio: PropertyStatus
553		RobloxLocked: bool
635		Sandboxed: bool
616		SourceAssetId: int64
553		Tags: BinaryString
616		UniqueId: UniqueId
553		archivable: bool
553		numExpectedDirectChildren: int
576		AddTag(tag: string): null
573		ClearAllChildren(): null
462		Clone(): Instance
573		Destroy(): null
486		FindFirstAncestor(name: string): Instance
486		FindFirstAncestorOfClass(className: string): Instance
486		FindFirstAncestorWhichIsA(className: string): Instance
486		FindFirstChild(name: string, recursive: bool = false): Instance
486		FindFirstChildOfClass(className: string): Instance
486		FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486		FindFirstDescendant(name: string): Instance
563		GetActor(): Actor
486		GetAttribute(attribute: string): Variant
462		GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631		GetAttributes(): Dictionary
648		GetChildren(): Instances
462		GetDebugId(scopeLength: int = 4): string
486		GetDescendants(): Array
486		GetFullName(): string
641		GetStyled(name: string): Variant
576		GetTags(): Array
576		HasTag(tag: string): bool
486		IsAncestorOf(descendant: Instance): bool
486		IsDescendantOf(ancestor: Instance): bool
580		IsPropertyModified(name: string): bool
573		Remove(): null
576		RemoveTag(tag: string): null
580		ResetPropertyToDefault(name: string): null
573		SetAttribute(attribute: string, value: Variant): null
462		WaitForChild(childName: string, timeOut: double): Instance
648		children(): Instances
553		clone(): Instance
573		destroy(): null
553		findFirstChild(name: string, recursive: bool = false): Instance
648		getChildren(): Instances
553		isDescendantOf(ancestor: Instance): bool
573		remove(): null
462		AncestryChanged(child: Instance, parent: Instance)
462		AttributeChanged(attribute: string)
462		ChildAdded(child: Instance)
462		ChildRemoved(child: Instance)
462		DescendantAdded(descendant: Instance)
462		DescendantRemoving(descendant: Instance)
500		Destroying()
553		childAdded(child: Instance)
6 members inherited from Object
647		ClassName: string
647		className: string
647		GetPropertyChangedSignal(property: string): RBXScriptSignal
647		IsA(className: string): bool
650		isA(className: string): bool
647		Changed(property: string)

Description

The Tween object controls the playback of an interpolation. Creating and configuring a Tween is done with the TweenService:Create() function; Instance.new() cannot be used for this particular object.

Note that while the configuration of a tween can be accessed after a tween has been created, it can not be modified. If new goals are needed for an interpolation, a new Tween must be created.

Also note that multiple tweens can be played on the same object 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.

History 10
Hide member changes

553 Change Default of TweenInfo from to TweenInfo(Time:1 DelayTime:0 RepeatCount:0 Reverses:False EasingDirection:Out EasingStyle:Quad)
553 Change Default of Instance from to
486 Change ThreadSafety of TweenInfo from ReadOnly to ReadSafe
486 Change ThreadSafety of Instance from ReadOnly to ReadSafe
462 Change ThreadSafety of TweenInfo from to ReadOnly
462 Change ThreadSafety of Instance from to ReadOnly
329 Change ValueType of Instance from Object to Instance
288 Add TweenInfo
288 Add Instance
288 Add Tween

Members 2

Instance
CreatorHub

Type		Default
Instance

The Instance property of a Tween (read-only) points to the Instance whose properties are being interpolated.

Its interface does not cross the network boundary.

Its value can be read, but it cannot be modified.

Thread safety	ReadSafe
Category	Data
Loaded/Saved	false

History 5

553 Change Default of Instance from to
486 Change ThreadSafety of Instance from ReadOnly to ReadSafe
462 Change ThreadSafety of Instance from to ReadOnly
329 Change ValueType of Instance from Object to Instance
288 Add Instance

Tags: [ReadOnly, NotReplicated]

TweenInfo
CreatorHub

Type		Default
TweenInfo		Time:1 DelayTime:0 RepeatCount:0 Reverses:False EasingDirection:Out EasingStyle:Quad

Read-only property that includes information on how the interpolation of the Tween is to be carried out, using the TweenInfo data type.

Its interface does not cross the network boundary.

Its value can be read, but it cannot be modified.

Thread safety	ReadSafe
Category	Data
Loaded/Saved	false

History 4

553 Change Default of TweenInfo from to TweenInfo(Time:1 DelayTime:0 RepeatCount:0 Reverses:False EasingDirection:Out EasingStyle:Quad)
486 Change ThreadSafety of TweenInfo from ReadOnly to ReadSafe
462 Change ThreadSafety of TweenInfo from to ReadOnly
288 Add TweenInfo

Tags: [ReadOnly, NotReplicated]

Reference API Roblox

Engine API

Website

Related