We use cookies on this site to enhance your user experience

GuiService

GuiService

The GuiService is a special service, which currently allows developers to control what GuiObject is currently being selected by the Gamepad Gui navigator, and allows clients to check if Roblox’s main menu is currently open. This service has a lot of hidden members, which are mainly used internally by Roblox’s CoreScripts.


Properties

Name Type Description
bool

If the select button on a gamepad will automatically set a GUI as the selected object when the Select button is pressed. Turning this off will mean that Gui navigation will still work if GuiNavigationEnabled is enabled but you will have to set SelectedObject manually to start Gui navigation.

bool

Toggles whether or not objects in the CoreGui can be navigated using a Gamepad.

bool

Used to enable and disable the default controller GUI navigation.

bool

Status of the Roblox escape menu CoreGui. Returns true if the menu is open, false if not.

GuiObject

Sets the GuiObject currently being focused on by the GUI Navigator (used for Gamepads). This may reset to nil if the object is off-screen.

Inherited from Instance

Archivable ClassName DataCost Name Parent RobloxLocked

Functions

Name Type Description
void

Creates a gui selection group where gamepad gui navigation will only consider selectable gui objects that are within the group (children of selectionParent).

void

Functions similarly to GuiService/AddSelectionParent, but you can give it a tuple of GuiObject that you want to be contained in the group.

Tuple

Returns two Vector2 values representing the offset of user GUIs in pixels from the top left corner of the screen and the bottom right corner of the screen respectively.

int

Returns the scale of the user’s resolution.

bool

Returns true if the client is using the ten foot interface, which is a special version of Roblox’s UI, exclusive to consoles.

This is the only guaranteed way to verify if the user is on a console or not.

void

Removes a group that was created with GuiService/AddSelectionParent or GuiService/AddSelectionTuple.

void

Sets the GuiService’s Ui message.

Inherited from Instance

ClearAllChildren Clone Destroy FindFirstAncestor FindFirstAncestorOfClass FindFirstAncestorWhichIsA FindFirstChild FindFirstChildOfClass FindFirstChildWhichIsA GetChildren GetDebugId GetDescendants GetFullName GetPropertyChangedSignal IsA IsAncestorOf IsDescendantOf WaitForChild

Events

Name Type Description

Fires when the user closes the Roblox coregui escape menu.

Fires when the user opens the Roblox coregui escape menu.

Inherited from Instance

AncestryChanged Changed ChildAdded ChildRemoved DescendantAdded DescendantRemoving