StarterGui

Allows StarterGui to process input like PlayerGui and CoreGui do. The default value is false.

This property sets the preferred screen orientation mode for users with mobile devices. For the different modes available, see Enum.ScreenOrientation.

By default, this property is set to Sensor, meaning the experience is displayed depending on the best match to the device's current orientation, either landscape (left/right) or portrait.

When a Player joins the experience on a mobile device, this property determines the device's starting orientation and sets that player's PlayerGui.ScreenOrientation accordingly. You can also get the player's current screen orientation through PlayerGui.CurrentScreenOrientation, useful when using one of the "sensor" Enum.ScreenOrientation settings.

Note that changing this property will not change the screen orientation for Players already in the experience. To change the orientation for an existing player, use their PlayerGui.ScreenOrientation property.

This property determines whether the contents of StarterGui is visible in Studio.

This function returns whether the given Enum.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.

Parameters

Returns

local StarterGui = game:GetService("StarterGui")

print(StarterGui:GetCoreGuiEnabled("PlayerList"))

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

PointsNotificationsActive

Controls whether notifications for earned player points will appear.

BadgesNotificationsActive

Controls 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.

ChatMakeSystemMessage

Display a formatted message in the chat.

SendNotification

Causes a non-intrusive notification to appear at the bottom right of the screen. The notification may have up to two buttons.

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.

DevConsoleVisible

Determines whether the Developer Console is visible.

PromptSendFriendRequest

Prompts the current player to send a friend request to the given Player.

PromptUnfriend

Prompts the current player to remove a given Player from their friends list.

PromptBlockPlayer

Prompts the current player to block the given Player.

PromptUnblockPlayer

Prompts the current player to unblock the given Player.

AvatarContextMenuEnabled

Determines whether the Avatar Context Menu is enabled.

AvatarContextMenuTarget

Forcibly opens the Avatar Context Menu.

AddAvatarContextMenuOption

Adds an option to the Avatar Context Menu.

RemoveAvatarContextMenuOption

Removes an option to the Avatar Context Menu. The option argument must be the same as what was used with "AddAvatarContextMenuOption" (see above).

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.

Parameters

Returns

local StarterGui = game:GetService("StarterGui")

StarterGui:SetCore("AvatarContextMenuTheme", {
	BackgroundImage = "",
	BackgroundTransparency = 0.5,
	BackgroundColor = Color3.fromRGB(111, 145, 242),
	NameTagColor = Color3.fromRGB(0, 0, 200),
	NameUnderlineColor = Color3.fromRGB(213, 233, 255),
	ButtonFrameColor = Color3.fromRGB(15, 24, 65),
	ButtonFrameTransparency = 0.2,
	ButtonUnderlineColor = Color3.fromRGB(213, 233, 255),
	Font = Enum.Font.SciFi,
})

This function sets whether the CoreGui element associated with the given Enum.CoreGuiType is enabled or disabled.

The top bar cannot be disabled using this function. To disable it, set "TopbarEnabled" to false using StarterGui:SetCore().

Parameters

Returns

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 friended by the local player.

PlayerUnfriendedEvent

Returns a BindableEvent that is fired whenever a player is unfriended 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.

Parameters

Returns