GuiState
Describes the current interaction state of a GuiObject.
Items 4
| History | Name | Value | Description | |
|---|---|---|---|---|
| 588 | Idle | 0 | The GuiObject is idle — neither hovered nor pressed. | |
| 588 | Hover | 1 | The GUI is being hovered over by the user. | |
| 588 | Press | 2 | The GUI is being pressed/held down by the user. | |
| 589 | NonInteractable | 3 | The GUI cannot be interacted with and therefore has no states. |
Description
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.