GuiBase2d¶
An abstract class inherited by 2D GuiObjects.
Description¶
GuiBase2d is an abstract class inherited by 2D GuiObjects.
Inheritance¶
Object → Instance → GuiBase → GuiBase2d
Nova inheritance: Instance → GuiBase → GuiBase2d
Known subclasses: GuiObject, LayerCollector
Properties¶
AbsolutePosition Supported Property Describes the actual screen position of a GuiBase2d element, in pixels.
Describes the actual screen position of a GuiBase2d element, in pixels.
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.
AbsoluteSize Supported Property Describes the actual screen size of a GuiBase2d element, in pixels.
AbsoluteSize is a read-only property that describes the actual screen size of a GuiBase2d element, in pixels.
See also AbsolutePosition and AbsoluteRotation.
AutoLocalize Supported Property When set to true, localization will be applied to this GuiBase2d and its descendants.
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.
RootLocalizationTable Supported Property A reference to a LocalizationTable to be used to apply automated localization to this GuiBase2d and its descendants.
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.
SelectionBehaviorDown Supported Property Legacy gamepad-selection preference. Stored, but Nova's selection code does not read it.
Legacy gamepad-selection preference. Stored, but Nova's selection code does not read it.
Nova stores and replicates the enum. The current 2016 GUI selection code does not consume these per-axis selection-behavior properties.
SelectionBehaviorLeft Supported Property Legacy gamepad-selection preference. Stored, but Nova's selection code does not read it.
Legacy gamepad-selection preference. Stored, but Nova's selection code does not read it.
Nova stores and replicates the enum. The current GUI selection code does not consume it.
SelectionBehaviorRight Supported Property Legacy gamepad-selection preference. Stored, but Nova's selection code does not read it.
Legacy gamepad-selection preference. Stored, but Nova's selection code does not read it.
Nova stores and replicates the enum. The current GUI selection code does not consume it.
SelectionBehaviorUp Supported Property Legacy gamepad-selection preference. Stored, but Nova's selection code does not read it.
Legacy gamepad-selection preference. Stored, but Nova's selection code does not read it.
Nova stores and replicates the enum. The current GUI selection code does not consume it.
SelectionGroup Supported Property Allows customization of gamepad selection movement.
Allows customization of gamepad selection movement.
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.
Inherited members¶
Inherited from GuiBase: 8 properties, 36 methods, 7 events. They are documented on the base class page.
2 modern Roblox member(s) are not implemented yet — expand to inspect
Members declared by Roblox's GuiBase2d class (or by a missing base class) that Nova does not expose. Use this list to scope a migration; the compatibility guide has the recommended workaround.
Properties¶
| Member | Signature | Status | Notes | Flags |
|---|---|---|---|---|
AbsoluteRotation |
AbsoluteRotation: float |
Not yet | Describes the actual screen rotation of a GuiBase2d element, in degrees. | ReadOnly, NotReplicated |
Events¶
| Member | Signature | Status | Notes | Flags |
|---|---|---|---|---|
SelectionChanged |
SelectionChanged(amISelected: bool, previousSelection: GuiObject, newSelection: GuiObject) |
Not yet | Fires when the gamepad selection moves to, leaves, or changes within the connected GuiBase2d or any descendant GuiObjects. | — |
Roblox reference: GuiBase2d
Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.