StarterGui
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.
Summary
Properties
Allows this service to process input like PlayerGui and CoreGui do.
Sets the default screen orientation mode for users with mobile devices.
Determines whether the contents of StarterGui is visible in Studio.
Methods
Returns a variable that has been specified by a Roblox core script.
Returns whether the given Enum.CoreGuiTypeis enabled, or if it has been disabled using StarterGui:SetCoreGuiEnabled().
Allows you to perform certain interactions with Roblox's core scripts.
Sets whether the CoreGui element associated with the given Enum.CoreGuiType is enabled or disabled.
Methods
Returns a list of all GuiObject instances occupying the given point on the screen.
Properties
ProcessUserInput
RtlTextSupport
ScreenOrientation
ShowDevelopmentGui
VirtualCursorMode
Methods
GetCoreGuiEnabled
Parameters
Returns
Code Samples
local StarterGui = game:GetService("StarterGui")
print(StarterGui:GetCoreGuiEnabled("PlayerList"))
SetCore
Parameters
Returns
Code Samples
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,
})