A container that holds a player's UI.

The PlayerGui container stores objects that create the player's GUI. If a ScreenGui is a descendant of PlayerGui, any GuiObject inside that ScreenGui displays on the player's screen. Any LocalScript will also run if it is inserted into a PlayerGui.

When a player first joins the experience, 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. If StarterGui.ResetPlayerGuiOnSpawn is set to true, all the contents of a player's PlayerGui are cleared and replaced with the contents of StarterGui every time the player's character respawns.

Note that if Players.CharacterAutoLoads is set to false, the character won't spawn and StarterGui contents won't copy over until Player:LoadCharacterAsync() is called.

If you need to control a player's UI container during playtime, for example to show/hide a specific ScreenGui or any of its children, access it as follows from a LocalScript:

1
2
3
4

local Players = game:GetService("Players")

local player = Players.LocalPlayer
local playerGui = player.PlayerGui