PlayerGui

PlayerGui : Instance

Overview

PlayerGui is a client-only container that is automatically created when a player joins the game. It is located under the Player instance within the Players service and serves as the location for running client-side scripts.

When a player joins the game, all UI elements from the StarterGui service are copied into their PlayerGui once and only once.

The LocalScripts inside this container run on the client associated with that player.

Since UI elements are shown from PlayerGui, and not from StarterGui, you need to access PlayerGui, not StarterGui, to manage UI during gameplay as follows:

Properties

Methods

Events

Last updated