This property determines whether the GuiObject will sink input to 3D space, such as underlying models with a ClickDetector class like DragDetector.

For GuiButton objects (ImageButton and TextButton), this property determines whether Activated fires (AutoButtonColor will still work for those as well). The events InputBegan, InputChanged, and InputEnded work as normal no matter the value of this property.

This property determines the origin point of a GuiObject, relative to its absolute size. The origin point determines from where the element is positioned (through GuiObject.Position) and from which the rendered GuiObject.Size expands.

See here for illustrated diagrams and details.

This property is used to automatically size parent UI objects based on the size of its descendants. You can use this property to dynamically add text and other content to a UI object at edit or run time, and the size will adjust to fit that content.

When AutomaticSize is set to an AutomaticSize value to anything other than None, this UI object may resize depending on its child content.

For more information on how to use this property and how it works, please see here.

This property determines the color of a GuiObject background (the fill color). If your element contains text, such as a TextBox, TextButton, or TextLabel, make sure the color of your background contrasts the text's color.

Another property that determines the visual properties of the background is GuiObject.BackgroundTransparency; if this is set to 1, neither the background nor the border will render.

See also BorderColor3.

This property determines the transparency of the GuiObject background and border. It does not, however, determine the transparency of text if the GUI is a TextBox, TextButton, or TextLabel; text transparency is determined TextBox.TextTransparency, TextButton.TextTransparency, and TextLabel.TextTransparency respectively.

If this property is set to 1, neither the background nor the border will render and the GUI background will be completely transparent.

Determines the color of the GuiObject rectangular border (also known as the stroke color). This is separate from the object's GuiObject.BackgroundColor3. You will not be able to see the object's border if its GuiObject.BorderSizePixel property is set to 0.

Note that the UIStroke component allows for more advanced border effects.

This property determines in what manner the GuiObject border is laid out relative to its dimensions using the enum of the same name, BorderMode.

Note that UIStroke can override this property and allow for more advanced border effects.

This property determines how wide the GuiObject border renders, in pixels. Setting this to 0 disables the border altogether.

Note that UIStroke can override this property and allow for more advanced border effects.

This property determines if the GuiObject will clip (make invisible) any portion of descendant GUI elements that would otherwise render outside the bounds of the rectangle.

Note that Rotation isn't supported by this property. If this or any ancestor GUI has a non‑zero Rotation, this property is ignored and descendant GUI elements will be rendered regardless of this property's value.

When the player's finger is being tapped and held on the GuiObject, the GuiState of the GuiObject will be set to Press. Similarly, When the player's finger is being released from the GuiObject, the GuiState of the GuiObject will be set to Idle, and when Interactable is turned off on the GuiObject, the GuiState of the GuiObject will be set to NonInteractable.

This event fires when a user begins interacting with the GuiObject via a Human-Computer Interface device (Mouse button down, touch begin, keyboard button down, etc).

The UserInputService has a similarly named event that is not restricted to a specific UI element: UserInputService.InputBegan.

This event will always fire regardless of game state.

See also GuiObject.InputEnded and GuiObject.InputChanged.

This event fires when a user changes how they're interacting via a Human-Computer Interface device (Mouse button down, touch begin, keyboard button down, etc).

The UserInputService has a similarly named event that is not restricted to a specific UI element: UserInputService.InputChanged.

This event will always fire regardless of game state.

See also GuiObject.InputBegan and GuiObject.InputEnded.

The InputEnded event fires when a user stops interacting via a Human-Computer Interface device (Mouse button down, touch begin, keyboard button down, etc).

The UserInputService has a similarly named event that is not restricted to a specific UI element: UserInputService.InputEnded.

This event will always fire regardless of game state.

See also GuiObject.InputBegan and GuiObject.InputChanged.

Determines whether the GuiButton can be interacted with or not, or if the GuiState of the GuiObject is changing or not.

On a GuiButton:

• When the Interactable setting on the GuiButton is set to false, the GuiButton will no longer be able to be pressed or clicked, and the GuiState will be constantly set to NonInteractable.
• When the Interactable setting on the GuiButton is set to true, the GuiButton will behave normally again and the GuiState will behave normally.

