TweenSize

Unsafe

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

Function of:

Description:

Smoothly resizes a GUI to a new DataType/UDim2 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 easingDirection	Type EasingDirection	Default Out	Summary The direction in which to ease the GUI to the endSize
Name easingStyle	Type EasingStyle	Default Quad	Summary The style in which to ease the GUI to the endSize
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 GuiObject's Size

This code sample demonstrates the usage of the GuiObject/TweenSize function. It initiates an animation on the parent’s GuiObject/Size property to UDim2.new(0.5, 0, 0.5, 0), which is half the GuiObject’s parent size on both axes.

Additionally, it demonstrates how the callback parameter can be used to detect when the tween stops (whether it was cancelled by another tween or completed).

			
				Tween a GuiObject's Size

				Expected Output
			
				Expand
				
			local guiObject = script.Parent

local function callback(didComplete)
	if didComplete then
		print("The tween completed successfully")
	else
		print("The tween was cancelled")
	end
end

local willTween = guiObject:TweenSize(
	UDim2.new(0.5, 0, 0.5, 0),  -- endSize (required)
	Enum.EasingDirection.In,    -- easingDirection (default Out)
	Enum.EasingStyle.Sine,      -- easingStyle (default Quad)
	2,                          -- time (default: 1)
	true,                       -- should this tween override ones in-progress? (default: false)
	callback                    -- a function to call when the tween completes (default: nil)
)

if willTween then
	print("The GuiObject will tween") 
else
	print("The GuiObject will not tween")
end
		
			The GuiObject will tween
The tween was completed successfully
		
				Copy Code
			
				Light Theme

TweenSize

See also

Parameters

endSize

easingDirection

easingStyle

time

override

callback

Returns

bool

Code Samples

Tween a GuiObject's Size