Udim

Overview

UDim is a data type used to express a value along a single axis, including both a scale value proportional to the entire size and a fixed offset correction value in pixel. With this, a position or size that dynamically adjusts itself according to screen size while maintaining a certain pixel offset can be calculated.

Constructors

new

Creates a single UDim object based on the passed scale value and offset value, and returns it. The created UDim can be used to calculate one-dimensional position or size.

Parameters

number InScale	The relative scale value applied relative to the size of parent.
number InOffset	The absolute value applied in pixel.

Return

UDim	The UDim consisted of the specified scale and offset values.

Code Samples

local UDim = UDim.new(0.5, 100)

Properties

Scale

number

The relative scale value applied relative to the size of parent.

Code Samples

local UDim = UDim.new(0.5, 0)

print(UDim.Scale)

Offset

number

The absolute value applied in pixel.

Code Samples

local UDim = UDim.new(0, 100)

print(UDim.Offset)

Methods