PcoWSkbVqDnWTu_dm2ix
We use cookies on this site to enhance your user experience
Collapse Sidebar

StarterGui

Show deprecated

StarterGui

Show deprecated

The StarterGui service is a container object designed to hold LayerCollector|GUI objects such as ScreenGui|ScreenGuis.

StarterGui as a container

When a Player|Players’ Player/Character|character respawns, the contents of their PlayerGui is emptied. Children of the StarterGui are then copied (along with their descendants) into the StarterGui.

LayerCollector|GUI objects such as ScreenGui|ScreenGuis with their LayerCollector/ResetOnSpawn|ResetOnSpawn property set to false will only be placed into each Player|Player’s PlayerGui once and will not be deleted when the Player respawns.

StarterGui as an interface

The 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. StarterGui/SetCore can perform a range of functions including creating notifications and system messages.

Properties

bool

ProcessUserInput

[Hidden] [NotReplicated]
ScreenOrientation

ScreenOrientation

Sets the default Enum/ScreenOrientation|screen orientation mode for users with mobile devices

bool

ShowDevelopmentGui

Functions

Variant

GetCore ( string parameterName )

[Yields]

Returns a variable that has been specified by a Roblox CoreScript

bool

GetCoreGuiEnabled ( CoreGuiType coreGuiType )

Returns whether the given Enum/CoreGuiTypeis enabled or if it has been disabled using StarterGui/SetCoreGuiEnabled

void

SetCore ( string parameterName , Variant value )

Allows you to perform certain interactions with Roblox’s CoreScript|CoreScripts

void

SetCoreGuiEnabled ( CoreGuiType coreGuiType , bool enabled )

Sets whether the CoreGui element associated with the given Enum/CoreGuiType is enabled or disabled

Events