On a GuiObject:

• When the Interactable setting on the GuiButton is set to false, the GuiState will be constantly set to NonInteractable.
• When the Interactable setting on the GuiButton is set to true, the GuiState will behave normally again.

This property controls the sorting order of the GuiObject when using a UIGridStyleLayout (such as UIListLayout or UIPageLayout) with SortOrder set to SortOrder.LayoutOrder. It has no functionality if the object does not have a sibling UI layout structure.

GuiObjects are sorted in ascending order where lower values take priority over higher values. Objects with equal values fall back to the order they were added in.

If you are unsure if you'll need to add an element between two existing elements in the future, it's a good practice to use multiples of 100 (0, 100, 200, etc.). This ensures a large gap of layout order values which you can use for elements ordered in-between other elements.

See also ZIndex which determines the object's rendering order instead of sorting order.

The MouseEnter event fires when a user moves their mouse into a GuiObject element.

Please do not rely on the x and y arguments passed by this event as a fool-proof way to determine where the user's mouse is when it enters a GUI. These coordinates may vary even when the mouse enters the GUI via the same edge - particularly when the mouse enters the element quickly. This is due to the fact the coordinates indicate the position of the mouse when the event fires rather than the exact moment the mouse enters the GUI.

This event fires even when the GUI element renders beneath another element.

If you would like to track when a user's mouse leaves a GUI element, you can use the GuiObject.MouseLeave event.

See Also

• GuiObject.MouseLeave
• GuiObject.MouseMoved
• GuiObject.MouseWheelForward
• GuiObject.MouseWheelBackward

The MouseLeave event fires when a user moves their mouse out of a GuiObject element.

Please do not rely on the x and y arguments passed by this event as a fool-proof way to determine where the user's mouse is when it leaves a GUI. These coordinates may vary even when the mouse leaves the GUI via the same edge - particularly when the mouse leaves the element quickly. This is due to the fact the coordinates indicate the position of the mouse when the event fires rather than the exact moment the mouse leaves the GUI.

This event fires even when the GUI element renders beneath another element.

See Also

• GuiObject.MouseEnter
• GuiObject.MouseMoved
• GuiObject.MouseWheelForward
• GuiObject.MouseWheelBackward

Fires whenever a user moves their mouse while it is inside a GuiObject element. It is similar to Mouse.Move, which fires regardless whether the user's mouse is over a GUI element.

Note, this event fires when the mouse's position is updated, therefore it will fire repeatedly while being moved.

The x and y arguments indicate the updated screen coordinates of the user's mouse in pixels. These can be useful to determine the mouse's location on the GUI, screen, and delta since the mouse's previous position if it is being tracked in a global variable.

The code below demonstrates how to determine the Vector2 offset of the user's mouse relative to a GUI element:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

local CustomScrollingFrame = script.Parent
local SubFrame = CustomScrollingFrame:FindFirstChild("SubFrame")

local mouse = game.Players.LocalPlayer:GetMouse()
function getPosition(X, Y)
	local gui_X = CustomScrollingFrame.AbsolutePosition.X
	local gui_Y = CustomScrollingFrame.AbsolutePosition.Y


	local pos = Vector2.new(math.abs(X - gui_X), math.abs(Y - gui_Y - 36))
	print(pos)
end

CustomScrollingFrame.MouseMoved:Connect(getPosition)

Note that this event may not fire exactly when the user's mouse enters or exits a GUI element. Therefore, the x and y arguments may not match up perfectly to the coordinates of the GUI's edges.

See Also

• GuiObject.MouseEnter
• GuiObject.MouseLeave
• GuiObject.MouseWheelForward
• GuiObject.MouseWheelBackward

The WheelBackward event fires when a user scrolls their mouse wheel back when the mouse is over a GuiObject element. It is similar to Mouse.WheelBackward, which fires regardless whether the user's mouse is over a GUI element.

This event fires merely as an indicator of the wheel's backward movement. This means that the x and y mouse coordinate arguments don't change as a result of this event. These coordinates only change when the mouse moves, which can be tracked by the GuiObject.MouseMoved event.

