# StarterGui

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, Service
- Memory category: Instances
- HTML page: https://rapi.sleaze.dev/classes/StarterGui/
- Roblox documentation: https://create.roblox.com/docs/reference/engine/classes/StarterGui

A container for [`LayerCollector`](https://rapi.sleaze.dev/classes/LayerCollector.md) objects to be copied into the [`PlayerGui`](https://rapi.sleaze.dev/classes/PlayerGui.md) of [`Players`](https://rapi.sleaze.dev/classes/Players.md). Also provides a range of functions for interacting with the [`CoreGui`](https://rapi.sleaze.dev/classes/CoreGui.md).

## Properties

### ClipsDescendantsSupportsRotation

```luau
StarterGui.ClipsDescendantsSupportsRotation: Enum.RolloutState
```

- Tags: Not scriptable, Capabilities: UI

Determines whether the `ClipsDescendants` property of a [`GuiObject`](https://rapi.sleaze.dev/classes/GuiObject.md) clips **rotated** descendants.

### ProcessUserInput

```luau
StarterGui.ProcessUserInput: boolean
```

- Tags: Hidden, Not replicated, Plugin security, Read capabilities: UI

Allows this service to process input like [`PlayerGui`](https://rapi.sleaze.dev/classes/PlayerGui.md) and [`CoreGui`](https://rapi.sleaze.dev/classes/CoreGui.md) do.

### RtlTextSupport

```luau
StarterGui.RtlTextSupport: Enum.RtlTextSupport
```

- Tags: Not scriptable, Read capabilities: UI

Controls whether right-to-left (RTL) text layout is enabled for text in `GuiObjects` throughout the experience.

### VirtualCursorMode

```luau
StarterGui.VirtualCursorMode: Enum.VirtualCursorMode
```

- Tags: Not scriptable, Read capabilities: UI

Controls whether the gamepad virtual cursor is enabled for navigating `GuiObjects` with a controller.

### ScreenOrientation

```luau
StarterGui.ScreenOrientation: Enum.ScreenOrientation
```

- Tags: Read capabilities: UI

Sets the default screen orientation mode for users with mobile devices.

### ShowDevelopmentGui

```luau
StarterGui.ShowDevelopmentGui: boolean
```

- Tags: Read capabilities: UI

Determines whether the contents of [`StarterGui`](https://rapi.sleaze.dev/classes/StarterGui.md) is visible in Studio.

### StudioDefaultStyleSheet

```luau
StarterGui.StudioDefaultStyleSheet: StyleSheet
```

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

### StudioInsertWidgetLayerCollectorAutoLinkStyleSheet

```luau
StarterGui.StudioInsertWidgetLayerCollectorAutoLinkStyleSheet: StyleSheet
```

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

### ResetPlayerGuiOnSpawn

```luau
StarterGui.ResetPlayerGuiOnSpawn: boolean
```

- Tags: Deprecated, Read capabilities: UI

**Deprecated:** This property is deprecated. Use [`LayerCollector.ResetOnSpawn`](https://rapi.sleaze.dev/classes/LayerCollector.md) to control the resetting behavior for individual [`LayerCollector`](https://rapi.sleaze.dev/classes/LayerCollector.md) objects.

Determines whether each child parented to the StarterGui will be cloned into a player's PlayerGui when that player's character is respawned.

## Methods

### GetCore

```luau
StarterGui:GetCore(parameterName: string): any
```

- Tags: Yields, Capabilities: UI

Returns a variable that has been specified by a Roblox core script.

Parameters:

- `parameterName`: The name of the core parameter to retrieve, such as `"PointsNotificationsActive"` or `"ChatActive"`.

Returns: The value associated with the specified core parameter name, whose type depends on the parameter queried.

### GetCoreGuiEnabled

```luau
StarterGui:GetCoreGuiEnabled(coreGuiType: Enum.CoreGuiType): boolean
```

- Tags: Capabilities: UI

Returns whether the given `CoreGuiType`is enabled, or if it has been disabled using [`StarterGui:SetCoreGuiEnabled()`](https://rapi.sleaze.dev/classes/StarterGui.md).

Parameters:

- `coreGuiType`: The given `CoreGuiType`.

Returns: Whether the given `CoreGuiType` is enabled.

### RegisterGetCore

```luau
StarterGui:RegisterGetCore(parameterName: string, getFunction: (...any) -> ...any)
```

- Tags: Roblox script security, Capabilities: UI

### RegisterSetCore

```luau
StarterGui:RegisterSetCore(parameterName: string, setFunction: (...any) -> ...any)
```

- Tags: Roblox script security, Capabilities: UI

### SetCore

```luau
StarterGui:SetCore(parameterName: string, value: any)
```

- Tags: Capabilities: UI

Allows you to perform certain interactions with Roblox's core scripts.

Parameters:

- `parameterName`: Selects the functionality with which the call will interact.
- `value`: A table of `BindableEvents` and `BindableFunctions`.

### SetCoreGuiEnabled

```luau
StarterGui:SetCoreGuiEnabled(coreGuiType: Enum.CoreGuiType, enabled: boolean)
```

- Tags: Capabilities: UI

Sets whether the [`CoreGui`](https://rapi.sleaze.dev/classes/CoreGui.md) element associated with the given `CoreGuiType` is enabled or disabled.

Parameters:

- `coreGuiType`: The given `CoreGuiType`.
- `enabled`: Whether to enable or disable the given `CoreGuiType`.

## Events

### CoreGuiChangedSignal

```luau
StarterGui.CoreGuiChangedSignal: RBXScriptSignal<(coreGuiType: Enum.CoreGuiType, enabled: boolean)>
```

- Tags: Roblox script security, Capabilities: UI

## 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`