StarterGui¶
A container for LayerCollector objects to be copied into the PlayerGui of Players. Also provides a range of functions for interacting with the CoreGui.
Note: CoreGui toggles and SetCore/GetCore are present.
Description¶
StarterGui is a container object designed to hold LayerCollector objects such as ScreenGuis.
When a Player.Character spawns, the contents of their
PlayerGui (if any) are emptied. Children of the StarterGui are
then copied along with their descendants into the PlayerGui. Note,
however, that LayerCollector objects such as
ScreenGuis with their
ResetOnSpawn property set to false will
only be placed into each player's PlayerGui once and will not be
deleted when the Player respawns.
StarterGui also includes a range of functions allowing you to interact with the CoreGui. For example StarterGui.SetCoreGuiEnabled() can be used to disable elements of the CoreGui, and StarterGui.SetCore() can perform a range of functions including creating notifications and system messages.
Inheritance¶
Object → Instance → BasePlayerGui → StarterGui
Nova inheritance: Instance → BasePlayerGui → StarterGui
Properties¶
ResetPlayerGuiOnSpawn Supported Property Deprecated Determines whether each child parented to the StarterGui will be cloned into a player's PlayerGui when that player's character is respawned.
Determines whether each child parented to the StarterGui will be cloned into a player's PlayerGui when that player's character is respawned.
If set to true, each child parented to the StarterGui will be cloned into a player's PlayerGui when that player's character is respawned.
If one of the children is a PlayerGui and it has its PlayerGui property set to false, it will not be cloned.
ShowDevelopmentGui Supported Property Determines whether the contents of StarterGui is visible in Studio.
This property determines whether the contents of StarterGui is visible in Studio.
Methods¶
GetCore Supported Function Returns a variable that has been specified by a Roblox core script.
Returns a variable that has been specified by a Roblox core script.
This method returns data set or made available by Roblox's core scripts. The first and only parameter is a string that selects the information to be fetched. The following sections describe the strings and the data they return by this function.
Calling this method may yield. Many of these also register an equivalent SetCore() function (these are marked with an asterisk).
PointsNotificationsActive *¶
Returns true if player point notifications are enabled.
BadgesNotificationsActive *¶
Returns true if badge notifications are enabled.
AvatarContextMenuEnabled *¶
Returns true if the
Avatar Context Menu is enabled.
ChatActive *¶
Returns whether the chat is active or not. This is indicated by the selection state of the top bar's chat icon.
ChatWindowSize *¶
Returns the size of the chat window as a UDim2.
ChatWindowPosition *¶
Returns the size of the chat window as a UDim2.
ChatBarDisabled *¶
Returns true if the chat bar is disabled.
GetBlockedUserIds¶
Returns a list of UserIds associated with users that have been blocked by the local player.
PlayerBlockedEvent¶
Returns a BindableEvent that is fired whenever a player is blocked by the local player.
PlayerUnblockedEvent¶
Returns a BindableEvent that is fired whenever a player is unblocked by the local player.
PlayerMutedEvent¶
Returns a BindableEvent that is fired whenever a player is muted by the local player.
PlayerUnmutedEvent¶
Returns a BindableEvent that is fired whenever a player is unmuted by the local player.
PlayerFriendedEvent¶
Returns a BindableEvent that is fired whenever a player is connected by the local player.
PlayerUnfriendedEvent¶
Returns a BindableEvent that is fired whenever a player is unconnected by the local player.
DevConsoleVisible *¶
Returns true if the
Developer Console is visible.
VRRotationIntensity¶
Returns a string describing the camera rotation sensitivity in VR: Low,
High and Smooth. This will not be available unless
VRService.VREnabled is true.
GetCoreGuiEnabled Supported Function Returns whether the given CoreGuiTypeis enabled, or if it has been disabled using StarterGui.SetCoreGuiEnabled().
This function returns whether the given CoreGuiTypeis enabled, or if it has been disabled using StarterGui.SetCoreGuiEnabled(). This function should be called on the client.
Note that setting "TopbarEnabled" to false using
SetCore() hides all
CoreGuiTypes but does not affect the result of this
function.
RegisterGetCore Supported Function
No description available.
Roblox reference signature
RobloxScriptSecurityRegisterSetCore Supported Function
No description available.
Roblox reference signature
RobloxScriptSecuritySetCore Supported Function Allows you to perform certain interactions with Roblox's core scripts.
Allows you to perform certain interactions with Roblox's core scripts.
This method (not to be confused with SetCoreGuiEnabled()) exposes a variety of functionality defined by Roblox's core scripts, such as sending notifications, toggling notifications for badges/points, defining a callback for the reset button, or toggling the topbar.
The first parameter is a string that selects the functionality with which
the call will interact. It may be necessary to call this method multiple
times using Global.LuaGlobals.pcall() in case the respective core script
has not yet loaded (or if it has been disabled entirely).
The following table describes the strings that may be accepted as the first parameter. The parameters that should follow are dependent on the functionality that will be used and are described in sub-tables.
ChatActive¶
Controls whether the chat is active.
| Name | Type | Default | Description |
|---|---|---|---|
active |
boolean | (required) | Determines whether the chat should be made active. |
PointsNotificationsActive¶
Controls whether notifications for earned player points will appear.
| Name | Type | Default | Description |
|---|---|---|---|
active |
boolean | (required) | Determines whether notifications for earned player points will appear. |
BadgesNotificationsActive¶
Controls whether notifications for earned badges will appear.
| Name | Type | Default | Description |
|---|---|---|---|
active |
boolean | (required) | Determines whether notifications for earned badges will appear. |
ResetButtonCallback¶
Determines the behavior, if any, of the reset button given a boolean or a BindableEvent to be fired when a player requests to reset.
| Name | Type | Default | Description |
|---|---|---|---|
enabled |
boolean | (required) | Determines whether the reset button retains its default behavior. |
| OR | |||
callback |
Class.BindableEvent |
(required) | A Class.BindableEvent to be fired when the player confirms they want to reset. |
ChatMakeSystemMessage¶
Display a formatted message in the chat. Using this method requires the experience's TextChatService.ChatVersion to be set to LegacyChatService, although legacy chat is deprecated and usage is discouraged. For experiences using the current TextChatService, refer to TextChannel.DisplaySystemMessage().
| Name | Type | Default | Description |
|---|---|---|---|
configTable |
dictionary | (required) | A dictionary of information describing the message (see below). |
| Name | Type | Default | Description |
|---|---|---|---|
Text |
string | (required) | The message to display. |
Color |
Datatype.Color3 |
Datatype.Color3.fromRGB(255, 255, 243) |
Text color of the message. |
Font |
Enum.Font |
SourceSansBold |
Font of the message. |
TextSize |
integer | 18 |
Text size of the message. |
SendNotification¶
Causes a non-intrusive notification to appear at the bottom right of the screen. The notification may have up to two buttons.
| Name | Type | Default | Description |
|---|---|---|---|
configTable |
dictionary | (required) | A dictionary of information describing the notification (see below). |
| Name | Type | Default | Description |
|---|---|---|---|
Title |
string | (required) | The title of the notification. |
Text |
string | (required) | The main text of the notification. |
Icon |
string | The image to display with the notification. | |
Duration |
number | 5 |
Duration (in seconds) the notification should stay visible. |
Callback |
Class.BindableFunction |
A Class.BindableFunction that should be invoked with the text of the button pressed by the player. |
|
Button1 |
string | The text to display on the first button. | |
Button2 |
string | The text to display on the second button. |
TopbarEnabled¶
Determines whether the topbar is displayed. Disabling the topbar will also disable all CoreGuis such as the chat, inventory, and player list (for example, those set with SetCoreGuiEnabled).
When disabled, the region the topbar once occupied will still capture mouse events; however, buttons placed there will not respond to clicks. The origin of GUI space will still be offset 36 pixels from the top of the screen.
| Name | Type | Default | Description |
|---|---|---|---|
enabled |
boolean | (required) | Determines whether the topbar should be visible. |
DevConsoleVisible¶
Determines whether the Developer Console is visible.
| Name | Type | Default | Description |
|---|---|---|---|
visibility |
boolean | (required) | Determines whether the console is visible. |
PromptSendFriendRequest¶
Prompts the current player to send a friend request to the given Player.
| Name | Type | Default | Description |
|---|---|---|---|
player |
Class.Player |
(required) | The player to which the friend request should be sent. |
PromptUnfriend¶
Prompts the current player to remove a given Player from their friends list.
| Name | Type | Default | Description |
|---|---|---|---|
player |
Class.Player |
(required) | The player who should be unconnected. |
PromptBlockPlayer¶
Prompts the current player to block the given Player.
| Name | Type | Default | Description |
|---|---|---|---|
player |
Class.Player |
(required) | The player who should be blocked. |
PromptUnblockPlayer¶
Prompts the current player to unblock the given Player.
| Name | Type | Default | Description |
|---|---|---|---|
player |
Class.Player |
(required) | The player who should be unblocked. |
AvatarContextMenuEnabled¶
Determines whether the Avatar Context Menu is enabled.
| Name | Type | Default | Description |
|---|---|---|---|
enabled |
boolean | (required) | Determines whether the context menu is enabled. |
AvatarContextMenuTarget¶
Forcibly opens the Avatar Context Menu.
| Name | Type | Default | Description |
|---|---|---|---|
player |
Class.Player |
(required) | The player on whom the context menu will be opened. |
AddAvatarContextMenuOption¶
Adds an option to the Avatar Context Menu.
| Name | Type | Default | Description |
|---|---|---|---|
option |
Enum.AvatarContextMenuOption |
(required) | Option to add. |
| OR | |||
option |
table | (required) | A two-element table, where the first is the name of the custom action, and the second is a Class.BindableEvent which will be fired with a player was selected when the option was activated. |
RemoveAvatarContextMenuOption¶
Removes an option to the
Avatar Context Menu. The
option argument must be the same as what was used with
"AddAvatarContextMenuOption" (see above).
| Name | Type | Default | Description |
|---|---|---|---|
option |
Variant | (required) | The same value provided to AddAvatarContextMenuOption. |
AvatarContextMenuTheme¶
Configures the customizable Avatar Context Menu which is an opt-in feature that allows easy player-to-player social interaction via custom actions, such as initiating trades, battles, and more. For more info on how to customize its theme, see the Avatar Context Menu article.
CoreGuiChatConnections¶
Sets up a bindable gateway connection between the CoreGui topbar's chat button and the legacy chat system. The second parameter must be a table of BindableEvents and BindableFunctions.
SetCoreGuiEnabled Supported Function Sets whether the CoreGui element associated with the given CoreGuiType is enabled or disabled.
This function sets whether the CoreGui element associated with the given CoreGuiType is enabled or disabled.
The top bar cannot be disabled using this function. To disable it, set
"TopbarEnabled" to false using StarterGui.SetCore().
Roblox reference signature
Events¶
CoreGuiChangedSignal Supported Event
No description available.
RobloxScriptSecurityInherited members¶
Inherited from BasePlayerGui: 8 properties, 36 methods, 7 events. They are documented on the base class page.
1 modern Roblox member(s) are not implemented yet — expand to inspect
Members declared by Roblox's StarterGui class (or by a missing base class) that Nova does not expose. Use this list to scope a migration; the compatibility guide has the recommended workaround.
Properties¶
| Member | Signature | Status | Notes | Flags |
|---|---|---|---|---|
ScreenOrientation |
ScreenOrientation: ScreenOrientation |
Not yet | Sets the default screen orientation mode for users with mobile devices. | — |
Roblox reference: StarterGui
Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.