GuiService
Allows developers to control what GuiObject is currently being selected by the gamepad navigator, as well as check if Roblox's main menu is currently open.
| Memory category | Instances |
|---|
Member index 99
Removed member index 21
| History | Member | |
|---|---|---|
| 201 | GamepadNavigationEnabled: bool | |
| 304 | ScreenGuiEnabled: bool | |
| 213 | ShowLegacyPlayerList: bool | |
| 213 | UseLuaChat: bool | |
| 213 | Version: double | |
| 213 | GetConnectorCount(): int | |
| 213 | GetInstanceCount(): int | |
| 303 | GetNativeViewFeatureList(): Dictionary | |
| 213 | GetVoxelCount(): float | |
| 650 | NotificationDismissed(notificationId: string): null | |
| 650 | NotificationDisplayed(notificationId: string): null | |
| 303 | RequestNativeView(url: string, featureType: int): void | |
| 273 | SetErrorMessage(errorMessage: string): void | |
| 91 | SetGlobalSizeOffsetPixel(x: int, y: int): void | |
| 303 | ShowAppShellTabBar(value: bool): void | |
| 650 | UserInteractedWithNotification(notificationId: string, buttonIndex: int): null | |
| 304 | EscapeKeyPressed() | |
| 420 | InspectPlayerFromUserIdRequest(userId: int64) | |
| 642 | OpenAttenuationCurveEditor(selectedCurveObjects: Objects) | |
| 591 | TopbarInsetChanged(topbarInset: Dictionary) |
Description
GuiService allows developers to control what GuiObject is currently being selected by the gamepad navigator, as well as check if Roblox's main menu is currently open.
History 319
- 680 Add ViewportDisplaySize
- 679 Add ViewportSizeInMM
- 677 Add GetClosestVisibleDialogToPosition
- 660 Add GetErrorDetails
- 651 Add GetRawScreenScale
- 650 Remove UserInteractedWithNotification
- 650 Add OnNotificationInteraction
- 650 Add OnNotificationDisplayed
- 650 Remove NotificationDisplayed
- 650 Remove NotificationDismissed
- 642 Remove OpenAttenuationCurveEditor
- 642 Change Tags of RemoveSelectionGroup from [] to [Deprecated]
- 642 Change PreferredDescriptor of RemoveSelectionGroup from to SelectionGroup
- 642 Change Tags of AddSelectionTuple from [] to [Deprecated]
- 642 Change PreferredDescriptor of AddSelectionTuple from to SelectionGroup
- 642 Change Tags of AddSelectionParent from [] to [Deprecated]
- 642 Change PreferredDescriptor of AddSelectionParent from to SelectionGroup
- 641 Add UserInteractedWithNotification
- 641 Add SendNotification
- 641 Add NotificationDisplayed
- 641 Add NotificationDismissed
- 641 Add DismissNotification
- 635 Add OpenStyleEditor
- 634 Add PreferredTextSize
- 629 Change Tags of OpenAttenuationCurveEditor from [] to [Deprecated]
- 624 Change Parameters of OpenAttenuationCurveEditor from (selectedCurveObject: Instance) to (selectedCurveObjects: Objects)
- 620 Add OpenAttenuationCurveEditor
- 599 Change Tags of TopbarInset from [Hidden, ReadOnly, NotReplicated] to [ReadOnly, NotReplicated]
- 598 Add SendUIOcclusionMetricsForQueryRegion
- 592 Add GetHardwareSafeViewport
- 591 Remove TopbarInsetChanged
- 591 Change Parameters of SetTopbarInset from (topbarInset: Dictionary) to (topbarInset: Rect)
- 591 Add TopbarInset
- 590 Add TopbarInsetChanged
- 590 Add SetTopbarInset
- 587 Add ToggleGuiIsVisibleForCaptures
- 583 Add
- 583 Add
- 573 Change ReturnType of SendCoreUiNotification from void to null
- 573 Change ReturnType of ToggleGuiIsVisibleIfAllowed from void to null
- 573 Change ReturnType of ToggleFullscreen from void to null
- 573 Change ReturnType of SetUiMessage from void to null
- 573 Change ReturnType of SetSafeZoneOffsets from void to null
- 573 Change ReturnType of SetPurchasePromptIsShown from void to null
- 573 Change ReturnType of SetMenuIsOpen from void to null
- 573 Change ReturnType of SetInspectMenuEnabled from void to null
- 573 Change ReturnType of SetHardwareSafeAreaInsets from void to null
- 573 Change ReturnType of SetGlobalGuiInset from void to null
- 573 Change ReturnType of SetGameplayPausedNotificationEnabled from void to null
- 573 Change ReturnType of SetEmotesMenuOpen from void to null
- 573 Change ReturnType of Select from void to null
- 573 Change ReturnType of RemoveSpecialKey from void to null
- 573 Change ReturnType of RemoveSelectionGroup from void to null
- 573 Change ReturnType of RemoveKey from void to null
- 573 Change ReturnType of RemoveCenterDialog from void to null
- 573 Change ReturnType of OpenNativeOverlay from void to null
- 573 Change ReturnType of OpenBrowserWindow from void to null
- 573 Change ReturnType of InspectPlayerFromUserIdWithCtx from void to null
- 573 Change ReturnType of InspectPlayerFromUserId from void to null
- 573 Change ReturnType of InspectPlayerFromHumanoidDescription from void to null
- 573 Change ReturnType of ForceTenFootInterface from void to null
- 573 Change ReturnType of CloseInspectMenu from void to null
- 573 Change ReturnType of ClearError from void to null
- 573 Change ReturnType of BroadcastNotification from void to null
- 573 Change ReturnType of AddSpecialKey from void to null
- 573 Change ReturnType of AddSelectionTuple from void to null
- 573 Change ReturnType of AddSelectionParent from void to null
- 573 Change ReturnType of AddKey from void to null
- 573 Change ReturnType of AddCenterDialog from void to null
- 561 Add PurchasePromptShown
- 561 Add SetPurchasePromptIsShown
- 553 Change PreferredDescriptor of ErrorMessageChanged from to UiMessageChanged
- 553 Change PreferredDescriptor of GetErrorMessage from to GetUiMessage
- 553 Change Default of TouchControlsEnabled from to
- 553 Change Default of SelectedObject from to
- 553 Change Default of from to
- 553 Change Default of MenuIsOpen from to
- 553 Change Default of IsWindows from to
- 553 Change Default of IsModalDialog from to
- 553 Change Default of GuiNavigationEnabled from to
- 553 Change Default of from to
- 553 Change Default of from to
- 553 Change Default of from to
- 553 Change Default of AutoSelectGuiEnabled from to
- 546 Add SetHardwareSafeAreaInsets
- 538 Add GuiVisibilityChangedSignal
- 538 Add ToggleGuiIsVisibleIfAllowed
- 538 Add GetGuiIsVisible
- 536 Change Tags of from [] to [Hidden, NotReplicated]
- 536 Change CanSave of from true to false
- 536 Change CanLoad of from true to false
- 523 Change Security of Select from RobloxScriptSecurity to None
- 519 Add Select
- 493 Add TouchControlsEnabled
- 489 Add CoreGuiRenderOverflowed
- 488 Remove CoreGuiRenderOverflowed
- 488 Add CoreGuiRenderOverflowed
- 487 Add Open9SliceEditor
- 486 Change ThreadSafety of SelectedObject from ReadOnly to ReadSafe
- 486 Change ThreadSafety of from ReadOnly to ReadSafe
- 486 Change ThreadSafety of MenuIsOpen from ReadOnly to ReadSafe
- 486 Change ThreadSafety of IsWindows from ReadOnly to ReadSafe
- 486 Change ThreadSafety of IsModalDialog from ReadOnly to ReadSafe
- 486 Change ThreadSafety of GuiNavigationEnabled from ReadOnly to ReadSafe
- 486 Change ThreadSafety of from ReadOnly to ReadSafe
- 486 Change ThreadSafety of from ReadOnly to ReadSafe
- 486 Change ThreadSafety of from ReadOnly to ReadSafe
- 486 Change ThreadSafety of AutoSelectGuiEnabled from ReadOnly to ReadSafe
- 469 Change Tags of from [NotReplicated] to [Hidden, NotReplicated]
- 469 Change CanLoad of from true to false
- 462 Change ThreadSafety of SendCoreUiNotification from to Unsafe
- 462 Change ThreadSafety of UiMessageChanged from to Unsafe
- 462 Change ThreadSafety of SpecialKeyPressed from to Unsafe
- 462 Change ThreadSafety of ShowLeaveConfirmation from to Unsafe
- 462 Change ThreadSafety of SafeZoneOffsetsChanged from to Unsafe
- 462 Change ThreadSafety of NetworkPausedEnabledChanged from to Unsafe
- 462 Change ThreadSafety of NativeClose from to Unsafe
- 462 Change ThreadSafety of MenuOpened from to Unsafe
- 462 Change ThreadSafety of MenuClosed from to Unsafe
- 462 Change ThreadSafety of KeyPressed from to Unsafe
- 462 Change ThreadSafety of InspectPlayerFromUserIdWithCtxRequest from to Unsafe
- 462 Change ThreadSafety of InspectPlayerFromHumanoidDescriptionRequest from to Unsafe
- 462 Change ThreadSafety of InspectMenuEnabledChangedSignal from to Unsafe
- 462 Change ThreadSafety of ErrorMessageChanged from to Unsafe
- 462 Change ThreadSafety of EmotesMenuOpenChanged from to Unsafe
- 462 Change ThreadSafety of CloseInspectMenuRequest from to Unsafe
- 462 Change ThreadSafety of BrowserWindowClosed from to Unsafe
- 462 Change ThreadSafety of ToggleFullscreen from to Unsafe
- 462 Change ThreadSafety of ShowStatsBasedOnInputString from to Unsafe
- 462 Change ThreadSafety of SetUiMessage from to Unsafe
- 462 Change ThreadSafety of SetSafeZoneOffsets from to Unsafe
- 462 Change ThreadSafety of SetMenuIsOpen from to Unsafe
- 462 Change ThreadSafety of SetInspectMenuEnabled from to Unsafe
- 462 Change ThreadSafety of SetGlobalGuiInset from to Unsafe
- 462 Change ThreadSafety of SetGameplayPausedNotificationEnabled from to Unsafe
- 462 Change ThreadSafety of SetEmotesMenuOpen from to Unsafe
- 462 Change ThreadSafety of RemoveSpecialKey from to Unsafe
- 462 Change ThreadSafety of RemoveSelectionGroup from to Unsafe
- 462 Change ThreadSafety of RemoveKey from to Unsafe
- 462 Change ThreadSafety of RemoveCenterDialog from to Unsafe
- 462 Change ThreadSafety of OpenNativeOverlay from to Unsafe
- 462 Change ThreadSafety of OpenBrowserWindow from to Unsafe
- 462 Change ThreadSafety of IsTenFootInterface from to Unsafe
- 462 Change ThreadSafety of IsMemoryTrackerEnabled from to Unsafe
- 462 Change ThreadSafety of InspectPlayerFromUserIdWithCtx from to Unsafe
- 462 Change ThreadSafety of InspectPlayerFromUserId from to Unsafe
- 462 Change ThreadSafety of InspectPlayerFromHumanoidDescription from to Unsafe
- 462 Change ThreadSafety of GetUiMessage from to Unsafe
- 462 Change ThreadSafety of GetScreenResolution from to Unsafe
- 462 Change ThreadSafety of GetSafeZoneOffsets from to Unsafe
- 462 Change ThreadSafety of GetResolutionScale from to Unsafe
- 462 Change ThreadSafety of GetNotificationTypeList from to Unsafe
- 462 Change ThreadSafety of GetInspectMenuEnabled from to Unsafe
- 462 Change ThreadSafety of GetGuiInset from to Unsafe
- 462 Change ThreadSafety of GetGameplayPausedNotificationEnabled from to Unsafe
- 462 Change ThreadSafety of GetErrorType from to Unsafe
- 462 Change ThreadSafety of GetErrorMessage from to Unsafe
- 462 Change ThreadSafety of GetErrorCode from to Unsafe
- 462 Change ThreadSafety of GetEmotesMenuOpen from to Unsafe
- 462 Change ThreadSafety of GetClosestDialogToPosition from to Unsafe
- 462 Change ThreadSafety of GetBrickCount from to Unsafe
- 462 Change ThreadSafety of ForceTenFootInterface from to Unsafe
- 462 Change ThreadSafety of CloseStatsBasedOnInputString from to Unsafe
- 462 Change ThreadSafety of CloseInspectMenu from to Unsafe
- 462 Change ThreadSafety of ClearError from to Unsafe
- 462 Change ThreadSafety of BroadcastNotification from to Unsafe
- 462 Change ThreadSafety of AddSpecialKey from to Unsafe
- 462 Change ThreadSafety of AddSelectionTuple from to Unsafe
- 462 Change ThreadSafety of AddSelectionParent from to Unsafe
- 462 Change ThreadSafety of AddKey from to Unsafe
- 462 Change ThreadSafety of AddCenterDialog from to Unsafe
- 462 Change ThreadSafety of SelectedObject from to ReadOnly
- 462 Change ThreadSafety of from to ReadOnly
- 462 Change ThreadSafety of MenuIsOpen from to ReadOnly
- 462 Change ThreadSafety of IsWindows from to ReadOnly
- 462 Change ThreadSafety of IsModalDialog from to ReadOnly
- 462 Change ThreadSafety of GuiNavigationEnabled from to ReadOnly
- 462 Change ThreadSafety of from to ReadOnly
- 462 Change ThreadSafety of from to ReadOnly
- 462 Change ThreadSafety of from to ReadOnly
- 462 Change ThreadSafety of AutoSelectGuiEnabled from to ReadOnly
- 448 Remove
- 447 Add
- 435 Add NativeClose
- 420 Remove InspectPlayerFromUserIdRequest
- 419 Add InspectPlayerFromUserIdRequest
- 420 Remove InspectPlayerFromUserIdRequest
- 416 Add ForceTenFootInterface
- 398 Add NetworkPausedEnabledChanged
- 398 Add SetGameplayPausedNotificationEnabled
- 398 Add GetGameplayPausedNotificationEnabled
- 394 Add InspectPlayerFromUserIdWithCtxRequest
- 394 Add InspectPlayerFromUserIdWithCtx
- 384 Add InspectPlayerFromUserIdRequest
- 384 Add InspectPlayerFromHumanoidDescriptionRequest
- 384 Add InspectMenuEnabledChangedSignal
- 384 Add CloseInspectMenuRequest
- 384 Add SetInspectMenuEnabled
- 384 Add InspectPlayerFromUserId
- 384 Add InspectPlayerFromHumanoidDescription
- 384 Add GetInspectMenuEnabled
- 384 Add CloseInspectMenu
- 383 Change Security of GetResolutionScale from LocalUserSecurity to RobloxScriptSecurity
- 381 Add EmotesMenuOpenChanged
- 381 Add SetEmotesMenuOpen
- 381 Add GetEmotesMenuOpen
- 378 Change Parameters of SetMenuIsOpen from (open: bool) to (open: bool, menuName: string = default)
- 371 Change Tags of BrowserWindowClosed from [] to [Deprecated]
- 371 Change Tags of OpenNativeOverlay from [] to [Deprecated]
- 371 Change Tags of OpenBrowserWindow from [] to [Deprecated]
- 356 Add ClearError
- 347 Change Parameters of SetUiMessage from (msgType: UiMessageType, uiMessage: string) to (msgType: UiMessageType, uiMessage: string = errorCode)
- 347 Add GetErrorType
- 347 Add GetErrorCode
- 339 Add SafeZoneOffsetsChanged
- 339 Add SetSafeZoneOffsets
- 339 Add GetSafeZoneOffsets
- 329 Change ValueType of SelectedObject from Object to GuiObject
- 329 Change ValueType of from Object to GuiObject
- 329 Change ValueType of from Object to Folder
- 329 Change ValueType of from Object to Folder
- 304 Remove EscapeKeyPressed
- 304 Remove ScreenGuiEnabled
- 303 Remove ShowAppShellTabBar
- 303 Remove RequestNativeView
- 303 Add GetNotificationTypeList
- 303 Remove GetNativeViewFeatureList
- 303 Add BroadcastNotification
- 301 Change Parameters of RequestNativeView from (url: string) to (url: string, featureType: int)
- 301 Add GetNativeViewFeatureList
- 300 Add ShowAppShellTabBar
- 298 Add RequestNativeView
- 298 Add OpenNativeOverlay
- 298 Add IsMemoryTrackerEnabled
- 297 Add CloseStatsBasedOnInputString
- 290 Add GetResolutionScale
- 273 Remove SetErrorMessage
- 272 Add SetErrorMessage
- 273 Remove SetErrorMessage
- 267 Add GetGuiInset
- 265 Add
- 265 Add
- 264 Remove
- 264 Remove
- 265 Add
- 265 Add
- 252 Change Security of IsTenFootInterface from RobloxScriptSecurity to None
- 244 Add ScreenGuiEnabled
- 234 Add
- 232 Add IsTenFootInterface
- 219 Add ShowStatsBasedOnInputString
- 213 Add MenuOpened
- 213 Add MenuClosed
- 213 Add SetMenuIsOpen
- 213 Remove GetVoxelCount
- 213 Remove GetInstanceCount
- 213 Remove GetConnectorCount
- 213 Remove Version
- 213 Remove UseLuaChat
- 213 Remove ShowLegacyPlayerList
- 213 Add MenuIsOpen
- 213 Change Tags of IsWindows from [ReadOnly, NotReplicated] to [ReadOnly, NotReplicated, Deprecated]
- 213 Change Tags of IsModalDialog from [ReadOnly, NotReplicated] to [ReadOnly, NotReplicated, Deprecated]
- 211 Add SendCoreUiNotification
- 206 Add GetClosestDialogToPosition
- 201 Add ToggleFullscreen
- 201 Add GuiNavigationEnabled
- 201 Remove GamepadNavigationEnabled
- 201 Add AutoSelectGuiEnabled
- 197 Change WriteSecurity of SelectedObject from RobloxScriptSecurity to None
- 197 Change ReadSecurity of SelectedObject from RobloxScriptSecurity to None
- 196 Add
- 196 Add GamepadNavigationEnabled
- 193 Add RemoveSelectionGroup
- 193 Add AddSelectionTuple
- 193 Add AddSelectionParent
- 193 Add SelectedObject
- 190 Remove SendNotification
- 182 Add UiMessageChanged
- 182 Change Tags of ErrorMessageChanged from [] to [Deprecated]
- 182 Add SetUiMessage
- 182 Change Tags of SetErrorMessage from [] to [Deprecated]
- 182 Add GetUiMessage
- 182 Change Tags of GetErrorMessage from [] to [Deprecated]
- 171 Add RemoveSpecialKey
- 168 Change ReturnType of GetVoxelCount from int to float
- 162 Add ShowLeaveConfirmation
- 157 Add ErrorMessageChanged
- 157 Add SetErrorMessage
- 157 Add GetVoxelCount
- 157 Add GetInstanceCount
- 157 Add GetErrorMessage
- 157 Add GetConnectorCount
- 157 Add GetBrickCount
- 131 Add GetScreenResolution
- 125 Add RemoveKey
- 124 Add BrowserWindowClosed
- 91 Remove SetGlobalSizeOffsetPixel
- 91 Add SetGlobalGuiInset
- 90 Add SetGlobalSizeOffsetPixel
- 90 Remove SetGlobalGuiInset
- 91 Remove SetGlobalSizeOffsetPixel
- 91 Add SetGlobalGuiInset
- 83 Add OpenBrowserWindow
- 67 Add UseLuaChat
- 67 Add IsWindows
- 47 Add SpecialKeyPressed
- 47 Add KeyPressed
- 47 Add EscapeKeyPressed
- 47 Add SetGlobalSizeOffsetPixel
- 47 Add SendNotification
- 47 Add RemoveCenterDialog
- 47 Add AddSpecialKey
- 47 Add AddKey
- 47 Add AddCenterDialog
- 47 Add Version
- 47 Add ShowLegacyPlayerList
- 47 Add IsModalDialog
- 47 Add GuiService
Members 99
AddCenterDialog
| Parameters (4) | ||
|---|---|---|
| dialog | Instance | |
| centerDialogType | CenterDialogType | |
| showFunction | Function | |
| hideFunction | Function | |
| Returns (1) | ||
| null | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 3
- 573 Change ReturnType of AddCenterDialog from void to null
- 462 Change ThreadSafety of AddCenterDialog from to Unsafe
- 47 Add AddCenterDialog
AddKey
| Parameters (1) | ||
|---|---|---|
| key | string | |
| Returns (1) | ||
| null | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
AddSelectionParent
| Parameters (2) | ||
|---|---|---|
| selectionName | string | |
| selectionParent | Instance | |
| Returns (1) | ||
| null | ||
Creates a gui selection group where gamepad gui navigation will only consider selectable gui objects that are within the group (children of selectionParent). A use case is you have a menu pop open, but there are other selectable objects on the screen (maybe from previous menus), but you want to the user to only be able to select gui objects in the new menu.
| Thread safety | Unsafe |
|---|
History 5
- 642 Change Tags of AddSelectionParent from [] to [Deprecated]
- 642 Change PreferredDescriptor of AddSelectionParent from to SelectionGroup
- 573 Change ReturnType of AddSelectionParent from void to null
- 462 Change ThreadSafety of AddSelectionParent from to Unsafe
- 193 Add AddSelectionParent
AddSelectionTuple
| Parameters (2) | ||
|---|---|---|
| selectionName | string | |
| selections | Tuple | |
| Returns (1) | ||
| null | ||
Functions similarly to GuiService:AddSelectionParent(), but you can give it a tuple of GuiObject that you want to be contained in the group.
| Thread safety | Unsafe |
|---|
History 5
- 642 Change Tags of AddSelectionTuple from [] to [Deprecated]
- 642 Change PreferredDescriptor of AddSelectionTuple from to SelectionGroup
- 573 Change ReturnType of AddSelectionTuple from void to null
- 462 Change ThreadSafety of AddSelectionTuple from to Unsafe
- 193 Add AddSelectionTuple
AddSpecialKey
| Parameters (1) | ||
|---|---|---|
| key | SpecialKey | |
| Returns (1) | ||
| null | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 3
- 573 Change ReturnType of AddSpecialKey from void to null
- 462 Change ThreadSafety of AddSpecialKey from to Unsafe
- 47 Add AddSpecialKey
AutoSelectGuiEnabled
| Type | Default | |
|---|---|---|
| bool | ||
If activated, the Select button on a Gamepad or Backslash
will automatically set a GUI as the selected object. Turning this off will
mean that Gui navigation will still work if
GuiService.GuiNavigationEnabled is enabled but you will have to
set GuiService.SelectedObject manually to start Gui navigation.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | true |
History 4
- 553 Change Default of AutoSelectGuiEnabled from to
- 486 Change ThreadSafety of AutoSelectGuiEnabled from ReadOnly to ReadSafe
- 462 Change ThreadSafety of AutoSelectGuiEnabled from to ReadOnly
- 201 Add AutoSelectGuiEnabled
BroadcastNotification
| Parameters (2) | ||
|---|---|---|
| data | string | |
| notificationType | int | |
| Returns (1) | ||
| null | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 3
- 573 Change ReturnType of BroadcastNotification from void to null
- 462 Change ThreadSafety of BroadcastNotification from to Unsafe
- 303 Add BroadcastNotification
BrowserWindowClosed
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 3
- 462 Change ThreadSafety of BrowserWindowClosed from to Unsafe
- 371 Change Tags of BrowserWindowClosed from [] to [Deprecated]
- 124 Add BrowserWindowClosed
ClearError
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| null | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 3
- 573 Change ReturnType of ClearError from void to null
- 462 Change ThreadSafety of ClearError from to Unsafe
- 356 Add ClearError
CloseInspectMenu
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| null | ||
This function closes the Inspect Menu, if open, when run from a LocalScript.
See also:
- Avatar Inspect Menu, an article providing a more detailed explanation of the Inspect and Buy feature and how it works
- GuiService:InspectPlayerFromHumanoidDescription(), allows a developer to bring up the Inspect menu showing the assets listed in this HumanoidDescription object. This is especially useful when what is being worn on a player's avatar on the Roblox platform is not necessarily the same as their in-game appearance
- GuiService:InspectPlayerFromUserId(), allows the 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 game
| Thread safety | Unsafe |
|---|
History 3
- 573 Change ReturnType of CloseInspectMenu from void to null
- 462 Change ThreadSafety of CloseInspectMenu from to Unsafe
- 384 Add CloseInspectMenu
CloseInspectMenuRequest
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 2
- 462 Change ThreadSafety of CloseInspectMenuRequest from to Unsafe
- 384 Add CloseInspectMenuRequest
CloseStatsBasedOnInputString
| Parameters (1) | ||
|---|---|---|
| input | string | |
| Returns (1) | ||
| bool | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 2
- 462 Change ThreadSafety of CloseStatsBasedOnInputString from to Unsafe
- 297 Add CloseStatsBasedOnInputString
CoreGuiRenderOverflowed
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 3
DismissNotification
| Parameters (1) | ||
|---|---|---|
| notificationId | string | |
| Returns (1) | ||
| bool | ||
| Thread safety | Unsafe |
|---|
History 1
EmotesMenuOpenChanged
| Parameters (1) | |
|---|---|
| isOpen | bool |
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 2
- 462 Change ThreadSafety of EmotesMenuOpenChanged from to Unsafe
- 381 Add EmotesMenuOpenChanged
ErrorMessageChanged
| Parameters (1) | |
|---|---|
| newErrorMessage | string |
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 4
- 553 Change PreferredDescriptor of ErrorMessageChanged from to UiMessageChanged
- 462 Change ThreadSafety of ErrorMessageChanged from to Unsafe
- 182 Change Tags of ErrorMessageChanged from [] to [Deprecated]
- 157 Add ErrorMessageChanged
ForceTenFootInterface
| Parameters (1) | ||
|---|---|---|
| isForced | bool | |
| Returns (1) | ||
| null | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 3
- 573 Change ReturnType of ForceTenFootInterface from void to null
- 462 Change ThreadSafety of ForceTenFootInterface from to Unsafe
- 416 Add ForceTenFootInterface
GetBrickCount
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| int | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 2
- 462 Change ThreadSafety of GetBrickCount from to Unsafe
- 157 Add GetBrickCount
GetClosestDialogToPosition
| Parameters (1) | ||
|---|---|---|
| position | Vector3 | |
| Returns (1) | ||
| Instance | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 2
- 462 Change ThreadSafety of GetClosestDialogToPosition from to Unsafe
- 206 Add GetClosestDialogToPosition
GetClosestVisibleDialogToPosition
| Parameters (1) | ||
|---|---|---|
| position | Vector3 | |
| Returns (1) | ||
| Dialog | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
GetEmotesMenuOpen
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| bool | ||
Returns a boolean indicating whether or not the player Emotes menu is open.
Developers can open or close the Emotes menu by calling the GuiService:SetEmotesMenuOpen() function.
| Thread safety | Unsafe |
|---|
History 2
- 462 Change ThreadSafety of GetEmotesMenuOpen from to Unsafe
- 381 Add GetEmotesMenuOpen
GetErrorCode
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| ConnectionError | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 2
- 462 Change ThreadSafety of GetErrorCode from to Unsafe
- 347 Add GetErrorCode
GetErrorDetails
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| Dictionary | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
- 660 Add GetErrorDetails
GetErrorMessage
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| string | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 4
- 553 Change PreferredDescriptor of GetErrorMessage from to GetUiMessage
- 462 Change ThreadSafety of GetErrorMessage from to Unsafe
- 182 Change Tags of GetErrorMessage from [] to [Deprecated]
- 157 Add GetErrorMessage
GetErrorType
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| ConnectionError | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 2
- 462 Change ThreadSafety of GetErrorType from to Unsafe
- 347 Add GetErrorType
GetGameplayPausedNotificationEnabled
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| bool | ||
This function returns whether or not the gameplay paused notification has been disabled by the developer.
Developers can enable or disable the notification by calling the GuiService:SetGameplayPausedNotificationEnabled() function.
See also:
- Workspace.StreamingIntegrityMode and StreamingIntegrityMode for more details on when gameplay is paused.
| Thread safety | Unsafe |
|---|
History 2
- 462 Change ThreadSafety of GetGameplayPausedNotificationEnabled from to Unsafe
- 398 Add GetGameplayPausedNotificationEnabled
GetGuiInset
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| 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.
The inset values supplied by this function only take effect on ScreenGuis that have their IgnoreGuiInset property set to false.
| Thread safety | Unsafe |
|---|
History 2
- 462 Change ThreadSafety of GetGuiInset from to Unsafe
- 267 Add GetGuiInset
GetGuiIsVisible
| Parameters (1) | ||
|---|---|---|
| guiType | GuiType | |
| Returns (1) | ||
| bool | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
- 538 Add GetGuiIsVisible
GetHardwareSafeViewport
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| Vector2 | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
GetInspectMenuEnabled
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| bool | ||
This function returns whether the Inspect and Buy menu functionality is currently enabled. The feature is enabled by default and can be set using the GuiService:SetInspectMenuEnabled() function.
See also:
- Avatar Inspect Menu, an article providing a more detailed explanation of the Inspect and Buy feature and how it works
- GuiService:InspectPlayerFromHumanoidDescription(), allows a developer to bring up the Inspect menu showing the assets listed in this HumanoidDescription object. This is especially useful when what is being worn on a player's avatar on the Roblox platform is not necessarily the same as their in-game appearance
- GuiService:InspectPlayerFromUserId(), allows the 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 game
| Thread safety | Unsafe |
|---|
History 2
- 462 Change ThreadSafety of GetInspectMenuEnabled from to Unsafe
- 384 Add GetInspectMenuEnabled
GetNotificationTypeList
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| Dictionary | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 2
- 462 Change ThreadSafety of GetNotificationTypeList from to Unsafe
- 303 Add GetNotificationTypeList
GetRawScreenScale
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| float | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
- 651 Add GetRawScreenScale
GetResolutionScale
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| int | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 3
- 462 Change ThreadSafety of GetResolutionScale from to Unsafe
- 383 Change Security of GetResolutionScale from LocalUserSecurity to RobloxScriptSecurity
- 290 Add GetResolutionScale
GetSafeZoneOffsets
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| Dictionary | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 2
- 462 Change ThreadSafety of GetSafeZoneOffsets from to Unsafe
- 339 Add GetSafeZoneOffsets
GetScreenResolution
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| Vector2 | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 2
- 462 Change ThreadSafety of GetScreenResolution from to Unsafe
- 131 Add GetScreenResolution
GetUiMessage
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| string | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 2
- 462 Change ThreadSafety of GetUiMessage from to Unsafe
- 182 Add GetUiMessage
GuiVisibilityChangedSignal
| Parameters (2) | |
|---|---|
| guiType | GuiType |
| visible | bool |
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
InspectMenuEnabledChangedSignal
| Parameters (1) | |
|---|---|
| enabled | bool |
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 2
- 462 Change ThreadSafety of InspectMenuEnabledChangedSignal from to Unsafe
- 384 Add InspectMenuEnabledChangedSignal
InspectPlayerFromHumanoidDescription
| Parameters (2) | ||
|---|---|---|
| humanoidDescription | Instance | |
| name | string | |
| Returns (1) | ||
| null | ||
This function allows a developer to bring up the Inspect menu showing the assets listed in this HumanoidDescription object.
This allows further customization with what is shown in the Inspect Menu when players inspect other players in your game. If your game modifies what the players are wearing, you can instead give the Inspect Menu a HumanoidDescription object that represents what a player is wearing and those items will be shown. You should pass a name as well to represent the name of the player that will be inspected.
See also:
- Avatar Inspect Menu, an article providing a more detailed explanation of the Inspect and Buy feature and how it works
- GuiService:SetInspectMenuEnabled(), allows developers to enable or disable default Inspect and Buy functionality
- GuiService:InspectPlayerFromUserId(), allows the 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 game.
| Thread safety | Unsafe |
|---|
History 3
- 573 Change ReturnType of InspectPlayerFromHumanoidDescription from void to null
- 462 Change ThreadSafety of InspectPlayerFromHumanoidDescription from to Unsafe
- 384 Add InspectPlayerFromHumanoidDescription
InspectPlayerFromHumanoidDescriptionRequest
| Parameters (2) | |
|---|---|
| humanoidDescription | Instance |
| name | string |
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 2
- 462 Change ThreadSafety of InspectPlayerFromHumanoidDescriptionRequest from to Unsafe
- 384 Add InspectPlayerFromHumanoidDescriptionRequest
InspectPlayerFromUserId
| Parameters (1) | ||
|---|---|---|
| userId | int64 | |
| Returns (1) | ||
| null | ||
This function allows the 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 game.
This shows the same information as the "Currently Wearing" tab on the specified user's profile.
See also:
- Avatar Inspect Menu, an article providing a more detailed explanation of the Inspect and Buy feature and how it works
- GuiService:SetInspectMenuEnabled(), allows developers to enable or disable default Inspect and Buy functionality. This is especially useful when what is being worn on a player's avatar on the Roblox platform is not necessarily the same as their in-game appearance
- GuiService:InspectPlayerFromHumanoidDescription(), allows a developer to bring up the Inspect menu showing the assets listed in this HumanoidDescription object
| Thread safety | Unsafe |
|---|
History 3
- 573 Change ReturnType of InspectPlayerFromUserId from void to null
- 462 Change ThreadSafety of InspectPlayerFromUserId from to Unsafe
- 384 Add InspectPlayerFromUserId
InspectPlayerFromUserIdWithCtx
| Parameters (2) | ||
|---|---|---|
| userId | int64 | |
| ctx | string | |
| Returns (1) | ||
| null | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 3
- 573 Change ReturnType of InspectPlayerFromUserIdWithCtx from void to null
- 462 Change ThreadSafety of InspectPlayerFromUserIdWithCtx from to Unsafe
- 394 Add InspectPlayerFromUserIdWithCtx
InspectPlayerFromUserIdWithCtxRequest
| Parameters (2) | |
|---|---|
| userId | int64 |
| ctx | string |
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 2
- 462 Change ThreadSafety of InspectPlayerFromUserIdWithCtxRequest from to Unsafe
- 394 Add InspectPlayerFromUserIdWithCtxRequest
IsMemoryTrackerEnabled
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| bool | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 2
- 462 Change ThreadSafety of IsMemoryTrackerEnabled from to Unsafe
- 298 Add IsMemoryTrackerEnabled
IsModalDialog
| Type | Default | |
|---|---|---|
| bool | ||
This property tells whether or not a modal dialog is visible, such as the game menu or a purchase prompt.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | false |
History 5
- 553 Change Default of IsModalDialog from to
- 486 Change ThreadSafety of IsModalDialog from ReadOnly to ReadSafe
- 462 Change ThreadSafety of IsModalDialog from to ReadOnly
- 213 Change Tags of IsModalDialog from [ReadOnly, NotReplicated] to [ReadOnly, NotReplicated, Deprecated]
- 47 Add IsModalDialog
IsTenFootInterface
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| 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.
| Thread safety | Unsafe |
|---|
History 3
- 462 Change ThreadSafety of IsTenFootInterface from to Unsafe
- 252 Change Security of IsTenFootInterface from RobloxScriptSecurity to None
- 232 Add IsTenFootInterface
IsWindows
| Type | Default | |
|---|---|---|
| bool | ||
The IsWindows property defines if the user is playing on a computer running Windows.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | false |
KeyPressed
| Parameters (2) | |
|---|---|
| key | string |
| modifiers | string |
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 2
- 462 Change ThreadSafety of KeyPressed from to Unsafe
- 47 Add KeyPressed
MenuClosed
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
Fires when the user closes the Roblox coregui escape menu.
| Thread safety | Unsafe |
|---|
History 2
- 462 Change ThreadSafety of MenuClosed from to Unsafe
- 213 Add MenuClosed
MenuIsOpen
| Type | Default | |
|---|---|---|
| bool | ||
Returns true if any menu of CoreGui is open.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | false/true |
History 4
- 553 Change Default of MenuIsOpen from to
- 486 Change ThreadSafety of MenuIsOpen from ReadOnly to ReadSafe
- 462 Change ThreadSafety of MenuIsOpen from to ReadOnly
- 213 Add MenuIsOpen
MenuOpened
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
Fires when the user opens the Roblox coregui escape menu.
| Thread safety | Unsafe |
|---|
History 2
- 462 Change ThreadSafety of MenuOpened from to Unsafe
- 213 Add MenuOpened
NativeClose
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 2
- 462 Change ThreadSafety of NativeClose from to Unsafe
- 435 Add NativeClose
NetworkPausedEnabledChanged
| Parameters (1) | |
|---|---|
| enabled | bool |
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 2
- 462 Change ThreadSafety of NetworkPausedEnabledChanged from to Unsafe
- 398 Add NetworkPausedEnabledChanged
OnNotificationDisplayed
| Parameters (1) | ||
|---|---|---|
| notificationId | string | |
| Returns (1) | ||
| null | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
OnNotificationInteraction
| Parameters (2) | ||
|---|---|---|
| notificationId | string | |
| buttonIndex | int | |
| Returns (1) | ||
| null | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
Open9SliceEditor
| Parameters (1) | |
|---|---|
| selectedImageObject | Instance |
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
- 487 Add Open9SliceEditor
OpenBrowserWindow
| Parameters (1) | ||
|---|---|---|
| url | string | |
| Returns (1) | ||
| null | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 4
- 573 Change ReturnType of OpenBrowserWindow from void to null
- 462 Change ThreadSafety of OpenBrowserWindow from to Unsafe
- 371 Change Tags of OpenBrowserWindow from [] to [Deprecated]
- 83 Add OpenBrowserWindow
OpenNativeOverlay
| Parameters (2) | ||
|---|---|---|
| title | string | |
| url | string | |
| Returns (1) | ||
| null | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 4
- 573 Change ReturnType of OpenNativeOverlay from void to null
- 462 Change ThreadSafety of OpenNativeOverlay from to Unsafe
- 371 Change Tags of OpenNativeOverlay from [] to [Deprecated]
- 298 Add OpenNativeOverlay
OpenStyleEditor
| Parameters (1) | |
|---|---|
| styleBase | Instance |
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
- 635 Add OpenStyleEditor
PreferredTextSize
| Type | Default | |
|---|---|---|
| PreferredTextSize | ||
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | false |
History 1
- 634 Add PreferredTextSize
PurchasePromptShown
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
RemoveCenterDialog
| Parameters (1) | ||
|---|---|---|
| dialog | Instance | |
| Returns (1) | ||
| null | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 3
- 573 Change ReturnType of RemoveCenterDialog from void to null
- 462 Change ThreadSafety of RemoveCenterDialog from to Unsafe
- 47 Add RemoveCenterDialog
RemoveKey
| Parameters (1) | ||
|---|---|---|
| key | string | |
| Returns (1) | ||
| null | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
RemoveSelectionGroup
| Parameters (1) | ||
|---|---|---|
| selectionName | string | |
| Returns (1) | ||
| null | ||
Removes a group that was created with GuiService:AddSelectionParent() or GuiService:AddSelectionTuple().
| Thread safety | Unsafe |
|---|
History 5
- 642 Change Tags of RemoveSelectionGroup from [] to [Deprecated]
- 642 Change PreferredDescriptor of RemoveSelectionGroup from to SelectionGroup
- 573 Change ReturnType of RemoveSelectionGroup from void to null
- 462 Change ThreadSafety of RemoveSelectionGroup from to Unsafe
- 193 Add RemoveSelectionGroup
RemoveSpecialKey
| Parameters (1) | ||
|---|---|---|
| key | SpecialKey | |
| Returns (1) | ||
| null | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 3
- 573 Change ReturnType of RemoveSpecialKey from void to null
- 462 Change ThreadSafety of RemoveSpecialKey from to Unsafe
- 171 Add RemoveSpecialKey
SafeZoneOffsetsChanged
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 2
- 462 Change ThreadSafety of SafeZoneOffsetsChanged from to Unsafe
- 339 Add SafeZoneOffsetsChanged
Select
| Parameters (1) | ||
|---|---|---|
| selectionParent | Instance | |
| Returns (1) | ||
| null | ||
When Select is called on an instance selectionParent that is PlayerGui or a descendant of PlayerGui, the engine searches all available selectable, visible and on-screen GuiObjects that are descendants of selectionParent and sets the GuiService.SelectedObject to the GuiObject with the smallest GuiService.SelectionOrder.
| Thread safety | Unsafe |
|---|
SelectedObject
| Type | Default | |
|---|---|---|
| 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.
This property is changed by the GuiObject.SelectionGained and GuiObject.SelectionLost events.
If you would like to determine when this property changes without tracking the SelectionGained and SelectionLost events for all GUI elements, you can use the Changed event.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | true |
History 7
- 553 Change Default of SelectedObject from to
- 486 Change ThreadSafety of SelectedObject from ReadOnly to ReadSafe
- 462 Change ThreadSafety of SelectedObject from to ReadOnly
- 329 Change ValueType of SelectedObject from Object to GuiObject
- 197 Change WriteSecurity of SelectedObject from RobloxScriptSecurity to None
- 197 Change ReadSecurity of SelectedObject from RobloxScriptSecurity to None
- 193 Add SelectedObject
SendCoreUiNotification
| Parameters (2) | ||
|---|---|---|
| title | string | |
| text | string | |
| Returns (1) | ||
| null | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 3
- 573 Change ReturnType of SendCoreUiNotification from void to null
- 462 Change ThreadSafety of SendCoreUiNotification from to Unsafe
- 211 Add SendCoreUiNotification
SendNotification
| Parameters (1) | ||
|---|---|---|
| notificationInfo | Dictionary | |
| Returns (1) | ||
| string | ||
| Thread safety | Unsafe |
|---|
History 3
- 641 Add SendNotification
- 190 Remove SendNotification
- 47 Add SendNotification
SendUIOcclusionMetricsForQueryRegion
| Parameters (3) | ||
|---|---|---|
| position | UDim2 | |
| size | UDim2 | |
| regionName | string | |
| Returns (1) | ||
| null | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
SetEmotesMenuOpen
| Parameters (1) | ||
|---|---|---|
| isOpen | bool | |
| Returns (1) | ||
| null | ||
Opens or closes the player Emotes menu.
| Thread safety | Unsafe |
|---|
History 3
- 573 Change ReturnType of SetEmotesMenuOpen from void to null
- 462 Change ThreadSafety of SetEmotesMenuOpen from to Unsafe
- 381 Add SetEmotesMenuOpen
SetGameplayPausedNotificationEnabled
| Parameters (1) | ||
|---|---|---|
| enabled | bool | |
| Returns (1) | ||
| null | ||
This method allows developers to disable the built-in notification when a players gameplay is paused. They can then add in their own UI if they wish to customize it.
Developers can query whether the notification is enabled by calling the GuiService:GetGameplayPausedNotificationEnabled() function.
See also:
- Workspace.StreamingIntegrityMode and StreamingIntegrityMode for more details on when gameplay is paused.
| Thread safety | Unsafe |
|---|
History 3
- 573 Change ReturnType of SetGameplayPausedNotificationEnabled from void to null
- 462 Change ThreadSafety of SetGameplayPausedNotificationEnabled from to Unsafe
- 398 Add SetGameplayPausedNotificationEnabled
SetGlobalGuiInset
| Parameters (4) | ||
|---|---|---|
| x1 | int | |
| y1 | int | |
| x2 | int | |
| y2 | int | |
| Returns (1) | ||
| null | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 5
- 573 Change ReturnType of SetGlobalGuiInset from void to null
- 462 Change ThreadSafety of SetGlobalGuiInset from to Unsafe
- 91 Add SetGlobalGuiInset
- 90 Remove SetGlobalGuiInset
- 91 Add SetGlobalGuiInset
SetHardwareSafeAreaInsets
| Parameters (4) | ||
|---|---|---|
| left | float | |
| top | float | |
| right | float | |
| bottom | float | |
| Returns (1) | ||
| null | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 2
- 573 Change ReturnType of SetHardwareSafeAreaInsets from void to null
- 546 Add SetHardwareSafeAreaInsets
SetInspectMenuEnabled
| Parameters (1) | ||
|---|---|---|
| enabled | bool | |
| Returns (1) | ||
| null | ||
This function allows developers to enable or disable default Inspect and Buy functionality. This is useful when you want to disable the feature in your game, entirely or during certain parts of your game (such as a cutscene). The feature is enabled by default.
The code sample below demonstrates how to disable the Inspect Menu for your game:
1 2 | |
See also:
- Avatar Inspect Menu, an article providing a more detailed explanation of the Inspect and Buy feature and how it works
- GuiService:InspectPlayerFromHumanoidDescription(), allows a developer to bring up the Inspect menu showing the assets listed in this HumanoidDescription object. This is especially useful when what is being worn on a player's avatar on the Roblox platform is not necessarily the same as their in-game appearance
- GuiService:InspectPlayerFromUserId(), allows the 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 game
| Thread safety | Unsafe |
|---|
History 3
- 573 Change ReturnType of SetInspectMenuEnabled from void to null
- 462 Change ThreadSafety of SetInspectMenuEnabled from to Unsafe
- 384 Add SetInspectMenuEnabled
SetMenuIsOpen
| Parameters (2) | Default | |
|---|---|---|
| open | bool | |
| menuName | string | default |
| Returns (1) | ||
| null | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 4
- 573 Change ReturnType of SetMenuIsOpen from void to null
- 462 Change ThreadSafety of SetMenuIsOpen from to Unsafe
- 378 Change Parameters of SetMenuIsOpen from (open: bool) to (open: bool, menuName: string = default)
- 213 Add SetMenuIsOpen
SetPurchasePromptIsShown
| Parameters (1) | ||
|---|---|---|
| isShown | bool | |
| Returns (1) | ||
| null | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 2
- 573 Change ReturnType of SetPurchasePromptIsShown from void to null
- 561 Add SetPurchasePromptIsShown
SetSafeZoneOffsets
| Parameters (4) | ||
|---|---|---|
| top | float | |
| bottom | float | |
| left | float | |
| right | float | |
| Returns (1) | ||
| null | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 3
- 573 Change ReturnType of SetSafeZoneOffsets from void to null
- 462 Change ThreadSafety of SetSafeZoneOffsets from to Unsafe
- 339 Add SetSafeZoneOffsets
SetTopbarInset
| Parameters (1) | ||
|---|---|---|
| topbarInset | Rect | |
| Returns (1) | ||
| null | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 2
- 591 Change Parameters of SetTopbarInset from (topbarInset: Dictionary) to (topbarInset: Rect)
- 590 Add SetTopbarInset
SetUiMessage
| Parameters (2) | Default | |
|---|---|---|
| msgType | UiMessageType | |
| uiMessage | string | errorCode |
| Returns (1) | ||
| null | ||
| Security | LocalUserSecurity |
|---|---|
| Thread safety | Unsafe |
History 4
- 573 Change ReturnType of SetUiMessage from void to null
- 462 Change ThreadSafety of SetUiMessage from to Unsafe
- 347 Change Parameters of SetUiMessage from (msgType: UiMessageType, uiMessage: string) to (msgType: UiMessageType, uiMessage: string = errorCode)
- 182 Add SetUiMessage
ShowLeaveConfirmation
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 2
- 462 Change ThreadSafety of ShowLeaveConfirmation from to Unsafe
- 162 Add ShowLeaveConfirmation
ShowStatsBasedOnInputString
| Parameters (1) | ||
|---|---|---|
| input | string | |
| Returns (1) | ||
| bool | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 2
- 462 Change ThreadSafety of ShowStatsBasedOnInputString from to Unsafe
- 219 Add ShowStatsBasedOnInputString
SpecialKeyPressed
| Parameters (2) | |
|---|---|
| key | SpecialKey |
| modifiers | string |
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 2
- 462 Change ThreadSafety of SpecialKeyPressed from to Unsafe
- 47 Add SpecialKeyPressed
ToggleFullscreen
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| null | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 3
- 573 Change ReturnType of ToggleFullscreen from void to null
- 462 Change ThreadSafety of ToggleFullscreen from to Unsafe
- 201 Add ToggleFullscreen
ToggleGuiIsVisibleForCaptures
| Parameters (1) | ||
|---|---|---|
| guiType | GuiType | |
| Returns (1) | ||
| null | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
ToggleGuiIsVisibleIfAllowed
| Parameters (1) | ||
|---|---|---|
| guiType | GuiType | |
| Returns (1) | ||
| null | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 2
- 573 Change ReturnType of ToggleGuiIsVisibleIfAllowed from void to null
- 538 Add ToggleGuiIsVisibleIfAllowed
TopbarInset
| Type | Default | |
|---|---|---|
| Rect | ||
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().
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | false |
History 2
- 599 Change Tags of TopbarInset from [Hidden, ReadOnly, NotReplicated] to [ReadOnly, NotReplicated]
- 591 Add TopbarInset
TouchControlsEnabled
| Type | Default | |
|---|---|---|
| bool | ||
Used to enable and disable touch controls and touch control display UI. Defaults to true.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | false |
History 2
- 553 Change Default of TouchControlsEnabled from to
- 493 Add TouchControlsEnabled
UiMessageChanged
| Parameters (2) | |
|---|---|
| msgType | UiMessageType |
| newUiMessage | string |
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 2
- 462 Change ThreadSafety of UiMessageChanged from to Unsafe
- 182 Add UiMessageChanged
ViewportDisplaySize
| Type | Default | |
|---|---|---|
| DisplaySize | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Data |
| Loaded/Saved | false |
History 1
ViewportSizeInMM
| Type | Default | |
|---|---|---|
| Vector2 | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Data |
| Loaded/Saved | false |
History 1
- 679 Add ViewportSizeInMM
Removed members 21
EscapeKeyPressed
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Security | RobloxScriptSecurity |
|---|
History 2
- 304 Remove EscapeKeyPressed
- 47 Add EscapeKeyPressed
GetConnectorCount
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| int | ||
| Security | RobloxScriptSecurity |
|---|
History 2
- 213 Remove GetConnectorCount
- 157 Add GetConnectorCount
GetInstanceCount
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| int | ||
| Security | RobloxScriptSecurity |
|---|
History 2
- 213 Remove GetInstanceCount
- 157 Add GetInstanceCount
GetNativeViewFeatureList
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| Dictionary | ||
| Security | RobloxScriptSecurity |
|---|
History 2
GetVoxelCount
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| float | ||
| Security | RobloxScriptSecurity |
|---|
History 3
- 213 Remove GetVoxelCount
- 168 Change ReturnType of GetVoxelCount from int to float
- 157 Add GetVoxelCount
InspectPlayerFromUserIdRequest
| Parameters (1) | |
|---|---|
| userId | int64 |
| Security | RobloxScriptSecurity |
|---|
History 4
NotificationDismissed
| Parameters (1) | ||
|---|---|---|
| notificationId | string | |
| Returns (1) | ||
| null | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 2
- 650 Remove NotificationDismissed
- 641 Add NotificationDismissed
NotificationDisplayed
| Parameters (1) | ||
|---|---|---|
| notificationId | string | |
| Returns (1) | ||
| null | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 2
- 650 Remove NotificationDisplayed
- 641 Add NotificationDisplayed
OpenAttenuationCurveEditor
| Parameters (1) | |
|---|---|
| selectedCurveObjects | Objects |
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 4
- 642 Remove OpenAttenuationCurveEditor
- 629 Change Tags of OpenAttenuationCurveEditor from [] to [Deprecated]
- 624 Change Parameters of OpenAttenuationCurveEditor from (selectedCurveObject: Instance) to (selectedCurveObjects: Objects)
- 620 Add OpenAttenuationCurveEditor
RequestNativeView
| Parameters (2) | ||
|---|---|---|
| url | string | |
| featureType | int | |
| Returns (1) | ||
| void | ||
| Security | RobloxScriptSecurity |
|---|
History 3
- 303 Remove RequestNativeView
- 301 Change Parameters of RequestNativeView from (url: string) to (url: string, featureType: int)
- 298 Add RequestNativeView
ScreenGuiEnabled
| Type | Default | |
|---|---|---|
| bool | ||
| Security | RobloxScriptSecurity |
|---|---|
| Category | |
| Loaded/Saved | false |
History 2
- 304 Remove ScreenGuiEnabled
- 244 Add ScreenGuiEnabled
SetErrorMessage
| Parameters (1) | ||
|---|---|---|
| errorMessage | string | |
| Returns (1) | ||
| void | ||
| Security | LocalUserSecurity |
|---|
History 5
- 273 Remove SetErrorMessage
- 272 Add SetErrorMessage
- 273 Remove SetErrorMessage
- 182 Change Tags of SetErrorMessage from [] to [Deprecated]
- 157 Add SetErrorMessage
SetGlobalSizeOffsetPixel
| Parameters (2) | ||
|---|---|---|
| x | int | |
| y | int | |
| Returns (1) | ||
| void | ||
| Security | RobloxScriptSecurity |
|---|
History 4
- 91 Remove SetGlobalSizeOffsetPixel
- 90 Add SetGlobalSizeOffsetPixel
- 91 Remove SetGlobalSizeOffsetPixel
- 47 Add SetGlobalSizeOffsetPixel
ShowAppShellTabBar
| Parameters (1) | ||
|---|---|---|
| value | bool | |
| Returns (1) | ||
| void | ||
| Security | RobloxScriptSecurity |
|---|
History 2
- 303 Remove ShowAppShellTabBar
- 300 Add ShowAppShellTabBar
ShowLegacyPlayerList
| Type | Default | |
|---|---|---|
| bool | ||
| Security | RobloxScriptSecurity |
|---|---|
| Category | |
| Loaded/Saved | false |
History 2
- 213 Remove ShowLegacyPlayerList
- 47 Add ShowLegacyPlayerList
TopbarInsetChanged
| Parameters (1) | |
|---|---|
| topbarInset | Dictionary |
| Thread safety | Unsafe |
|---|
History 2
- 591 Remove TopbarInsetChanged
- 590 Add TopbarInsetChanged
UseLuaChat
| Type | Default | |
|---|---|---|
| bool | ||
| Category | |
|---|---|
| Loaded/Saved | false |
History 2
- 213 Remove UseLuaChat
- 67 Add UseLuaChat
UserInteractedWithNotification
| Parameters (2) | ||
|---|---|---|
| notificationId | string | |
| buttonIndex | int | |
| Returns (1) | ||
| null | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 2
Version
| Type | Default | |
|---|---|---|
| double | ||
| Category | |
|---|---|
| Loaded/Saved | false |