20 min read

Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.

GuiService

Inherits from: Instance → Object

GuiService offers numerous properties and methods for working with GuiObjects, player preferences, and other UI‑related tasks.

Inherits from: Instance

Memory category: Instances

Tags: NotCreatable, Service, NotReplicated

Properties

Name	Type / Returns	Description
GuiService.AutoSelectGuiEnabled	boolean	If activated, the `Select` button on a gamepad or `Backslash` will automatically set a GUI as the selected object.
GuiService.CoreGuiNavigationEnabled	boolean	Toggles whether or not objects in the `CoreGui` can be navigated using a gamepad.
GuiService.GuiNavigationEnabled	boolean	Used to enable and disable the default controller GUI navigation.
GuiService.IsModalDialog	boolean	Indicates whether a modal dialog is visible.
GuiService.IsWindows	boolean	Indicates whether the user is playing on a computer running Windows.
GuiService.MenuIsOpen	boolean	Returns `true` if any menu of `CoreGui` is open.
GuiService.PreferredTextSize	PreferredTextSize	Gets the player's preferred text size as an `PreferredTextSize` value.
GuiService.PreferredTransparency	float	Gets the player's preferred transparency as a number between `0` and `1`.
GuiService.ReducedMotionEnabled	boolean	Returns `true` if the player has enabled reduced motion.
GuiService.SelectedObject	GuiObject	Sets the `GuiObject` currently being focused on by the GUI navigator.
GuiService.TopbarInset	Rect	Used to determine the absolute size and position of unobstructed area within top bar space.
GuiService.TouchControlsEnabled	boolean	Used to enable and disable touch controls and touch control display UI. Defaults to `true`.
GuiService.ViewportDisplaySize	DisplaySize	Read-only property which represents the physical rendering size of the viewport.

Inherited from Instance

Name	Type / Returns	Description
Instance.Archivable	boolean	Determines if an `Instance` and its descendants can be cloned using `Instance:Clone()`, and can be saved/published.
Instance.archivable	boolean
Instance.Capabilities	SecurityCapabilities	The set of capabilities allowed to be used for scripts inside this container.
Instance.IsInSandbox	boolean	Indicates whether the instance is inside a sandboxed container.
Instance.Name	string	A non-unique identifier of the `Instance`.
Instance.Parent	Instance	Determines the hierarchical parent of the `Instance`.
Instance.PredictionMode	PredictionMode	Reflects the client-side prediction mode applied to the instance under server-authoritative physics.
Instance.RobloxLocked	boolean	A deprecated property that used to protect `CoreGui` objects.
Instance.Sandboxed	boolean	When enabled, the instance can only access abilities in its `Capabilities` list.
Instance.UniqueId	UniqueId	A unique identifier for the instance.

Inherited from Object

Name	Type / Returns	Description
Object.ClassName	string	A read-only string representing the class this `Object` belongs to.
Object.className	string

GuiService.AutoSelectGuiEnabled

If activated, the Select button on a gamepad or Backslash will automatically set a GUI as the selected object. Disabling this means that GUI navigation will still work if GuiNavigationEnabled is enabled, but you will have to set SelectedObject manually to start navigation.

Field	Value
type	boolean
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Data
serialization	{"can_load":true,"can_save":true}
capabilities	["UI","Input"]

GuiService.CoreGuiNavigationEnabled

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

Field	Value
type	boolean
tags	["Hidden","NotReplicated"]
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Data
serialization	{"can_load":false,"can_save":false}
capabilities	["UI","Input"]

GuiService.GuiNavigationEnabled

Used to enable and disable the default controller GUI navigation.

Field	Value
type	boolean
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Data
serialization	{"can_load":true,"can_save":true}
capabilities	["UI","Input"]

GuiService.IsModalDialog

Deprecated. This item is deprecated. Do not use it for new work.

This property tells whether or not a modal dialog is visible, such as the game menu or a purchase prompt.

Field	Value
type	boolean
tags	["ReadOnly","NotReplicated","Deprecated"]
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Data
serialization	{"can_load":false,"can_save":false}
capabilities	["UI"]

