Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.
PlayerGui
Inherits from: BasePlayerGui → Instance → Object
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:
Inherits from: BasePlayerGui
Memory category: Instances
Tags: NotCreatable, PlayerReplicated
Code samples: View on Creator Hub (PlayerGui-Overview).
Properties
| Name | Type / Returns | Description |
|---|---|---|
| PlayerGui.CurrentScreenOrientation | ScreenOrientation | Describes the player's current screen orientation. |
| PlayerGui.ScreenOrientation | ScreenOrientation | Sets the preferred screen orientation mode for this player, if on a mobile device. |
| PlayerGui.SelectionImageObject | GuiObject | Overrides the default selection adornment used for gamepads. |
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance.Archivable | boolean | Determines if an Instance and its descendants can be cloned using Instance:Clone(), and can be saved/published. |
| Instance.archivable | boolean | |
| Instance.Capabilities | SecurityCapabilities | The set of capabilities allowed to be used for scripts inside this container. |
| Instance.IsInSandbox | boolean | Indicates whether the instance is inside a sandboxed container. |
| Instance.Name | string | A non-unique identifier of the Instance. |
| Instance.Parent | Instance | Determines the hierarchical parent of the Instance. |
| Instance.PredictionMode | PredictionMode | Reflects the client-side prediction mode applied to the instance under server-authoritative physics. |
| Instance.RobloxLocked | boolean | A deprecated property that used to protect CoreGui objects. |
| Instance.Sandboxed | boolean | When enabled, the instance can only access abilities in its Capabilities list. |
| Instance.UniqueId | UniqueId | A unique identifier for the instance. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object.ClassName | string | A read-only string representing the class this Object belongs to. |
| Object.className | string |
PlayerGui.CurrentScreenOrientation
Describes the player's current screen orientation as an ScreenOrientation value. Unlike the writable PlayerGui.ScreenOrientation property, which requests a preferred orientation mode, PlayerGui.CurrentScreenOrientation is read-only and reports the orientation the device is actually displaying, updating as the player physically rotates a mobile device.
| Field | Value |
|---|---|
| type | ScreenOrientation |
| tags | ["ReadOnly","NotReplicated"] |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Data |
| serialization | {"can_load":false,"can_save":false} |
| capabilities | ["UI"] |
PlayerGui.ScreenOrientation
Sets the preferred screen orientation mode for this player when on a mobile device, expressed as an ScreenOrientation value. Changing it requests that the device lock to, or follow, a particular orientation (for example Portrait or LandscapeSensor). The orientation the device is actually displaying is reported separately by the read-only PlayerGui.CurrentScreenOrientation property. This property defaults to LandscapeSensor.
| Field | Value |
|---|---|
| type | ScreenOrientation |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Data |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["UI"] |
PlayerGui.SelectionImageObject
Overrides the default selection adornment used for gamepads. For best results, this should point to a GuiObject.
| Field | Value |
|---|---|
| type | GuiObject |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Appearance |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["UI"] |
Methods
| Name | Type / Returns | Description |
|---|---|---|
| PlayerGui:GetTopbarTransparency | float | Returns the transparency of the Topbar. |
| PlayerGui:SetTopbarTransparency | () | Sets the transparency of the top bar. |
Inherited from BasePlayerGui
| Name | Type / Returns | Description |
|---|---|---|
| BasePlayerGui:GetGuiObjectsAtPosition | Instances | Returns a list of all GuiObject instances occupying the given |
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance:AddTag | () | Applies a tag to the instance. |
| Instance:children | Instances | Returns an array of the object's children. |
| Instance:ClearAllChildren | () | This method destroys all of an instance's children. |
| Instance:Clone | Instance | Create a copy of an instance and all its descendants, ignoring instances that are not Archivable. |
| Instance:clone | Instance | |
| Instance:Destroy | () | Sets the Instance.Parent property to nil, locks the Instance.Parent property, disconnects all connections, and calls Destroy() on all children. |
| Instance:destroy | () | |
| Instance:FindFirstAncestor | Instance? | Returns the first ancestor of the Instance whose Instance.Name is equal to the given name. |
| Instance:FindFirstAncestorOfClass | Instance? | Returns the first ancestor of the Instance whose Object.ClassName is equal to the given className. |
| Instance:FindFirstAncestorWhichIsA | Instance? | Returns the first ancestor of the Instance for whom Object:IsA() returns true for the given className. |
| Instance:FindFirstChild | Instance? | Returns the first child of the Instance found with the given name. |
| Instance:findFirstChild | Instance | |
| Instance:FindFirstChildOfClass | Instance? | Returns the first child of the Instance whose ClassName is equal to the given class name. |
| Instance:FindFirstChildWhichIsA | Instance? | Returns the first child of the Instance for whom Object:IsA() returns true for the given className. |
| Instance:FindFirstDescendant | Instance? | Returns the first descendant found with the given Instance.Name. |
| Instance:GetActor | Actor? | Returns the Actor associated with the Instance, if any. |
| Instance:GetAttribute | Variant | Returns the value which has been assigned to the given attribute name. |
| Instance:GetAttributeChangedSignal | RBXScriptSignal | Returns an event that fires when the given attribute changes. |
| Instance:GetAttributes | Dictionary | Returns a dictionary of the instance's attributes. |
| Instance:GetChildren | Instances | Returns an array containing all of the instance's children. |
| Instance:getChildren | Instances | |
| Instance:GetDebugId | string | Returns a coded string of the debug ID used internally by Roblox. |
| Instance:GetDescendants | Instances | Returns an array containing all of the descendants of the instance. |
| Instance:GetFullName | string | Returns a string describing the instance's ancestry. |
| Instance:GetStyled | Variant | Returns the styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified. |
| Instance:GetStyledPropertyChangedSignal | RBXScriptSignal | Returns an event that fires when the given style property changes on the instance. |
| Instance:GetTags | Array | Gets an array of all tags applied to the instance. |
| Instance:HasTag | boolean | Check whether the instance has a given tag. |
| Instance:IsAncestorOf | boolean | Returns true if an Instance is an ancestor of the given descendant. |
| Instance:IsDescendantOf | boolean | Returns true if an Instance is a descendant of the given ancestor. |
| Instance:isDescendantOf | boolean | |
| Instance:IsPropertyModified | boolean | Returns true if the value stored in the specified property is not equal to the code-instantiated default. |
| Instance:QueryDescendants | Instances | Returns an array containing all descendants of the instance that match the selector string. |
| Instance:Remove | () | Sets the object's Parent to nil, and does the same for all its descendants. |
| Instance:remove | () | |
| Instance:RemoveTag | () | Removes a tag from the instance. |
| Instance:ResetPropertyToDefault | () | Resets a property to its default value. |
| Instance:SetAttribute | () | Sets the attribute with the given name to the given value. |
| Instance:WaitForChild | Instance | 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. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object:GetPropertyChangedSignal | RBXScriptSignal | Get an event that fires when a given property of the object changes. |
| Object:IsA | boolean | Returns true if an object's class matches or inherits from a given class. |
| Object:isA | boolean |
PlayerGui:GetTopbarTransparency
Deprecated.
Returns the current transparency of the topbar CoreGui, a value in the range [0, 1] where 0 is completely opaque and 1 is completely transparent. This is the value previously assigned with PlayerGui:SetTopbarTransparency(), and it defaults to 0.5. This method can only be called from a LocalScript; calling it from a server script raises an error.
Returns
| Type | Description |
|---|---|
| float | The current topbar transparency, a number between 0 (completely opaque) and 1 (completely transparent). |
| Field | Value |
|---|---|
| tags | ["Deprecated"] |
| security | None |
| thread safety | Unsafe |
| capabilities | ["UI"] |
Code samples: View on Creator Hub (PlayerGui-GetTopbarTransparency1).
PlayerGui:SetTopbarTransparency
Deprecated.
This method sets the transparency of the top bar CoreGui. A value of 0 is completely opaque and a value of 1 is completely transparent. Values outside of the range [0, 1] are clamped. The default transparency of the topbar is 0.5.
Using the StarterGui:SetCore() method with the "TopbarEnabled" option allows you to enable/disable the entire topbar and all of its features (player list, health, etc). By contrast, this method only affects how the top bar is displayed.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| transparency | float | A number between 0 (completely opaque) and 1 (completely transparent). Values outside this range are clamped. |
Returns
| Type | Description |
|---|---|
| () |
| Field | Value |
|---|---|
| tags | ["Deprecated"] |
| security | None |
| thread safety | Unsafe |
| capabilities | ["UI"] |
Code samples: View on Creator Hub (PlayerGui-SetTopbarTransparency1, custom-topbar-style).
Events
| Name | Type / Returns | Description |
|---|---|---|
| PlayerGui.TopbarTransparencyChangedSignal | Fires when the transparency of the Topbar CoreGui changes. |
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance.AncestryChanged | Fires when the Instance.Parent property of this object or one of its ancestors is changed. | |
| Instance.AttributeChanged | Fires whenever an attribute is changed on the Instance. | |
| Instance.ChildAdded | Fires after an object is parented to this Instance. | |
| Instance.childAdded | ||
| Instance.ChildRemoved | Fires after a child is removed from this Instance. | |
| Instance.DescendantAdded | Fires after a descendant is added to the Instance. | |
| Instance.DescendantRemoving | Fires immediately before a descendant of the Instance is removed. | |
| Instance.Destroying | Fires immediately before (or is deferred until after) the instance is destroyed via Instance:Destroy(). | |
| Instance.StyledPropertiesChanged | Fires whenever any style property is changed on the instance, including when a property is set to nil. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object.Changed | Fires immediately after a property of the object changes, with some limitations. |
PlayerGui.TopbarTransparencyChangedSignal
Deprecated.
Fires whenever the transparency of the topbar CoreGui changes, such as after a call to PlayerGui:SetTopbarTransparency(). The event passes the new transparency as its transparency argument, a value in the range [0, 1]. It only fires when the clamped transparency differs from the previous value, so setting the same value again does not re-fire it.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| transparency | float | The new topbar transparency after the change, a number between 0 (completely opaque) and 1 (completely transparent). |
| Field | Value |
|---|---|
| tags | ["Deprecated"] |
| security | None |
| capabilities | ["UI"] |
Code samples: View on Creator Hub (PlayerGui-TopbarTransparencyChangedSignal1).