code_samples:
- GuiService-GetInsetArea
parameters:
- name: screenInsets
type: ScreenInsets
default:
summary: |
The `Enum.ScreenInsets` value indicating which inset area to query.
returns:
- type: Rect
summary: |
A `Datatype.Rect` of the usable region for the specified
`Enum.ScreenInsets` area.
tags: []
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities:
- UI
- name: GuiService:GetInspectMenuEnabled
summary: |
Returns whether the avatar inspection menu is enabled.
description: |
This method returns whether the
[Avatar Inspect Menu](../../../players/avatar-inspect-menu.md) is
currently enabled. The feature is enabled by default and can be disabled
using the
`Class.GuiService:SetInspectMenuEnabled()|SetInspectMenuEnabled()` method.
code_samples: []
parameters: []
returns:
- type: boolean
summary: |
Whether the avatar inspection menu is enabled.
tags: []
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities:
- UI
- name: GuiService:InspectPlayerFromHumanoidDescription
summary: |
Allows the avatar inspection menu to appear showing the assets listed in a
`Class.HumanoidDescription` object.
description: |
This method allows the
[Avatar Inspect Menu](../../../players/avatar-inspect-menu.md) to appear
showing the assets listed in a `Class.HumanoidDescription` object. This
allows further customization with what is shown in the inspection menu
when players inspect other players in your experience.
See also
`Class.GuiService:InspectPlayerFromUserId()|InspectPlayerFromUserId()`
which allows the avatar inspection menu to appear showing the user that
has the given `Class.Player.UserId|UserId`.
code_samples:
- opening-an-inspect-menu-with-a-humanoiddescription
parameters:
- name: humanoidDescription
type: Instance
default:
summary: |
A `Class.HumanoidDescription` object that contains the assets to show
in the inspection menu.
- name: name
type: string
default:
summary: |
The name of the player being inspected to show in the menu.
returns:
- type: ()
summary: ''
tags: []
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities:
- UI
- AvatarAppearance
- name: GuiService:InspectPlayerFromUserId
summary: |
Allows the avatar inspection menu to appear showing the user that has the
given `Class.Player.UserId|UserId`.
description: |
This method allows the
[Avatar Inspect Menu](../../../players/avatar-inspect-menu.md) to appear
showing the user that has the given `Class.Player.UserId|UserId`. This is
especially useful when you want to inspect players who aren't in the
current experience.
See also
`Class.GuiService:InspectPlayerFromHumanoidDescription()|InspectPlayerFromHumanoidDescription()`
which allows you to bring up the avatar inspection menu showing the assets
listed in a `Class.HumanoidDescription` object.
code_samples:
- opening-the-inspect-menu-for-a-userid
parameters:
- name: userId
type: User
default:
summary: |
The `Class.Player.UserId|UserId` of the player to inspect.
returns:
- type: ()
summary: ''
tags: []
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities:
- UI
- AvatarAppearance
- name: GuiService:IsTenFootInterface
summary: |
Returns `true` if the client is using the ten foot interface, a special
version of Roblox's UI exclusive to consoles.
description: |
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
`Class.GuiService.ViewportDisplaySize|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.
code_samples: []
parameters: []
returns:
- type: boolean
summary: |
`true` if the client is using the ten foot interface (console UI
mode); `false` otherwise.
tags: []
deprecation_message: |
This method has been superseded by the
`Class.GuiService.ViewportDisplaySize|ViewportDisplaySize` property which
represents the internally‑categorized rendering size of the viewport.
security: None
thread_safety: Unsafe
capabilities:
- UI
- name: GuiService:RemoveSelectionGroup
summary: |
Removes a group that was created with
`Class.GuiService:AddSelectionParent()|AddSelectionParent()` or
`Class.GuiService:AddSelectionTuple()|AddSelectionTuple()`.
description: |
Removes a group that was created with
`Class.GuiService:AddSelectionParent()|AddSelectionParent()` or
`Class.GuiService:AddSelectionTuple()|AddSelectionTuple()`.
code_samples: []
parameters:
- name: selectionName
type: string
default:
summary: |
The name of the selection group to remove.
returns:
- type: ()
summary: ''
tags:
- Deprecated
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities:
- UI
- name: GuiService:Select
summary: |
Sets `Class.GuiService.SelectedObject` to a child of a provided instance
that is the `Class.PlayerGui` or its descendants.
description: |
When called on an instance `selectionParent` that is the `Class.PlayerGui`
or a descendant of it, the engine searches all available selectable,
visible and on-screen `Class.GuiObject|GuiObjects` that are descendants of
`selectionParent` and sets the
`Class.GuiService.SelectedObject|SelectedObject` to the `Class.GuiObject`
with the smallest `Class.GuiObject.SelectionOrder|SelectionOrder`.
code_samples: []
parameters:
- name: selectionParent
type: Instance
default:
summary: |
The parent of selection whose descendants are searched.
returns:
- type: ()
summary: ''
tags: []
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities:
- UI
- name: GuiService:SendNotification
summary: |
Displays a notification described by `notificationInfo` and returns a
unique identifier for it.
description: |
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. |