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

StarterGui

Deprecated

StarterGui

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

Determines whether LayerCollector|GUI objects parented to the StarterGui are visible in Studio’s edit mode

Inherited from Instance: Show Hide

int

DataCost

[ReadOnly] [NotReplicated]
The cost of saving the instance using data persistence.
Instance

Parent

Determines the hierarchical parent of the `Instance`.
bool

RobloxLocked

If true, the `Instance` and its descendants cannot be indexed or edited by a `Script` or `LocalScript` and will throw an error if it is attempted.
string

ClassName

[ReadOnly] [NotReplicated]
A read-only string representing the class this `Instance` belongs to.
string

Name

A non-unique identifier of the `Instance`.
bool

Archivable

Determines if an `Instance` can be cloned using `/Instance/Clone` or saved to file.

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 CoreScripts

void

SetCoreGuiEnabled ( CoreGuiType coreGuiType , bool enabled )

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

Inherited from Instance: Show Hide

Array

GetDescendants ( )

[CustomLuaState]
Returns an array containing all of the `Instance`'s descendants.
bool

IsAncestorOf ( Instance descendant )

Returns true if an `Instance` is an ancestor of the given descendant.
bool

IsDescendantOf ( Instance ancestor )

Returns true if an `Instance` is a descendant of the given ancestor.
Instance

FindFirstChildWhichIsA ( string className , bool recursive )

Returns the first child of the `Instance` for whom `Instance/IsA` returns true for the given className.
Instance

FindFirstChildOfClass ( string className )

Returns the first child of the `Instance` whose `Instance/ClassName|ClassName` is equal to the given className.
Instance

FindFirstChild ( string name , bool recursive )

Returns the first child of the `Instance` found with the given name.
Instance

FindFirstAncestorWhichIsA ( string className )

Returns the first ancestor of the `Instance` for whom `Instance/IsA` returns true for the given className.
Instance

FindFirstAncestorOfClass ( string className )

Returns the first ancestor of the `Instance` whose `Instance/ClassName` is equal to the given className.
Instance

FindFirstAncestor ( string name )

Returns the first ancestor of the `Instance` whose `Instance/Name` is equal to the given name.
bool

IsA ( string className )

Returns true if an `Instance`'s class matches or inherits from a given class
Instance

WaitForChild ( string childName , double timeOut )

[CustomLuaState] [CanYield]
Returns the child of the `Instance` with the given name. If the child does not exist, it will yield the current thread until it does.
RBXScriptSignal

GetPropertyChangedSignal ( string property )

Get an event that fires when a given property of an object changes.
string

GetFullName ( )

Returns a string showing the `Instance`'s ancestry.
string

GetDebugId ( int scopeLength )

[NotBrowsable]
Returns a coded string of the `Instance`s DebugId used internally by Roblox.
Objects

GetChildren ( )

Returns an array containing all of the `Instance`'s children.
void

Destroy ( )

Sets the `Instance/Parent` property to nil, locks the `Instance/Parent` property, disconnects all connections and calls Destroy on all children.
Instance

Clone ( )

Create a deep copy of a Roblox instance and descendants where `Archivable = true`.
void

ClearAllChildren ( )

This function destroys all of an `Instance`'s children.

Events

Inherited from Instance: Show Hide

RBXScriptSignal

AncestryChanged ( Instance child , Instance parent )

Fires when the `Instance/Parent` property of the object or one of its ancestors is changed.
RBXScriptSignal

ChildAdded ( Instance child )

Fires when an object is parented to this `Instance`.
RBXScriptSignal

ChildRemoved ( Instance child )

Fires when a child is removed from this `Instance`.
RBXScriptSignal

DescendantAdded ( Instance descendant )

Fires when a descendant is added to the `Instance`.
RBXScriptSignal

DescendantRemoving ( Instance descendant )

Fires immediately before a descendant of the `Instance` is removed.
RBXScriptSignal

Changed ( string property )

Fired immediately after a property of an object changes.