GuiService.IsWindows

Deprecated. This item is deprecated. Do not use it for new work.

The IsWindows property defines if the user is playing on a computer running Windows.

Field	Value
type	boolean
tags	["ReadOnly","NotReplicated","Deprecated"]
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Data
serialization	{"can_load":false,"can_save":false}
capabilities	["UI"]

GuiService.MenuIsOpen

Returns true if any menu of CoreGui is open.

Field	Value
type	boolean
tags	["ReadOnly","NotReplicated"]
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Data
serialization	{"can_load":false,"can_save":true}
capabilities	["UI"]

GuiService.PreferredTextSize

Gets the player's preferred text size as an PreferredTextSize value of Medium (default), Large, Larger, or Largest. This property maps to the Text Size setting available to players from the Roblox and in‑game Settings menus, and it can be combined with Object.GetPropertyChangedSignal() to detect text size setting changes for purposes of adjusting UI.

When working with UI elements, note the following behaviors:

Text that is constrained to a minimum and/or maximum size through a UITextSizeConstraint will not shrink below or expand above the set MinTextSize/MaxTextSize, regardless of the player's text size setting.
When TextScaled is enabled for a TextLabel or TextButton, the element's text will not be scaled by the PreferredTextSize value.
UI elements with AutomaticSize enabled will shrink/grow as PreferredTextSize decreases/increases (element bounds will resize to fit the resized text).
When TextWrapped is enabled for a TextLabel or TextButton, the element's text will wrap to additional lines as PreferredTextSize increases, within limits of the element's absolute size.
The results returned by TextService:GetTextSize() and TextService:GetTextBoundsAsync() honor changes related to PreferredTextSize.

Field	Value
type	PreferredTextSize
tags	["ReadOnly","NotReplicated"]
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Data
serialization	{"can_load":false,"can_save":false}
capabilities	["UI"]

Code samples: View on Creator Hub (GuiService-PreferredTextSize).

GuiService.PreferredTransparency

Gets the player's preferred transparency as a number between 0 and 1. This property maps to the Background Transparency setting available to players from the Roblox and in‑experience Settings menus, and it can be combined with Object.GetPropertyChangedSignal() to detect transparency setting changes for purposes of adjusting UI.

A value of 1 (default) indicates the player prefers the default background transparency, while a value of 0 indicates the player prefers fully opaque (non‑transparent) background transparency for improved readability and contrast. Multiplying a UI element's BackgroundTransparency with PreferredTransparency is the recommended approach, such that backgrounds become more opaque as PreferredTransparency approaches 0.

Field	Value
type	float
tags	["Hidden","ReadOnly","NotReplicated"]
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Data
serialization	{"can_load":false,"can_save":false}
capabilities	["UI"]

Code samples: View on Creator Hub (GuiService-PreferredTransparency).

GuiService.ReducedMotionEnabled

Returns true if the player has enabled reduced motion, indicating that they want motion effects and animations to be reduced or completely removed. This property maps to the Reduce Motion toggle available from the Roblox and in‑experience Settings menus. See accessibility guidelines for usage recommendations.

Field	Value
type	boolean
tags	["Hidden","ReadOnly","NotReplicated"]
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Data
serialization	{"can_load":false,"can_save":false}
capabilities	["UI"]

GuiService.SelectedObject

Sets the GuiObject currently being focused on by the GUI navigator. This may reset to nil if the object is off screen.

This property is changed by the SelectionGained and SelectionLost events. If you would like to determine when this property changes without tracking these events for all GUI elements, you can use the Changed event.

Field	Value
type	GuiObject
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Data
serialization	{"can_load":true,"can_save":true}
capabilities	["UI","Input"]

Code samples: View on Creator Hub (printing-when-gamepad-selection-changes).

GuiService.TopbarInset

Returns a Rect object representing the unoccupied area between the Roblox left-most controls and the edge of the device safe area.

The value is dynamic and can be expected to change based on the visibility of UI controls such as changing the local player's Health property, usage of StarterGui:SetCoreGuiEnabled(), changing the size and position of Roblox UI Controls, and/or others. For this reason, it's recommend that you detect and react to changes of this property with Object:GetPropertyChangedSignal().

