# BasePlayerGui

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

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

[`BasePlayerGui`](https://rapi.sleaze.dev/classes/BasePlayerGui.md) is an abstract class which the GUI drawing storage classes inherit from.

## Methods

### GetGuiObjectsAtPosition

```luau
BasePlayerGui:GetGuiObjectsAtPosition(x: number, y: number): { Instance }
```

- Tags: Capabilities: UI

Returns a list of all [`GuiObject`](https://rapi.sleaze.dev/classes/GuiObject.md) instances occupying the given

Parameters:

- `x`: The **X** position on the screen relative to the top-left corner after the GUI inset is applied (see [`GuiService:GetGuiInset()`](https://rapi.sleaze.dev/classes/GuiService.md)).
- `y`: The **Y** position on the screen relative to the top-left corner after the GUI inset is applied (see [`GuiService:GetGuiInset()`](https://rapi.sleaze.dev/classes/GuiService.md)).

Returns: A table of the [`GuiObject`](https://rapi.sleaze.dev/classes/GuiObject.md) instances that occupy the given screen space.

### GetGuiObjectsInCircle

```luau
BasePlayerGui:GetGuiObjectsInCircle(position: Vector2, radius: number): { Instance }
```

- Tags: Roblox script security, Capabilities: UI

## Inherited members

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