> For the complete documentation index, see [llms.txt](https://docs.overdare.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.overdare.com/development/api-reference/classes/guibase2d.md).

# GuiBase2d

GuiBase2d : `Instance`

## Overview

This is an abstract class inherited by 2D GuiObjects

## Properties

### AbsolutePosition

`Vector2`

This property specifies the pixel-based screen position where a UI element is rendered.

This value reflects the final computed position, accounting for the positions and sizes of parent UI elements, and is always relative to the element’s top-left corner.

#### Code Samples

```lua
local ScreenGui = script.Parent
local TextLabel = ScreenGui.TextLabel

print("AbsolutePosition : ", TextLabel.AbsolutePosition)
```

### AbsoluteRotation

`number`

A read-only property that indicates the final rotation angle obtained by adding up the Rotation of the UI element and all of its ancestor UI elements.

If the parent Frame is rotated, this value reflects the parent's rotation even when the child element's Rotation is 0.

#### Code Samples

```lua
local ScreenGui = script.Parent
local TextLabel = ScreenGui:WaitForChild("TextLabel")

print("AbsoluteRotation : ", TextLabel.AbsoluteRotation)
```

### AbsoluteSize

`Vector2`

This property represents the pixel-based size of a UI element as rendered on the screen.

This value incorporates the parent’s size, AnchorPoint, and Scale settings, accurately reflecting the final on-screen size of the element.

#### Code Samples

```lua
local ScreenGui = script.Parent
local TextLabel = ScreenGui.TextLabel

print("AbsoluteSize : ", TextLabel.AbsoluteSize)
```

### AutoLocalize

`boolean`

Determines whether automatic localization (Auto Translation) is applied to this GuiBase2d and its descendants.\
If AutoLocalize is true, the object is also included in Automatic Text Collection (ATC).

The default value is true. If set to false, automatic translation is disabled for the object and its entire child hierarchy.

The inheritance rules are as follows:

* If a child's AutoLocalize is false, translation is not applied to that object.
* If a parent's AutoLocalize is false, translation is not applied regardless of the child’s value.
* If a child's AutoLocalize is true, it follows the parent’s AutoLocalize setting.

#### Code Samples

```lua
local ScreenGui = script.Parent
local TextLabel = ScreenGui:WaitForChild("TextLabel")

TextLabel.AutoLocalize = false
```

### ClippedRect

`Rect`

A read-only property that represents, as a rectangle in pixels, the area actually visible on screen after the clipping (ClipsDescendants) of ancestor UI elements is applied.

If there is no clipping ancestor, it has the same value as RawRect2D. If the element is completely outside the ancestor's area and no part of it is visible, it becomes a rectangle with a size of 0.

#### Code Samples

```lua
local ScreenGui = script.Parent
local Frame = ScreenGui:WaitForChild("Frame")
local TextLabel = Frame:WaitForChild("TextLabel")

print("ClippedRect : ", TextLabel.ClippedRect)
```

### IsNotOccluded

`boolean`

A read-only property that indicates whether the UI element is in a state where it can be displayed on screen.

It is true if Visible (or Enabled) of itself and all of its ancestors is true and ClippedRect is not empty. Since it does not determine whether the element is covered by other UI elements, it can be true even when the element is covered by an element in front of it.

#### Code Samples

```lua
local ScreenGui = script.Parent
local TextLabel = ScreenGui:WaitForChild("TextLabel")

print("IsNotOccluded : ", TextLabel.IsNotOccluded)
```

### RawRect2D

`Rect`

A read-only property that represents, as a rectangle in pixels, the area the UI element occupies on screen before clipping is applied.

Min is the same as AbsolutePosition, and Max is the same as the position of AbsolutePosition plus AbsoluteSize.

#### Code Samples

```lua
local ScreenGui = script.Parent
local TextLabel = ScreenGui:WaitForChild("TextLabel")

print("RawRect2D : ", TextLabel.RawRect2D)
```

### TotalGroupScale

`number`

A read-only property that indicates the cumulative scale obtained by multiplying all UIScale scales applied to ancestor UI elements.

It is 1 if there is no UIScale. For example, if a 0.85 scale is nested inside a 0.92 scale, it becomes 0.782.

#### Code Samples

```lua
local ScreenGui = script.Parent
local TextLabel = ScreenGui:WaitForChild("TextLabel")

print("TotalGroupScale : ", TextLabel.TotalGroupScale)
```

## Methods

## Events