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

StarterGui

Show 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]

Allows the StarterGui service to process input like PlayerGui and CoreGui do

bool

ResetPlayerGuiOnSpawn

[Deprecated]

Determines whether each child parented to the StarterGui will be cloned into a player’s PlayerGui when that player’s character is respawned.

ScreenOrientation

ScreenOrientation

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

bool

ShowDevelopmentGui

Inherited from Instance: Show Hide

bool

Archivable

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

string

ClassName

[ReadOnly] [NotReplicated]

A read-only string representing the class this Instance belongs to

int

DataCost

[ReadOnly] [NotReplicated] [Deprecated]

The cost of saving the instance using data persistence.

string

Name

A non-unique identifier of the Instance

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

bool

archivable

[Hidden] [NotReplicated] [Deprecated]
string

className

[ReadOnly] [NotReplicated] [Deprecated]

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

Inherited from BasePlayerGui: Show Hide

Objects

GetGuiObjectsAtPosition ( int x , int y )

Returns a list of visible GuiObject|GuiObjects occupying the given point on the screen

Inherited from Instance: Show Hide

void

ClearAllChildren ( )

This function destroys all of an Instance's children.

Instance

Clone ( )

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

void

Destroy ( )

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

Instance

FindFirstAncestor ( string name )

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

Instance

FindFirstAncestorOfClass ( string className )

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

Instance

FindFirstAncestorWhichIsA ( string className )

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

Instance

FindFirstChild ( string name , bool recursive )

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

Instance

FindFirstChildOfClass ( string className )

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

Instance

FindFirstChildWhichIsA ( string className , bool recursive )

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

Objects

GetChildren ( )

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

string

GetDebugId ( int scopeLength )

[NotBrowsable]

Returns a coded string of the Instances DebugId used internally by Roblox.

Array

GetDescendants ( )

[CustomLuaState]

Returns an array containing all of the descendants of the instance

string

GetFullName ( )

Returns a string describing the Instance's ancestry.

RBXScriptSignal

GetPropertyChangedSignal ( string property )

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

bool

IsA ( string className )

[CustomLuaState]

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

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.

void

Remove ( )

[Deprecated]

Sets the object’s Parent to nil, and does the same for all its descendants.

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.

Objects

children ( )

[Deprecated]

Returns an array of the object’s children.

Instance

clone ( )

[Deprecated]
void

destroy ( )

[Deprecated]
Instance

findFirstChild ( string name , bool recursive )

[Deprecated]
Objects

getChildren ( )

[Deprecated]
bool

isA ( string className )

[Deprecated] [CustomLuaState]
bool

isDescendantOf ( Instance ancestor )

[Deprecated]
void

remove ( )

[Deprecated]

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

Changed ( string property )

Fired immediately after a property of an object changes.

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

childAdded ( Instance child )

[Deprecated]