GSmGpE6CwX2y9JjB25B8
We use cookies on this site to enhance your user experience
Collapse Sidebar

GuiService

Show Show deprecated

GuiService

Show deprecated

The GuiService is a service which currently allows developers to control what GuiObject is currently being selected by the gamepad navigator. It also 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 CoreScript|CoreScripts.

Properties

bool

AutoSelectGuiEnabled

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

CoreGuiNavigationEnabled

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

bool

GuiNavigationEnabled

Used to enable and disable the default controller GUI navigation.

bool

IsModalDialog

[ReadOnly] [NotReplicated] [Deprecated]

Indicates whether a modal dialog is visible.

bool

IsWindows

[ReadOnly] [NotReplicated] [Deprecated]

Indicates whether the user is playing on a computer running Windows.

bool

MenuIsOpen

[ReadOnly] [NotReplicated]

Returns true if any menu of CoreGui is open

GuiObject

SelectedObject

Sets the GuiObject currently being focused on by the GUI Navigator (used for Gamepads)

Inherited from Instance: Show Hide

bool

Archivable

Determines if an Instance can be cloned using /Instance/Clone or saved to file.

string

ClassName

[ReadOnly] [NotReplicated]

A read-only string representing the class this Instance belongs to

int

DataCost

[ReadOnly] [NotReplicated] [Deprecated]

The cost of saving the instance using data persistence.

string

Name

A non-unique identifier of the Instance

Instance

Parent

Determines the hierarchical parent of the Instance

bool

RobloxLocked

If true, the Instance and its descendants cannot be indexed or edited by a Script or LocalScript and will throw an error if it is attempted

bool

archivable

[Hidden] [NotReplicated] [Deprecated]
string

className

[ReadOnly] [NotReplicated] [Deprecated]

Functions

void

AddSelectionParent ( string selectionName , Instance selectionParent )

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

void

AddSelectionTuple ( string selectionName , Tuple selections )

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

void

CloseInspectMenu ( )

bool

GetEmotesMenuOpen ( )

bool

GetGameplayPausedNotificationEnabled ( )

Tuple

GetGuiInset ( )

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

bool

GetInspectMenuEnabled ( )

void

InspectPlayerFromHumanoidDescription ( Instance humanoidDescription , string name )

Allows a developer to bring up the Inspect menu showing the assets listed in this HumanoidDescription object

void

InspectPlayerFromUserId ( int64 userId )

Allows the Inspect Menu to appear showing the user that has the given Player/UserId|UserId

bool

IsTenFootInterface ( )

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

RemoveSelectionGroup ( string selectionName )

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

void

SetEmotesMenuOpen ( bool isOpen )

void

SetGameplayPausedNotificationEnabled ( bool enabled )

void

SetInspectMenuEnabled ( bool enabled )

Allows developers to enable or disable default Inspect and Buy functionality

void

SetUiMessage ( UiMessageType msgType , string uiMessage )

Sets the GuiService’s Ui message.

Inherited from Instance: Show Hide

void

ClearAllChildren ( )

This function destroys all of an Instance's children.

Instance

Clone ( )

Create a deep copy of a Roblox instance and descendants where Archivable = true.

void

Destroy ( )

Sets the Instance/Parent property to nil, locks the Instance/Parent property, disconnects all connections and calls Destroy on all children.

Instance

FindFirstAncestor ( string name )

Returns the first ancestor of the Instance whose Instance/Name is equal to the given name.

Instance

FindFirstAncestorOfClass ( string className )

Returns the first ancestor of the Instance whose Instance/ClassName is equal to the given className.

Instance

FindFirstAncestorWhichIsA ( string className )

Returns the first ancestor of the Instance for whom Instance/IsA returns true for the given className.

Instance

FindFirstChild ( string name , bool recursive )

Returns the first child of the Instance found with the given name.

Instance

FindFirstChildOfClass ( string className )

Returns the first child of the Instance whose Instance/ClassName|ClassName is equal to the given className.

Instance

FindFirstChildWhichIsA ( string className , bool recursive )

Returns the first child of the Instance for whom Instance/IsA returns true for the given className.

Objects

GetChildren ( )

Returns an array containing all of the Instance's children.

string

GetDebugId ( int scopeLength )

[NotBrowsable]

Returns a coded string of the Instances DebugId used internally by Roblox.

Array

GetDescendants ( )

[CustomLuaState]

Returns an array containing all of the descendants of the instance

string

GetFullName ( )

Returns a string describing the Instance's ancestry.

RBXScriptSignal

GetPropertyChangedSignal ( string property )

Get an event that fires when a given property of an object changes.

bool

IsA ( string className )

[CustomLuaState]

Returns true if an Instance's class matches or inherits from a given class

bool

IsAncestorOf ( Instance descendant )

Returns true if an Instance is an ancestor of the given descendant.

bool

IsDescendantOf ( Instance ancestor )

Returns true if an Instance is a descendant of the given ancestor.

void

Remove ( )

[Deprecated]

Sets the object’s Parent to nil, and does the same for all its descendants.

Instance

WaitForChild ( string childName , double timeOut )

[CustomLuaState] [CanYield]

Returns the child of the Instance with the given name. If the child does not exist, it will yield the current thread until it does.

Objects

children ( )

[Deprecated]

Returns an array of the object’s children.

Instance

clone ( )

[Deprecated]
void

destroy ( )

[Deprecated]
Instance

findFirstChild ( string name , bool recursive )

[Deprecated]
Objects

getChildren ( )

[Deprecated]
bool

isA ( string className )

[Deprecated] [CustomLuaState]
bool

isDescendantOf ( Instance ancestor )

[Deprecated]
void

remove ( )

[Deprecated]

Events

RBXScriptSignal

MenuClosed ( )

Fires when the user closes the Roblox coregui escape menu.

RBXScriptSignal

MenuOpened ( )

Fires when the user opens the Roblox coregui escape menu.

Inherited from Instance: Show Hide

RBXScriptSignal

AncestryChanged ( Instance child , Instance parent )

Fires when the Instance/Parent property of the object or one of its ancestors is changed.

RBXScriptSignal

Changed ( string property )

Fired immediately after a property of an object changes.

RBXScriptSignal

ChildAdded ( Instance child )

Fires when an object is parented to this Instance.

RBXScriptSignal

ChildRemoved ( Instance child )

Fires when a child is removed from this Instance.

RBXScriptSignal

DescendantAdded ( Instance descendant )

Fires when a descendant is added to the Instance

RBXScriptSignal

DescendantRemoving ( Instance descendant )

Fires immediately before a descendant of the Instance is removed.

RBXScriptSignal

childAdded ( Instance child )

[Deprecated]