StarterGui
UI that every player gets a copy of when they join.
- Inherits: Service → Instance
- Creatable: No. It’s created with the game; use
StarterGui(import { StarterGui } from '@rally/sdk'). - Replication: Replicated: clients get a copy, and changes the server makes reach them.
When a player joins, the server copies everything in StarterGui (except objects whose
archivable is false) into their PlayerGui. Changing StarterGui
later doesn’t affect players who have already joined: change their PlayerGui instead.
LocalScripts inside ScreenGuis in StarterGui run on each player’s device once they’re copied into the PlayerGui. Rally Studio’s UI editor edits what’s in StarterGui.
Properties
Section titled “Properties”Inherited from Instance: name, archivable, id, className, parent, destroyed
Methods
Section titled “Methods”Inherited from Instance: getPropertyChangedSignal, setAttribute, getAttribute, getAttributes, getAttributeChangedSignal, getChildren, getDescendants, findFirstChild, findFirstChildOfClass, findFirstChildWhichIsA, findFirstAncestor, findFirstAncestorWhichIsA, waitForChild, isA, isDescendantOf, isAncestorOf, getFullName, clearAllChildren, destroy, clone, toString
Events
Section titled “Events”Inherited from Instance: changed, childAdded, childRemoved, descendantAdded, descendantRemoving, ancestryChanged, destroying, attributeChanged