Skip to content

GuiState

Not yet Enum

Describes the current interaction state of a GuiObject.

Not implemented in Nova

This enum is missing from Nova. Scripts that reference it will fail.

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.

Items

Item Value Status Notes
Idle 0 Not yet The GuiObject is idle — neither hovered nor pressed.
Hover 1 Not yet The GUI is being hovered over by the user.
Press 2 Not yet The GUI is being pressed/held down by the user.
NonInteractable 3 Not yet The GUI cannot be interacted with and therefore has no states.

Roblox reference: GuiState