We use cookies on this site to enhance your user experience

PlayerGui

PlayerGui

The PlayerGui object is a container that holds a Player's user GUI. If a ScreenGui is a descendant of a PlayerGui, then any GuiObject inside of the ScreenGui will be drawn to the player’s screen. Any LocalScript will run as soon as it is inserted into a PlayerGui.


When a player first joins a game, their PlayerGui is automatically inserted into their Player object. When the player’s Player/Character spawns for the first time all of the contents of StarterGui are automatically copied into the player’s PlayerGui. Note that if Players/CharacterAutoLoads is set to false the character will not spawn and StarterGui contents will not be copied until Player/LoadCharacter is called. If StarterGui/ResetPlayerGuiOnSpawn is set to true then every time the player’s character respawns all of the contents of that player’s PlayerGui is cleared and replaced with the contents of StarterGui.

– Accessing PlayerGui from a LocalScript:
game:GetService(‘Players’).LocalPlayer:WaitForChild(‘PlayerGui’)

Properties

Name Type Description
ScreenOrientation

Describes the user’s current screen orientation.

ScreenOrientation

Sets the preferred screen orientation mode for this user, if the user is on a mobile device.

GuiObject

Overrides the default selection adornment (used for gamepads). For best results, this should point to a GuiObject.

Inherited from Instance , BasePlayerGui

Archivable ClassName DataCost Name Parent RobloxLocked

Events

Name Type Description

Fires when the transparency of the Topbar CoreGui changes.

Inherited from Instance , BasePlayerGui

AncestryChanged Changed ChildAdded ChildRemoved DescendantAdded DescendantRemoving