# PlayerGui

Roblox Engine API class from Roblox Studio 0.744.0.7441077 (version-7aaa6838d36c4448).

- Inherits from, nearest first: [BasePlayerGui](https://rapi.sleaze.dev/classes/BasePlayerGui.md), [Instance](https://rapi.sleaze.dev/classes/Instance.md), [Object](https://rapi.sleaze.dev/classes/Object.md)
- Tags: Not creatable, Player replicated
- Memory category: Instances
- HTML page: https://rapi.sleaze.dev/classes/PlayerGui/
- Roblox documentation: https://create.roblox.com/docs/reference/engine/classes/PlayerGui

A container that holds a player's UI.

## Properties

### SelectionImageObject

```luau
PlayerGui.SelectionImageObject: GuiObject
```

- Tags: Read capabilities: UI

Overrides the default selection adornment used for gamepads.

### CurrentScreenOrientation

```luau
PlayerGui.CurrentScreenOrientation: Enum.ScreenOrientation = Enum.ScreenOrientation.LandscapeLeft
```

- Tags: Read only, Read capabilities: UI

Describes the player's current screen orientation.

### InputBindingMappingsRaw

```luau
PlayerGui.InputBindingMappingsRaw: string = ""
```

- Tags: Hidden, Not scriptable, Roblox script security, Read capabilities: UI

### ScreenOrientation

```luau
PlayerGui.ScreenOrientation: Enum.ScreenOrientation = Enum.ScreenOrientation.LandscapeSensor
```

- Tags: Read capabilities: UI

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

## Methods

### GetTopbarTransparency

```luau
PlayerGui:GetTopbarTransparency(): number
```

- Tags: Deprecated, Capabilities: UI

**Deprecated:**

Returns the transparency of the Topbar.

Returns: The current topbar transparency, a number between 0 (completely opaque) and 1 (completely transparent).

### SetTopbarTransparency

```luau
PlayerGui:SetTopbarTransparency(transparency: number)
```

- Tags: Deprecated, Capabilities: UI

**Deprecated:**

Sets the transparency of the top bar.

Parameters:

- `transparency`: A number between 0 (completely opaque) and 1 (completely transparent). Values outside this range are clamped.

## Events

### TopbarTransparencyChangedSignal

```luau
PlayerGui.TopbarTransparencyChangedSignal: RBXScriptSignal<(transparency: number)>
```

- Tags: Deprecated, Capabilities: UI

**Deprecated:**

Fires when the transparency of the Topbar CoreGui changes.

## Inherited members

- From [BasePlayerGui](https://rapi.sleaze.dev/classes/BasePlayerGui.md): `GetGuiObjectsAtPosition`, `GetGuiObjectsInCircle`
- From [Instance](https://rapi.sleaze.dev/classes/Instance.md): `Archivable`, `archivable`, `Attributes`, `AttributesReplicate`, `AttributesSerialize`, `HistoryId`, `Name`, `Parent`, `PredictionMode`, `PropertyStatusStudio`, `RobloxLocked`, `SerializedOverrides`, `SourceAssetId`, `Tags`, `UniqueId`, `numExpectedDirectChildren`, `DataCost`, `Capabilities`, `DefinesCapabilities`, `IsInSandbox`, `Sandboxed`, `AddTag`, `ClearAllChildren`, `Clone`, `Destroy`, `FindFirstAncestor`, `FindFirstAncestorOfClass`, `FindFirstAncestorWhichIsA`, `FindFirstChild`, `FindFirstChildOfClass`, `FindFirstChildWhichIsA`, `FindFirstDescendant`, `GetActor`, `GetAttribute`, `GetAttributeChangedSignal`, `GetAttributes`, `GetChildren`, `GetDebugId`, `GetDescendants`, `GetFullName`, `GetStyled`, `GetStyledPropertyChangedSignal`, `GetTags`, `HasTag`, `IsAncestorOf`, `IsDescendantOf`, `IsPropertyModified`, `QueryDescendants`, `RemoveTag`, `ResetPropertyToDefault`, `SetAttribute`, `WaitForChild`, `Remove`, `children`, `clone`, `destroy`, `findFirstChild`, `getChildren`, `isDescendantOf`, `remove`, `AncestryChanged`, `AttributeChanged`, `ChildAdded`, `ChildRemoved`, `DescendantAdded`, `DescendantRemoving`, `Destroying`, `StyledPropertiesChanged`, `childAdded`
- From [Object](https://rapi.sleaze.dev/classes/Object.md): `ClassName`, `className`, `GetPropertyChangedSignal`, `IsA`, `isA`, `Changed`