TweenSizeAndPosition

Unsafe

For thread safety, this property is not safe to read in an unsynchronized thread.

Function of:

Description:

Smoothly resizes and moves a GUI to a new DataType/UDim2 size and position in the specified time using the specified Enum/EasingDirection|EasingDirection and Enum/EasingStyle|EasingStyle.

This function will return whether the tween will play. Normally this will always return true, but it will return false if another tween is active and override is set to false.

Parameters

Name	Type	Default	Description
Name endSize	Type UDim2	Default	Summary The size that the GUI should resize
Name endPosition	Type UDim2	Default	Summary Where the GUI should move to
Name easingDirection	Type EasingDirection	Default Out	Summary The direction in which to ease the GUI to the endSize and endPosition
Name easingStyle	Type EasingStyle	Default Quad	Summary The style in which to ease the GUI to the endSize and endPosition
Name time	Type float	Default 1	Summary How long, in seconds, the tween should take to complete
Name override	Type bool	Default false	Summary Whether the tween will override an in-progress tween
Name callback	Type Function	Default nil	Summary A callback function to execute when the tween completes

Returns

Return Type	Summary
Return Type bool	Summary Whether the tween will play

Code Samples

Tween a GUI's Size and Position

The below example would tween a /Frame to the top left of the parent’s size and resize it down to 0.

			
				Tween a GUI's Size and Position

				Expected Output
			
				Expand
				
			local frame = script.Parent.Frame
frame:TweenSizeAndPosition(UDim2.new(0,0,0,0), UDim2.new(0,0,0,0))
		
				Copy Code
			
				Light Theme

TweenSizeAndPosition

See also

Parameters

Returns

Code Samples

Tween a GUI's Size and Position