See Also

• GuiObject.MouseEnter
• GuiObject.MouseLeave
• GuiObject.MouseMoved
• GuiObject.MouseWheelForward

The WheelForward event fires when a user scrolls their mouse wheel forward when the mouse is over a GuiObject element. It is similar to Mouse.WheelForward, which fires regardless whether the user's mouse is over a GUI element.

This event fires merely as an indicator of the wheel's forward movement. This means that the X and Y mouse coordinate arguments do not change as a result of this event. These coordinates only change when the mouse moves, which can be tracked by the GuiObject.MouseMoved event.

See Also

• GuiObject.MouseEnter
• GuiObject.MouseLeave
• GuiObject.MouseMoved
• GuiObject.MouseWheelBackward

This property sets the GuiObject selected when the user moves the gamepad selector downward. If this property is empty, moving the gamepad downward will not change the selected GUI.

Moving the gamepad selector downward sets the GuiService.SelectedObject to this object unless the GUI is not Selectable. Note that this property can be set to a GUI element even if it is not Selectable, so you should ensure that the value of a GUI's selectable property matches your expected behavior.

See also NextSelectionUp, NextSelectionLeft, and NextSelectionRight.

This property sets the GuiObject selected when the user moves the gamepad selector to the left. If this property is empty, moving the gamepad to the left will not change the selected GUI.

Moving the gamepad selector to the left sets the GuiService.SelectedObject to this object unless the GUI is not Selectable. Note that this property can be set to a GUI element even if it is not Selectable, so you should ensure that the value of a GUI's selectable property matches your expected behavior.

See also NextSelectionUp, NextSelectionDown, and NextSelectionRight.

This property sets the GuiObject selected when the user moves the gamepad selector to the right. If this property is empty, moving the gamepad to the right will not change the selected GUI.

Moving the gamepad selector to the right sets the GuiService.SelectedObject to this object unless the GUI is not Selectable. Note that this property can be set to a GUI element even if it is not Selectable, so you should ensure that the value of a GUI's selectable property matches your expected behavior.

See also NextSelectionUp, NextSelectionDown, and NextSelectionLeft.

This property sets the GuiObject selected when the user moves the gamepad selector upward. If this property is empty, moving the gamepad upward will not change the selected GUI.

Moving the gamepad selector upward sets the GuiService.SelectedObject to this object unless the GUI is not Selectable. Note that this property can be set to a GUI element even if it is not Selectable, so you should ensure that the value of a GUI's selectable property matches your expected behavior.

See also NextSelectionDown, NextSelectionLeft, NextSelectionRight.

This property determines the GuiObject pixel and scalar position using a UDim2. Position is centered around the object's GuiObject.AnchorPoint.

The scalar position is relative to the size of the parent GUI element, if any.

The pixel portions of the UDim2 value are the same regardless of the parent GUI's size. The values represent the position of the object in pixels. An object's actual pixel position can be read from the GuiBase2d.AbsolutePosition property.

This property determines the number of degrees by which the GuiObject is rotated. Rotation is relative to the center of the object, not the AnchorPoint, meaning you cannot change the point of rotation. Additionally, this property is not compatible with ClipsDescendants.

This property determines whether the GuiObject can be selected when navigating GUIs using a gamepad.

If this property is true, a GUI can be selected. Selecting a GUI also sets the GuiService.SelectedObject property to that object.

When this is false, the GUI cannot be selected. However, setting this to false when a GUI is selected will not deselect it nor change the value of the GuiService.SelectedObject property.

Add GuiObject.SelectionGained and GuiObject.SelectionLost will not fire for the element. To deselect a GuiObject, you must change the GuiService.SelectedObject property.

This property is useful if a GUI is connected to several GUIs via properties such as this GuiObject.NextSelectionUp, GuiObject.NextSelectionDown, NextSelectionRight, or NextSelectionLeft. Rather than change all of the properties so that the Gamepad cannot select the GUI, you can disable its Selectable property to temporarily prevent it from being selected. Then, when you want the gamepad selector to be able to select the GUI, simply re-enable its selectable property.