StarterGui

Show Deprecated
Not Creatable
Service

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

Methods

Methods inherited from BasePlayerGui

Methods

Properties

ProcessUserInput

Hidden
Not Replicated
Plugin Security
Read Parallel

RtlTextSupport

Not Scriptable
Read Parallel

ScreenOrientation

Read Parallel

ShowDevelopmentGui

Read Parallel

VirtualCursorMode

Not Scriptable
Read Parallel

Methods

GetCore

Variant
Yields

Parameters

parameterName: string

Returns

Variant

GetCoreGuiEnabled

Parameters

coreGuiType: Enum.CoreGuiType

Returns

Code Samples

Checking if a Core GUI is Enabled

local StarterGui = game:GetService("StarterGui")
print(StarterGui:GetCoreGuiEnabled("PlayerList"))

SetCore

()

Parameters

parameterName: string
value: Variant

Returns

()

Code Samples

StarterGui Setting Core GUI

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,
})

SetCoreGuiEnabled

()

Parameters

coreGuiType: Enum.CoreGuiType
enabled: boolean

Returns

()

Events