UDim2

Show Deprecated

The UDim2 data type represents a two-dimensional value where each dimension is composed of a relative scale and an absolute offset in pixels. It is a combination of two UDim data types representing the X and Y dimensions. The most common usages for UDim2 are setting the Size and Position of GuiObjects.

local guiObject = script.Parent

guiObject.Size = UDim2.new(0, 300, 1, 0)  -- 300 pixels wide; full height of parent

guiObject.Position = UDim2.new(0, 50, 0, 0)  -- 50 pixels from the left

Summary

Constructors

Properties

  • X:UDim

    The X dimension scale and offset of the UDim2.

  • Y:UDim

    The Y dimension scale and offset of the UDim2.

  • Width:UDim

    The X dimension scale and offset of the UDim2.

  • Height:UDim

    The Y dimension scale and offset of the UDim2.

Methods

  • Lerp(goal : UDim2,alpha : number):UDim2

    Returns a UDim2 interpolated linearly between the value and the given goal.

Constructors

new

new

Parameters

xScale: number
Default Value: 0
xOffset: number
Default Value: 0
yScale: number
Default Value: 0
yOffset: number
Default Value: 0

new

Parameters

x: UDim
y: UDim

fromScale

Parameters

xScale: number
Default Value: 0
yScale: number
Default Value: 0

fromOffset

Parameters

xOffset: number
Default Value: 0
yOffset: number
Default Value: 0

Properties

X

UDim

The X dimension scale and offset of the UDim2.

Y

UDim

The Y dimension scale and offset of the UDim2.

Width

UDim

The X dimension scale and offset of the UDim2.

Height

UDim

The Y dimension scale and offset of the UDim2.

Methods

Lerp

UDim2

Returns a UDim2 interpolated linearly between this UDim2 and the given goal. The alpha value should be a number between 0 and 1.

Parameters

goal: UDim2
alpha: number

Returns

UDim2

Math Operations