StarterGui

Show Deprecated
Not Creatable
Service

Summary

Methods

Methods inherited from BasePlayerGui

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

GetCoreGuiEnabled

Parameters

coreGuiType: Enum.CoreGuiType
Default Value: ""

Returns

Code Samples

Checking if a Core GUI is Enabled

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

SetCore

()

Parameters

parameterName: string
Default Value: ""
value: Variant
Default Value: ""

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
Default Value: ""
enabled: boolean
Default Value: ""

Returns

()

GetCore

Variant
Yields

Parameters

parameterName: string
Default Value: ""

Returns

Variant

Events