Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.
GuiState
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
| Name | Value | Description |
|---|---|---|
| Idle | 0 | The GuiObject is idle — neither hovered nor pressed. |
| Hover | 1 | The GUI is being hovered over by the user. |
| Press | 2 | The GUI is being pressed/held down by the user. |
| NonInteractable | 3 | The GUI cannot be interacted with and therefore has no states. |
Idle
The GuiObject is idle — neither hovered nor pressed.
| Field | Value |
|---|---|
| value | 0 |
Hover
The GUI is being hovered over by the user.
| Field | Value |
|---|---|
| value | 1 |
Press
The GUI is being pressed/held down by the user.
| Field | Value |
|---|---|
| value | 2 |
NonInteractable
The GUI cannot be interacted with and therefore has no states.
| Field | Value |
|---|---|
| value | 3 |