Skip to content

UIField

UIField is the base class of all UI classes.

Abstract Object

This object exists only to serve as a foundation for other objects. It cannot be accessed directly, but its properties are documented below.

Additionally, it cannot be created in the creator menu or with Instance.New().

Inherits Instance

Events

MouseDown

Fires when the mouse is clicked

Example

label.MouseDown:Connect(function()
    label.Text = "Mouse Down"
end)

MouseUp

Fires when the mouse is released

Example

label.MouseUp:Connect(function()
    label.Text = "Mouse Up"
end)

Properties

PivotPoint : Vector2 = Vector2.New(0.5, 0.5)

The pivot point of the UI element.

PositionOffset : Vector2 = Vector2.New(100, 100)

The offset of the UI element in pixels.

PositionRelative : Vector2 = Vector2.New(0.5, 0.5)

The position of the UI element relative to its parent.

Rotation : float

The rotation of the UI element.

SizeOffset : Vector2 = Vector2.New(100, 100)

The size of the UI element in pixels.

SizeRelative : Vector2 = Vector2.New(1, 1)

The size of the UI element relative to its parent.

Visible : boolean

Determines whether the UI element is visible or not.