Field	Value
type	Rect
tags	["ReadOnly","NotReplicated"]
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Data
serialization	{"can_load":false,"can_save":false}
capabilities	["UI"]

Code samples: View on Creator Hub (GuiService-TopbarInset).

GuiService.TouchControlsEnabled

Used to enable and disable touch controls and touch control display UI. Defaults to true.

Field	Value
type	boolean
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Data
serialization	{"can_load":false,"can_save":false}
capabilities	["UI","Input"]

GuiService.ViewportDisplaySize

Read-only property which represents the physical rendering size of the viewport:

DisplaySize.Small — Most tablet/mobile/handheld devices
DisplaySize.Medium — Most laptops and monitors
DisplaySize.Large — Most TVs or larger

You can listen for changes to this property through the GetPropertyChangedSignal() method to adapt UI to various display sizes.

Field	Value
type	DisplaySize
tags	["ReadOnly","NotReplicated"]
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Data
serialization	{"can_load":false,"can_save":false}
capabilities	["UI"]

Code samples: View on Creator Hub (GuiService-ViewportDisplaySize).

Methods

Name	Type / Returns	Description
GuiService:AddSelectionParent	()	Creates a selection group where gamepad GUI navigation will only consider selectable objects that are within the group.
GuiService:AddSelectionTuple	()	AddSelectionTuple works similarly to `GuiService:AddSelectionParent()`, but you can give it a tuple of `GuiObject` that you want to be contained in the group. Beware that the second argument is not a table, but rather the first of several `GuiObject` in the tuple. To pass the contents of a table, use `unpack`/`table.unpack`: `lua local frame = script.Parent -- Passing various GuiObject individually GuiService:AddSelectionTuple("InventoryButtons", frame.Sort, frame.Trash, frame.Drop) -- Unpacking a table of GuiObject (unpack/table.unpack are equivalent) local inventoryButtons = { frame.Sort, frame.Trash, frame.Drop } GuiService:AddSelectionTuple("InventoryButtons", unpack(inventoryButtons))`
GuiService:CloseInspectMenu	()	Closes the avatar inspection menu, if open.
GuiService:DismissNotification	boolean	Dismisses a notification previously shown by `SendNotification()`.
GuiService:GetEmotesMenuOpen	boolean	Checks if the player emotes menu is open.
GuiService:GetGameplayPausedNotificationEnabled	boolean	Returns whether or not the `Player.GameplayPaused` notification has been disabled.
GuiService:GetGuiInset	Tuple	Returns two `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.
GuiService:GetInsetArea	Rect	Takes an `ScreenInsets` value and returns a `Rect` describing the inset region, relative to the `CoreUISafeInsets` area.
GuiService:GetInspectMenuEnabled	boolean	Returns whether the avatar inspection menu is enabled.
GuiService:InspectPlayerFromHumanoidDescription	()	Allows the avatar inspection menu to appear showing the assets listed in a `HumanoidDescription` object.
GuiService:InspectPlayerFromUserId	()	Allows the avatar inspection menu to appear showing the user that has the given `UserId`.
GuiService:IsTenFootInterface	boolean	Returns `true` if the client is using the ten foot interface, a special version of Roblox's UI exclusive to consoles.
GuiService:RemoveSelectionGroup	()	Removes a group that was created with `AddSelectionParent()` or `AddSelectionTuple()`.
GuiService:Select	()	Sets `GuiService.SelectedObject` to a child of a provided instance that is the `PlayerGui` or its descendants.
GuiService:SendNotification	string	Displays a notification described by `notificationInfo` and returns a unique identifier for it.
GuiService:SetEmotesMenuOpen	()	Opens or closes the player emotes menu.
GuiService:SetGameplayPausedNotificationEnabled	()	Lets you disable the built-in notification when a player's gameplay is paused.
GuiService:SetInspectMenuEnabled	()	Allows you to enable or disable the avatar inspection menu.

Inherited from Instance

Name	Type / Returns	Description
Instance:AddTag	()	Applies a tag to the instance.
Instance:children	Instances	Returns an array of the object's children.
Instance:ClearAllChildren	()	This method destroys all of an instance's children.
Instance:Clone	Instance	Create a copy of an instance and all its descendants, ignoring instances that are not `Archivable`.
Instance:clone	Instance
Instance:Destroy	()	Sets the `Instance.Parent` property to `nil`, locks the `Instance.Parent` property, disconnects all connections, and calls `Destroy()` on all children.
Instance:destroy	()
Instance:FindFirstAncestor	Instance?	Returns the first ancestor of the `Instance` whose `Instance.Name` is equal to the given name.
Instance:FindFirstAncestorOfClass	Instance?	Returns the first ancestor of the `Instance` whose `Object.ClassName` is equal to the given className.
Instance:FindFirstAncestorWhichIsA	Instance?	Returns the first ancestor of the `Instance` for whom `Object:IsA()` returns true for the given className.
Instance:FindFirstChild	Instance?	Returns the first child of the `Instance` found with the given name.
Instance:findFirstChild	Instance
Instance:FindFirstChildOfClass	Instance?	Returns the first child of the `Instance` whose `ClassName` is equal to the given class name.
Instance:FindFirstChildWhichIsA	Instance?	Returns the first child of the `Instance` for whom `Object:IsA()` returns true for the given className.
Instance:FindFirstDescendant	Instance?	Returns the first descendant found with the given `Instance.Name`.
Instance:GetActor	Actor?	Returns the `Actor` associated with the Instance, if any.
Instance:GetAttribute	Variant	Returns the value which has been assigned to the given attribute name.
Instance:GetAttributeChangedSignal	RBXScriptSignal	Returns an event that fires when the given attribute changes.
Instance:GetAttributes	Dictionary	Returns a dictionary of the instance's attributes.
Instance:GetChildren	Instances	Returns an array containing all of the instance's children.
Instance:getChildren	Instances
Instance:GetDebugId	string	Returns a coded string of the debug ID used internally by Roblox.
Instance:GetDescendants	Instances	Returns an array containing all of the descendants of the instance.
Instance:GetFullName	string	Returns a string describing the instance's ancestry.
Instance:GetStyled	Variant	Returns the styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified.
Instance:GetStyledPropertyChangedSignal	RBXScriptSignal	Returns an event that fires when the given style property changes on the instance.
Instance:GetTags	Array	Gets an array of all tags applied to the instance.
Instance:HasTag	boolean	Check whether the instance has a given tag.
Instance:IsAncestorOf	boolean	Returns true if an `Instance` is an ancestor of the given descendant.
Instance:IsDescendantOf	boolean	Returns `true` if an `Instance` is a descendant of the given ancestor.
Instance:isDescendantOf	boolean
Instance:IsPropertyModified	boolean	Returns `true` if the value stored in the specified property is not equal to the code-instantiated default.
Instance:QueryDescendants	Instances	Returns an array containing all descendants of the instance that match the `selector` string.
Instance:Remove	()	Sets the object's `Parent` to `nil`, and does the same for all its descendants.
Instance:remove	()
Instance:RemoveTag	()	Removes a tag from the instance.
Instance:ResetPropertyToDefault	()	Resets a property to its default value.
Instance:SetAttribute	()	Sets the attribute with the given name to the given value.
Instance:WaitForChild	Instance	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.

Inherited from Object

Name	Type / Returns	Description
Object:GetPropertyChangedSignal	RBXScriptSignal	Get an event that fires when a given property of the object changes.
Object:IsA	boolean	Returns true if an object's class matches or inherits from a given class.
Object:isA	boolean

GuiService:AddSelectionParent

Deprecated.

Creates a selection group where gamepad GUI navigation will only consider selectable objects that are within the group (children of selectionParent). An example is when you have a menu pop open and there are other selectable objects on the screen, possibly from previous menus, but you want the user to only be able to select GUI objects in the new menu.

Parameters

Name	Type	Default	Description
selectionName	string		A unique name identifying this selection group.
selectionParent	Instance		The `GuiObject` whose selectable descendants form the navigation group.

Returns

Type	Description
()

Field	Value
tags	["Deprecated"]
security	None
thread safety	Unsafe
capabilities	["UI"]

GuiService:AddSelectionTuple

Deprecated.

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

Parameters

Name	Type	Default	Description
selectionName	string		The name of the added selection.
selections	Tuple		The selection(s) added.

Returns

Type	Description
()

Field	Value
tags	["Deprecated"]
security	None
thread safety	Unsafe
capabilities	["UI"]

GuiService:CloseInspectMenu

This method closes the Avatar Inspect Menu, if open, when run from a LocalScript.

GuiService:DismissNotification

Dismisses the notification identified by notificationId, which is the string returned when the notification was created with SendNotification(). If the notification was created with an OnDismiss callback, that callback is invoked. Returns true when a matching notification is found and dismissed, or false when no active notification has the given notificationId.

Parameters

Name	Type	Default	Description
notificationId	string		The identifier returned by `SendNotification()` for the notification to dismiss.

Returns

Type	Description
boolean	`true` if a matching notification was found and dismissed; `false` if no active notification has the given `notificationId`.

Field	Value
security	None
thread safety	Unsafe
capabilities	["UI"]

GuiService:GetEmotesMenuOpen

Returns a boolean indicating whether or not the player emotes menu is open. You can open or close the emotes menu by calling the SetEmotesMenuOpen() method.

Returns

Type	Description
boolean	Whether the emotes menu is open.

Field	Value
security	None
thread safety	Unsafe
capabilities	["UI"]

GuiService:GetGameplayPausedNotificationEnabled

This method returns whether or not the Player.GameplayPaused notification has been disabled through SetGameplayPausedNotificationEnabled().

See also Workspace.StreamingIntegrityMode and StreamingIntegrityMode for more details on when gameplay is paused.

Returns

Type	Description
boolean	Whether or not the `Player.GameplayPaused` notification has been disabled.

Field	Value
security	None
thread safety	Unsafe
capabilities	["UI"]

GuiService:GetGuiInset

Returns two 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.

Note that the inset values supplied by this method only take effect on ScreenGuis that have their IgnoreGuiInset property set to false.

Returns

Type	Description
Tuple	A tuple of two `Vector2` values describing the current specified GUI inset.

Field	Value
security	None
thread safety	Unsafe
capabilities	["UI"]

Code samples: View on Creator Hub (GuiService-GetGuiInset).

GuiService:GetInsetArea

Takes an ScreenInsets value and returns a Rect describing the inset region relative to the CoreUISafeInsets area, effectively the usable rectangle for a particular ScreenInsets area.

On a mobile device screen, for example, querying GetInsetArea(Enum.ScreenInsets.None) may return a result such as -59, -58, 792, 334, meaning the usable rectangle for ScreenInsets.None has a top‑left corner 59 pixels left and 58 pixels up from the top‑left corner of the core UI area, and a bottom‑right corner 792 pixels right and 334 pixels down from the top‑left corner of the core UI area.

Parameters

Name	Type	Default	Description
screenInsets	ScreenInsets		The `ScreenInsets` value indicating which inset area to query.

Returns

Type	Description
Rect	A `Rect` of the usable region for the specified `ScreenInsets` area.

Field	Value
security	None
thread safety	Unsafe
capabilities	["UI"]

Code samples: View on Creator Hub (GuiService-GetInsetArea).

GuiService:GetInspectMenuEnabled

This method returns whether the Avatar Inspect Menu is currently enabled. The feature is enabled by default and can be disabled using the SetInspectMenuEnabled() method.

Returns

Type	Description
boolean	Whether the avatar inspection menu is enabled.

Field	Value
security	None
thread safety	Unsafe
capabilities	["UI"]

GuiService:InspectPlayerFromHumanoidDescription

This method allows the Avatar Inspect Menu to appear showing the assets listed in a HumanoidDescription object. This allows further customization with what is shown in the inspection menu when players inspect other players in your experience.

See also InspectPlayerFromUserId() which allows the avatar inspection menu to appear showing the user that has the given UserId.

Parameters

Name	Type	Default	Description
humanoidDescription	Instance		A `HumanoidDescription` object that contains the assets to show in the inspection menu.
name	string		The name of the player being inspected to show in the menu.

Returns

Type	Description
()

Field	Value
security	None
thread safety	Unsafe
capabilities	["UI","AvatarAppearance"]

Code samples: View on Creator Hub (opening-an-inspect-menu-with-a-humanoiddescription).

GuiService:InspectPlayerFromUserId

This method allows the Avatar Inspect Menu to appear showing the user that has the given UserId. This is especially useful when you want to inspect players who aren't in the current experience.

See also InspectPlayerFromHumanoidDescription() which allows you to bring up the avatar inspection menu showing the assets listed in a HumanoidDescription object.

Parameters

Name	Type	Default	Description
userId	User		The `UserId` of the player to inspect.

Returns

Type	Description
()

Field	Value
security	None
thread safety	Unsafe
capabilities	["UI","AvatarAppearance"]

Code samples: View on Creator Hub (opening-the-inspect-menu-for-a-userid).

GuiService:IsTenFootInterface

Deprecated. This method has been superseded by the ViewportDisplaySize property which represents the internally‑categorized rendering size of the viewport.

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

Note that you should not use this property in an attempt to verify if the player is on a console or not. Instead, consider reading ViewportDisplaySize. This method is hardcoded to return true whenever the client runs on a console, regardless of how the player is actually interacting with the device, making it an unreliable proxy for rendering context.

Returns

Type	Description
boolean	`true` if the client is using the ten foot interface (console UI mode); `false` otherwise.

Field	Value
security	None
thread safety	Unsafe
capabilities	["UI"]

GuiService:RemoveSelectionGroup

Deprecated.

Removes a group that was created with AddSelectionParent() or AddSelectionTuple().

Parameters

Name	Type	Default	Description
selectionName	string		The name of the selection group to remove.

Returns

Type	Description
()

Field	Value
tags	["Deprecated"]
security	None
thread safety	Unsafe
capabilities	["UI"]

GuiService:Select

When called on an instance selectionParent that is the PlayerGui or a descendant of it, the engine searches all available selectable, visible and on-screen GuiObjects that are descendants of selectionParent and sets the SelectedObject to the GuiObject with the smallest SelectionOrder.

Parameters

Name	Type	Default	Description
selectionParent	Instance		The parent of selection whose descendants are searched.

Returns

Type	Description
()

Field	Value
security	None
thread safety	Unsafe
capabilities	["UI"]

GuiService:SendNotification

Displays a notification built from the notificationInfo dictionary using Roblox's native notification UI, and returns a unique identifier string for the notification. The following fields of notificationInfo are recognized:

Field	Type	Description
`Title`	`string`	The notification's title text.
`Text`	`string`	The notification's body text.
`Icon`	`string`	An image asset to display with the notification.
`Buttons`	`{[ButtonInfo]}`	An array of button definitions. Each entry is a table with a `Text` (`string`), a `ButtonType` (`Enum.NotificationButtonType`), and an `OnActivated` (`function`) callback invoked when the button is pressed.
`OnDisplay`	`function`	Invoked when the notification is shown.
`OnDismiss`	`function`	Invoked when the notification is dismissed.

The returned identifier can be passed to DismissNotification() to dismiss the notification programmatically; an empty string is returned if the notification could not be queued.

Parameters

Name	Type	Default	Description
notificationInfo	Dictionary		A dictionary describing the notification. Recognized fields are `Title` (string), `Text` (string), `Icon` (string), `Buttons` (an array of button tables, each with a `Text` string, a `ButtonType` `Enum.NotificationButtonType` value, and an `OnActivated` callback), and `OnDisplay`/`OnDismiss` callback functions.

Returns

Type	Description
string	A unique identifier string for the notification, which can be passed to `DismissNotification()`. Returns an empty string if the notification could not be queued.

Field	Value
security	None
thread safety	Unsafe
capabilities	["UI"]

GuiService:SetEmotesMenuOpen

Opens or closes the player emotes menu.

Parameters

Name	Type	Default	Description
isOpen	boolean		Whether to open (`true`) or close (`false`) the emotes menu.

Returns

Type	Description
()

Field	Value
security	None
thread safety	Unsafe
capabilities	["UI"]

GuiService:SetGameplayPausedNotificationEnabled

This method lets you disable the built-in notification when a player's gameplay is paused. You can then add in your own UI and customize it.

You can query whether the notification is enabled by calling the GetGameplayPausedNotificationEnabled() method.

See also Workspace.StreamingIntegrityMode and StreamingIntegrityMode for more details on when gameplay is paused.

Parameters

Name	Type	Default	Description
enabled	boolean		Whether or not the built-in notification GUI is disabled.

Returns

Type	Description
()

Field	Value
security	None
thread safety	Unsafe
capabilities	["UI"]

GuiService:SetInspectMenuEnabled

This method allows you to enable or disable the Avatar Inspect Menu. The feature is enabled by default.

Parameters

Name	Type	Default	Description
enabled	boolean		A boolean indicating whether to enable or disable the menu.

Returns

Type	Description
()

Field	Value
security	None
thread safety	Unsafe
capabilities	["UI"]

Events

Name	Type / Returns	Description
GuiService.MenuClosed		Fires when the user closes the Roblox `CoreGui` escape menu.
GuiService.MenuOpened		Fires when the user opens the Roblox `CoreGui` escape menu.

Inherited from Instance

Name	Type / Returns	Description
Instance.AncestryChanged		Fires when the `Instance.Parent` property of this object or one of its ancestors is changed.
Instance.AttributeChanged		Fires whenever an attribute is changed on the `Instance`.
Instance.ChildAdded		Fires after an object is parented to this `Instance`.
Instance.childAdded
Instance.ChildRemoved		Fires after a child is removed from this `Instance`.
Instance.DescendantAdded		Fires after a descendant is added to the `Instance`.
Instance.DescendantRemoving		Fires immediately before a descendant of the `Instance` is removed.
Instance.Destroying		Fires immediately before (or is deferred until after) the instance is destroyed via `Instance:Destroy()`.
Instance.StyledPropertiesChanged		Fires whenever any style property is changed on the instance, including when a property is set to `nil`.

Inherited from Object

Name	Type / Returns	Description
Object.Changed		Fires immediately after a property of the object changes, with some limitations.

GuiService.MenuClosed

Fires when the user closes the Roblox CoreGui escape menu.

Field	Value
security	None
capabilities	["UI"]

GuiService.MenuOpened

Fires when the user opens the Roblox CoreGui escape menu.

Field	Value
security	None
capabilities	["UI"]

GuiService

Properties

Inherited from Instance

Inherited from Object

GuiService.AutoSelectGuiEnabled

GuiService.CoreGuiNavigationEnabled

GuiService.GuiNavigationEnabled

GuiService.IsModalDialog

GuiService.IsWindows

GuiService.MenuIsOpen

GuiService.PreferredTextSize

GuiService.PreferredTransparency

GuiService.ReducedMotionEnabled

GuiService.SelectedObject

GuiService.TopbarInset

GuiService.TouchControlsEnabled

GuiService.ViewportDisplaySize

Methods

Inherited from Instance

Inherited from Object

GuiService:AddSelectionParent

GuiService:AddSelectionTuple

GuiService:CloseInspectMenu

See Also

GuiService:DismissNotification

GuiService:GetEmotesMenuOpen

GuiService:GetGameplayPausedNotificationEnabled

GuiService:GetGuiInset

GuiService:GetInsetArea

GuiService:GetInspectMenuEnabled

GuiService:InspectPlayerFromHumanoidDescription

GuiService:InspectPlayerFromUserId

GuiService:IsTenFootInterface

GuiService:RemoveSelectionGroup

GuiService:Select

GuiService:SendNotification

GuiService:SetEmotesMenuOpen

GuiService:SetGameplayPausedNotificationEnabled

GuiService:SetInspectMenuEnabled

Events

Inherited from Instance

Inherited from Object

GuiService.MenuClosed

GuiService.MenuOpened