Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.
GuiBase2d
Inherits from: GuiBase → Instance → Object
GuiBase2d is an abstract class inherited by 2D GuiObjects.
Inherits from: GuiBase
Descendants: GuiObject, LayerCollector
Memory category: Instances
Tags: NotCreatable, NotBrowsable
Properties
| Name | Type / Returns | Description |
|---|---|---|
| GuiBase2d.AbsolutePosition | Vector2 | Describes the actual screen position of a GuiBase2d element, in pixels. |
| GuiBase2d.AbsoluteRotation | float | Describes the actual screen rotation of a GuiBase2d element, in degrees. |
| GuiBase2d.AbsoluteSize | Vector2 | Describes the actual screen size of a GuiBase2d element, in pixels. |
| GuiBase2d.AutoLocalize | boolean | When set to true, localization will be applied to this GuiBase2d and its descendants. |
| GuiBase2d.Localize | boolean | Automatically set to true when a localization table's LocalizationTable.Root targets this object, or an ancestor of this object. |
| GuiBase2d.RootLocalizationTable | LocalizationTable | A reference to a LocalizationTable to be used to apply automated localization to this GuiBase2d and its descendants. |
| GuiBase2d.SelectionBehaviorDown | SelectionBehavior | Customizes gamepad selection behavior in the down direction. |
| GuiBase2d.SelectionBehaviorLeft | SelectionBehavior | Customizes gamepad selection behavior in the left direction. |
| GuiBase2d.SelectionBehaviorRight | SelectionBehavior | Customizes gamepad selection behavior in the right direction. |
| GuiBase2d.SelectionBehaviorUp | SelectionBehavior | Customizes gamepad selection behavior in the up direction. |
| GuiBase2d.SelectionGroup | boolean | Allows customization of gamepad selection movement. |
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 |
GuiBase2d.AbsolutePosition
AbsolutePosition is a read-only property that provides the screen position of a GuiBase2d element in pixels. This represents the actual pixel position at which an element renders as a result of its ancestors' sizes and positions. Note that AbsolutePosition always represents the top-left corner of the GuiBase2d element.
If the GuiBase2d is in a ScreenGui, the AbsolutePosition property uses the CoreUISafeInsets viewport coordinate system. The origin of this coordinate system is located at the bottom-left corner of the Roblox top bar. Note that this is the same coordinate system used by the InputObject.Position property.
See also AbsoluteRotation and AbsoluteSize.
| Field | Value |
|---|---|
| type | Vector2 |
| tags | ["ReadOnly","NotReplicated"] |
| security | {"read":"None","write":"None"} |
| thread safety | Unsafe |
| category | Data |
| serialization | {"can_load":false,"can_save":false} |
| capabilities | ["UI"] |
GuiBase2d.AbsoluteRotation
AbsoluteRotation is a read-only property that describes the actual screen rotation of a GuiBase2d element, in degrees. It does not perform bounds checking, so its value may not be in the range 0 to 360.
See also AbsolutePosition and AbsoluteSize.
| Field | Value |
|---|---|
| type | float |
| tags | ["ReadOnly","NotReplicated"] |
| security | {"read":"None","write":"None"} |
| thread safety | Unsafe |
| category | Data |
| serialization | {"can_load":false,"can_save":false} |
| capabilities | ["UI"] |
GuiBase2d.AbsoluteSize
AbsoluteSize is a read-only property that describes the actual screen size of a GuiBase2d element, in pixels.
See also AbsolutePosition and AbsoluteRotation.
| Field | Value |
|---|---|
| type | Vector2 |
| tags | ["ReadOnly","NotReplicated"] |
| security | {"read":"None","write":"None"} |
| thread safety | Unsafe |
| category | Data |
| serialization | {"can_load":false,"can_save":false} |
| capabilities | ["UI"] |
GuiBase2d.AutoLocalize
When set to true, localization will be applied to this GuiBase2d and its descendants. The entries used for localization are the same set of entries returned by LocalizationService:GetTableEntries(). Entries with AutoLocalize enabled are automatically re-translated after the cloud table loads if necessary.
See also RootLocalizationTable.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Localization |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["UI"] |
GuiBase2d.Localize
Deprecated. This item is deprecated. Do not use it for new work.
This property is automatically set to true when a localization table's LocalizationTable.Root targets this object, or an ancestor of this object. LocalizationTables with their LocalizationTable.Root property pointed at an instance will localize all TextLabel.TextButton that are descendants of the root instance.
| Field | Value |
|---|---|
| type | boolean |
| tags | ["Hidden","NotReplicated","Deprecated"] |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Localization |
| serialization | {"can_load":true,"can_save":false} |
| capabilities | ["UI"] |
GuiBase2d.RootLocalizationTable
A reference to a LocalizationTable to be used to apply automated localization to this GuiBase2d and its descendants. AutoLocalize must be set to true on the GuiBase2d and its ancestors for automated localization to be applied.
You can set this to reference a LocalizationTable anywhere in the DataModel. The GuiBase2d object and all of its children will try to use that specific LocalizationTable and its ancestors for automatic text replacement before using the tables under LocalizationService in an undefined order and the cloud table.
If there is no translation available in the referenced table, it will look for a translation in the parent of that table, if it is also a LocalizationTable, and so on.
See also LocalizationService:GetTableEntries() which explains how the RootLocalizationTable is used for automated localization.
| Field | Value |
|---|---|
| type | LocalizationTable |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Localization |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["UI"] |
GuiBase2d.SelectionBehaviorDown
SelectionBehaviorDown customizes how gamepad selection moves in the down direction out of a selection group. It only has an effect when SelectionGroup is true; SelectionGroup is false by default, and while it remains false this property has no effect.
Its default value is SelectionBehavior.Escape, which prioritizes buttons within the selection group but allows the selection to move to a GuiObject outside the group in the down direction if no suitable button is found inside. Setting it to SelectionBehavior.Stop instead constrains the selection to the group, preventing it from moving downward out of the group.
See also SelectionGroup.
| Field | Value |
|---|---|
| type | SelectionBehavior |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Selection |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["UI"] |
GuiBase2d.SelectionBehaviorLeft
SelectionBehaviorLeft customizes how gamepad selection moves in the left direction out of a selection group. It only has an effect when SelectionGroup is true; SelectionGroup is false by default, and while it remains false this property has no effect.
Its default value is SelectionBehavior.Escape, which prioritizes buttons within the selection group but allows the selection to move to a GuiObject outside the group in the left direction if no suitable button is found inside. Setting it to SelectionBehavior.Stop instead constrains the selection to the group, preventing it from moving leftward out of the group.
See also SelectionGroup.
| Field | Value |
|---|---|
| type | SelectionBehavior |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Selection |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["UI"] |
GuiBase2d.SelectionBehaviorRight
SelectionBehaviorRight customizes how gamepad selection moves in the right direction out of a selection group. It only has an effect when SelectionGroup is true; SelectionGroup is false by default, and while it remains false this property has no effect.
Its default value is SelectionBehavior.Escape, which prioritizes buttons within the selection group but allows the selection to move to a GuiObject outside the group in the right direction if no suitable button is found inside. Setting it to SelectionBehavior.Stop instead constrains the selection to the group, preventing it from moving rightward out of the group.
See also SelectionGroup.
| Field | Value |
|---|---|
| type | SelectionBehavior |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Selection |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["UI"] |
GuiBase2d.SelectionBehaviorUp
SelectionBehaviorUp customizes how gamepad selection moves in the up direction out of a selection group. It only has an effect when SelectionGroup is true; SelectionGroup is false by default, and while it remains false this property has no effect.
Its default value is SelectionBehavior.Escape, which prioritizes buttons within the selection group but allows the selection to move to a GuiObject outside the group in the up direction if no suitable button is found inside. Setting it to SelectionBehavior.Stop instead constrains the selection to the group, preventing it from moving upward out of the group.
See also SelectionGroup.
| Field | Value |
|---|---|
| type | SelectionBehavior |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Selection |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["UI"] |
GuiBase2d.SelectionGroup
Allows for customization of how gamepad selection can move between buttons, which are descendants of the selection group, leave the group, and select other buttons.
Setting SelectionGroup to true exposes the SelectionBehaviorUp, SelectionBehaviorDown, SelectionBehaviorLeft, and SelectionBehaviorRight properties. For these selection behaviors, a setting of SelectionBehavior.Escape (default) means the gamepad selection tries to first find a selection within the selection group and only moves outside if it does not find a suitable button. Alternatively, a setting of SelectionBehavior.Stop means gamepad selection only looks within the selection group and does not move outside of the group from the selection behavior direction.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Selection |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["UI"] |
Events
| Name | Type / Returns | Description |
|---|---|---|
| GuiBase2d.SelectionChanged | Fires when the gamepad selection moves to, leaves, or changes within the connected GuiBase2d or any descendant GuiObjects. |
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. |
GuiBase2d.SelectionChanged
This event fires when the gamepad selection moves to, leaves, or changes within the connected GuiBase2d or any descendant GuiObjects. When the selection highlight moves to a GuiObject, the event bubbles from that GuiObject to all of its ancestors, informing them that the selection has changed/entered/exited to a GuiObject in their descendant tree.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| amISelected | boolean | True if the new selection matches the attached GuiBase2d. | |
| previousSelection | GuiObject | The GuiObject that was previously selected before the selection changed, or nil if nothing was selected. | |
| newSelection | GuiObject | The GuiObject that is now selected after the selection changed, or nil if nothing is selected. |
| Field | Value |
|---|---|
| security | None |
| capabilities | ["UI"] |
Methods
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 |