Reference/Classes/GuiObject
Class

GuiObject

since 0.5.4a-alpha

Base class for all on-screen 2D UI elements (frames, labels, buttons, etc.).

InheritsInstance
Inherited byImageLabel, TextLabel

Properties

11
NameTypeAccessDescription
ZIndexnumberread

The rendering order for this GuiObject, highest renders on last, and thus, on top of every other UI element.

since 1.7.1-alphaRoblox ↗
LayoutOrdernumberread

Controls the sort order when using a StyleLayout.

since 1.7.1-alphaRoblox ↗
Activebooleanread

If true, the object will sink inputs from the 3D world (for GuiButton objects, it defines whether events are fired upon actioning the UI element).

since 1.7.1-alphaRoblox ↗
Visiblebooleanread

Whether the item and its descendants will be rendered.

since 1.7.1-alphaRoblox ↗
Interactablebooleanread

Whether the GuiObject is 'Interactable'. Refer to official Roblox documentation for the '*' in this property.

since 1.7.1-alphaRoblox ↗
Rotationnumberread

The rotation for this GuiObject in degrees.

since 1.7.1-alphaRoblox ↗
BackgroundColor3Color3read

The color of the GUI object's background.

since 1.7.1-alphaRoblox ↗
SizeUDim2readwrite

The size of the element, as a UDim2 (scale plus offset).

since 1.6.0-alphaRoblox ↗
PositionUDim2readwrite

The position of the element, as a UDim2 (scale plus offset).

since 1.6.0-alphaRoblox ↗
AbsolutePositionVector2read

The element's actual on-screen position in pixels, after layout is resolved.

since 1.6.7-alphaRoblox ↗
AbsoluteSizeVector2read

The element's actual on-screen size in pixels, after layout is resolved.

since 1.6.7-alphaRoblox ↗