Roblox UtilitiesDevlHub Roblox Documentation

Enum

GuiState

Describes the current interaction state of a GuiObject.

Describes the current input state of a GuiObject, as reported by its read-only GuiObject.GuiState property. The engine sets this value automatically based on user input; it cannot be set from scripts. The value defaults to GuiState.Idle when the object is not being interacted with.

Items 4#

NameValueSummary
Idle0The GuiObject is idle — neither hovered nor pressed.
Hover1The GUI is being hovered over by the user.
Press2The GUI is being pressed/held down by the user.
NonInteractable3The GUI cannot be interacted with and therefore has no states.