Library

UDim2

table

Constructor and helpers for the UDim2 datatype (two-dimensional scale plus offset).

Functions

3

#UDim2.new(xScale: number | UDim, xOffset: number | UDim?, yScale: number?, yOffset: number?) → UDim2

since 0.5.4a-alpha

Creates a UDim2. Accepts either four numbers (xScale, xOffset, yScale, yOffset) or two UDim values (x, y).

Parameters

xScalenumber | UDim

X scale or X UDim.

xOffsetnumber | UDim?

X offset or Y UDim.

yScalenumber?

Y scale (only when using 4-number form).

yOffsetnumber?

Y offset (only when using 4-number form).

#UDim2.fromScale(x: number, y: number) → UDim2

since 0.5.4a-alpha

Creates a UDim2 with scale components (x, y) and zero offsets.

Parameters

xnumber

X scale.

ynumber

Y scale.

#UDim2.fromOffset(x: number, y: number) → UDim2

since 0.5.4a-alpha

Creates a UDim2 with offset components (x, y) and zero scales.

Parameters

xnumber

X offset.

ynumber

Y offset.