We use cookies on this site to enhance your user experience

StarterGui

StarterGui

The StarterGui object is a service object that holds GUIs and LocalScript. Children of this object get cloned into a Player’s PlayerGui when their character spawns. If StarterGui/ResetPlayerGuiOnSpawn is false then the children will only be copied to PlayerGui the first time the player’s character spawns.


Properties

Name Type Description
bool
ScreenOrientation

Sets the preferred screen orientation mode on mobile devices.

bool

Whether or not GUI objects are visible in Studio’s edit mode. This property has no effect in online mode.

Inherited from Instance , BasePlayerGui

Archivable ClassName DataCost Name Parent RobloxLocked

Functions

Name Type Description
Variant

Returns a variable that has been specified by a Roblox CoreScript.

bool

Returns whether or not the given CoreGui is enabled.

void

Allows you to perform certain interactions with Roblox’s CoreScripts.

void

Allows for certain CoreGui elements to be disabled/enabled.

Inherited from Instance , BasePlayerGui

ClearAllChildren Clone Destroy FindFirstAncestor FindFirstAncestorOfClass FindFirstAncestorWhichIsA FindFirstChild FindFirstChildOfClass FindFirstChildWhichIsA GetChildren GetDebugId GetDescendants GetFullName GetPropertyChangedSignal IsA IsAncestorOf IsDescendantOf WaitForChild