Control

public Reckfell.Collections.Array<EntityPath> AccessibilityControlsEntities { get; set; }

The paths to the nodes which are controlled by this node.

public Reckfell.Collections.Array<EntityPath> AccessibilityDescribedByEntities { get; set; }

The paths to the nodes which are describing this node.

public string AccessibilityDescription { get; set; }

The human-readable node description that is reported to assistive apps.

public Reckfell.Collections.Array<EntityPath> AccessibilityFlowToEntities { get; set; }

The paths to the nodes which this node flows into.

public Reckfell.Collections.Array<EntityPath> AccessibilityLabeledByEntities { get; set; }

The paths to the nodes which label this node.

public AccessibilityServer.AccessibilityLiveMode AccessibilityLive { get; set; }

The mode with which a live region updates. A live region is a Entity that is updated as a result of an external event when the user's focus may be elsewhere.

public string AccessibilityName { get; set; }

The human-readable node name that is reported to assistive apps.

public float AnchorBottom { get; set; }

Anchors the bottom edge of the node to the origin, the center, or the end of its parent control. It changes how the bottom offset updates when the node moves or changes size. You can use one of the Control.Anchor constants for convenience.

public float AnchorLeft { get; set; }

Anchors the left edge of the node to the origin, the center or the end of its parent control. It changes how the left offset updates when the node moves or changes size. You can use one of the Control.Anchor constants for convenience.

public float AnchorRight { get; set; }

Anchors the right edge of the node to the origin, the center or the end of its parent control. It changes how the right offset updates when the node moves or changes size. You can use one of the Control.Anchor constants for convenience.

public float AnchorTop { get; set; }

Anchors the top edge of the node to the origin, the center or the end of its parent control. It changes how the top offset updates when the node moves or changes size. You can use one of the Control.Anchor constants for convenience.

public bool AutoTranslate { get; set; }

Toggles if any text should automatically change to its translated version depending on the current locale.

public bool ClipContents { get; set; }

Enables whether rendering of CanvasItem based children should be clipped to this control's rectangle. If true, parts of a child which would be visibly outside of this control's rectangle will not be rendered and won't receive input.

public Vector2 CustomMaximumSize { get; set; }

An additional per-axis upper bound. A negative component normalizes to -1 and means no custom bound; zero is a bound, not unlimited. Do not set minimum above maximum.

public Vector2 CustomMinimumSize { get; set; }

An additional per-axis minimum, not the final size. Built-in text/theme/content requirements also participate; inspect GetCombinedMinimumSize(). Use _GetMinimumSize and UpdateMinimumSize for a dynamic custom requirement.

public Control.FocusBehaviorRecursiveEnum FocusBehaviorRecursive { get; set; }

Determines which controls can be focused together with Control.FocusMode. See Control.GetFocusModeWithOverride. Since the default behavior is Control.FocusBehaviorRecursiveEnum.Inherited, this can be used to prevent all children controls from getting focused.

public Control.FocusModeEnum FocusMode { get; set; }

Focus eligibility. All enables ordinary keyboard traversal; None excludes ordinary focus. Assign initial GrabFocus separately. Visibility and recursive parent rules also count; a button's Disabled does not replace None.

public EntityPath FocusNeighborBottom { get; set; }

Tells Reckfell which node it should give focus to if the user presses the down arrow on the keyboard or down on a gamepad by default. You can change the key by editing the ProjectSettings.input/ui_down input action. The node must be a Control. If this property is not set, Reckfell will give focus to the closest Control to the bottom of this one.

public EntityPath FocusNeighborLeft { get; set; }

Tells Reckfell which node it should give focus to if the user presses the left arrow on the keyboard or left on a gamepad by default. You can change the key by editing the ProjectSettings.input/ui_left input action. The node must be a Control. If this property is not set, Reckfell will give focus to the closest Control to the left of this one.

public EntityPath FocusNeighborRight { get; set; }

Tells Reckfell which node it should give focus to if the user presses the right arrow on the keyboard or right on a gamepad by default. You can change the key by editing the ProjectSettings.input/ui_right input action. The node must be a Control. If this property is not set, Reckfell will give focus to the closest Control to the right of this one.

public EntityPath FocusNeighborTop { get; set; }

Tells Reckfell which node it should give focus to if the user presses the top arrow on the keyboard or top on a gamepad by default. You can change the key by editing the ProjectSettings.input/ui_up input action. The node must be a Control. If this property is not set, Reckfell will give focus to the closest Control to the top of this one.

public EntityPath FocusNext { get; set; }

A path relative to this control to the next ordinary Tab target. Use GetPathTo(target) and maintain target existence/visibility when the tree changes. Arrow directions are configured separately through FocusNeighbor*.

public EntityPath FocusPrevious { get; set; }

Tells Reckfell which node it should give focus to if the user presses [kbd]Shift + Tab[/kbd] on a keyboard by default. You can change the key by editing the ProjectSettings.input/ui_focus_prev input action. If this property is not set, Reckfell will select a "best guess" based on surrounding nodes in the scene tree.

public Vector2 GlobalPosition { get; set; }

The node's global position, relative to the world (usually to the CanvasLayer).

public Control.GrowDirection GrowHorizontal { get; set; }

Controls the direction on the horizontal axis in which the control should grow or shrink if its horizontal size is changed.

public Control.GrowDirection GrowVertical { get; set; }

Controls the direction on the vertical axis in which the control should grow or shrink if its vertical size is changed.

public Control.LayoutDirectionEnum LayoutDirection { get; set; }

Controls layout direction and text writing direction. Right-to-left layouts are necessary for certain languages (e.g. Arabic and Hebrew). See also Control.IsLayoutRtl.

public bool LocalizeNumeralSystem { get; set; }

If true, automatically converts code line numbers, list indices, SpinBox and ProgressBar values from the Western Arabic (0..9) to the numeral systems used in current locale. Note: Numbers within the text are not automatically converted, it can be done manually, using TextServer.FormatNumber.

public Control.MouseBehaviorRecursiveEnum MouseBehaviorRecursive { get; set; }

Determines which controls can receive mouse input together with Control.MouseFilter. See Control.GetMouseFilterWithOverride. Since the default behavior is Control.MouseBehaviorRecursiveEnum.Inherited, this can be used to prevent all children controls from receiving mouse input.

public Control.CursorShape MouseDefaultCursorShape { get; set; }

The default cursor shape for this control. Useful for Reckfell plugins and applications or games that use the system's mouse cursors. Note: On Linux, shapes may vary depending on the cursor theme of the system.

public Control.MouseFilterEnum MouseFilter { get; set; }

Stop stops ordinary upward pointer propagation; Pass allows propagation to the parent and is not click-through to siblings; Ignore excludes the control from hit testing. Keyboard focus is configured separately.

public bool MouseForcePassScrollEvents { get; set; }

When enabled, scroll wheel events processed by Control.GuiInput will be passed to the parent control even if Control.MouseFilter is set to Control.MouseFilterEnum.Stop. You should disable it on the root of your UI if you do not want scroll events to go to the Entity._UnhandledInput processing. Note: Because this property defaults to true, this allows nested scrollable containers to work out of the box.

public float OffsetBottom { get; set; }

Distance between the node's bottom edge and its parent control, based on Control.AnchorBottom. Offsets are often controlled by one or multiple parent Container nodes, so you should not modify them manually if your node is a direct child of a Container. Offsets update automatically when you move or resize the node.

public float OffsetLeft { get; set; }

Distance between the node's left edge and its parent control, based on Control.AnchorLeft. Offsets are often controlled by one or multiple parent Container nodes, so you should not modify them manually if your node is a direct child of a Container. Offsets update automatically when you move or resize the node.

public float OffsetRight { get; set; }

Distance between the node's right edge and its parent control, based on Control.AnchorRight. Offsets are often controlled by one or multiple parent Container nodes, so you should not modify them manually if your node is a direct child of a Container. Offsets update automatically when you move or resize the node.

public float OffsetTop { get; set; }

Distance between the node's top edge and its parent control, based on Control.AnchorTop. Offsets are often controlled by one or multiple parent Container nodes, so you should not modify them manually if your node is a direct child of a Container. Offsets update automatically when you move or resize the node.

public bool OffsetTransformEnabled { get; set; }

If true, applies all offset transform properties. Otherwise, no offset transform is applied and the properties have no effect.

public Vector2 OffsetTransformPivot { get; set; }

Pivot used by Control.OffsetTransformRotation and Control.OffsetTransformScale in absolute units. The final pivot position is the combined value of this property and Control.OffsetTransformPivotRatio. Has no effect unless Control.OffsetTransformEnabled is true.

public Vector2 OffsetTransformPivotRatio { get; set; }

Same as Control.OffsetTransformPivot but expressed in units relative to the Control Control.Size where Vector2(0, 0) is the top-left corner of this control, and Vector2(1, 1) is its bottom-right corner. The final pivot position is the combined value of this property and Control.OffsetTransformPivot. Has no effect unless Control.OffsetTransformEnabled is true.

public Vector2 OffsetTransformPosition { get; set; }

Position offset in absolute units. The final offset is the combined value of this property and Control.OffsetTransformPositionRatio. Has no effect unless Control.OffsetTransformEnabled is true.

public Vector2 OffsetTransformPositionRatio { get; set; }

Same as Control.OffsetTransformPosition but expressed in units relative to the Control Control.Size where Vector2(0, 0) is the top-left corner of this control, and Vector2(1, 1) is its bottom-right corner. The final offset is the combined value of this property and Control.OffsetTransformPosition. Has no effect unless Control.OffsetTransformEnabled is true.

public float OffsetTransformRotation { get; set; }

Rotation offset. The rotation pivot is defined by Control.OffsetTransformPivot and Control.OffsetTransformPivotRatio. Has no effect unless Control.OffsetTransformEnabled is true.

public Vector2 OffsetTransformScale { get; set; }

Scale offset. The scale pivot is defined by Control.OffsetTransformPivot and Control.OffsetTransformPivotRatio. Has no effect unless Control.OffsetTransformEnabled is true.

public bool OffsetTransformVisualOnly { get; set; }

If true, the offset transforms is only applied visually and does not affect input. In other words, this Control will still receive input events at its original location before the offset transform is applied. If false, the entire transform of this Control is affected and input events will register where the Control is visually. Has no effect unless Control.OffsetTransformEnabled is true.

public Vector2 PivotOffset { get; set; }

By default, the node's pivot is its top-left corner. When you change its Control.Rotation or Control.Scale, it will rotate or scale around this pivot. The actual offset is the combined value of this property and Control.PivotOffsetRatio.

public Vector2 PivotOffsetRatio { get; set; }

Same as Control.PivotOffset, but expressed as uniform vector, where Vector2(0, 0) is the top-left corner of this control, and Vector2(1, 1) is its bottom-right corner. Set this property to Vector2(0.5, 0.5) to pivot around this control's center. The actual offset is the combined value of this property and Control.PivotOffset.

public Vector2 Position { get; set; }

The node's position, relative to its containing node. It corresponds to the rectangle's top-left corner. The property is not affected by Control.PivotOffset.

public bool PropagateMaximumSize { get; set; }

If true, this Control's children will use the value returned by Control.GetCombinedMaximumSize in their own size calculations.

public float Rotation { get; set; }

The node's rotation around its pivot, in radians. See Control.PivotOffset to change the pivot's position. Note: This property is edited in the inspector in degrees. If you want to use degrees in a script, use Control.RotationDegrees.

public float RotationDegrees { get; set; }

Helper property to access Control.Rotation in degrees instead of radians.

public Vector2 Scale { get; set; }

The node's scale, relative to its Control.Size. Change this property to scale the node around its Control.PivotOffset. The Control's tooltip will also scale according to this value. Note: This property is mainly intended to be used for animation purposes. To support multiple resolutions in your project, use an appropriate viewport stretch mode as described in the documentation instead of scaling Controls individually. Note: FontFile.Oversampling does not take Control Control.Scale into account. This means that scaling up/down will cause bitmap fonts and rasterized (non-MSDF) dynamic fonts to appear blurry or pixelated. To ensure text remains crisp regardless of scale, you can enable MSDF font rendering by enabling ProjectSettings.gui/theme/default_font_multichannel_signed_distance_field (applies to the default project font only), or enabling Multichannel Signed Distance Field in the import options of a DynamicFont for custom fonts. On system fonts, SystemFont.MultichannelSignedDistanceField can be enabled in the inspector. Note: If the Control node is a child of a Container node, the scale will be reset to Vector2(1, 1) when the scene is instantiated. To set the Control's scale when it's instantiated, wait for one frame using await get_tree().process_frame then set its Control.Scale property.

public Entity ShortcutContext { get; set; }

The Entity which must be a parent of the focused Control for the shortcut to be activated. If null, the shortcut can be activated when any control is focused (a global shortcut). This allows shortcuts to be accepted only when the user has a certain area of the GUI focused.

public Vector2 Size { get; set; }

Current rectangle dimensions in local logical coordinates. Assignment observes minimum/maximum. A direct Container child can be resized by sorting; separated anchors also recalculate edges when the parent changes.

public Control.SizeFlags SizeFlagsHorizontal { get; set; }

Horizontal placement flags in a supporting container. Fill fills the allocated share; Expand requests participation in space distribution; ExpandFill combines them. They do not replace anchors under a plain parent.

public float SizeFlagsStretchRatio { get; set; }

A relative stretch weight for containers that use it. Minima, maxima, gaps and other items' flags affect the result; weight 2 does not guarantee exactly twice the final width.

public Control.SizeFlags SizeFlagsVertical { get; set; }

Tells the parent Container nodes how they should resize and place the node on the Y axis. Use a combination of the Control.SizeFlags constants to change the flags. See the constants to learn what each does.

public Theme Theme { get; set; }

The Theme resource this node and all its Control and Window children use. If a child node has its own Theme resource set, theme items are merged with child's definitions having higher priority. Note: Window styles will have no effect unless the window is embedded.

public StringName ThemeTypeVariation { get; set; }

The name of a theme type variation used by this Control to look up its own theme items. When empty, the class name of the node is used (e.g. Button control), as well as the class names of all parent classes (in order of inheritance). When set, this property gives the highest priority to the type of the specified name. This type can in turn extend another type, forming a dependency chain. See Theme.SetTypeVariation. If the theme item cannot be found using this type or its base types, lookup falls back on the class names. Note: To look up Control's own items use various get_theme_* methods without specifying theme_type. Note: Theme items are looked for in the tree order, from branch to root, where each Control node is checked for its Control.Theme property. The earliest match against any type/class name is returned. The project-level Theme and the default Theme are checked last.

public Entity.AutoTranslateModeEnum TooltipAutoTranslateMode { get; set; }

Defines if tooltip text should automatically change to its translated version depending on the current locale. Uses the same auto translate mode as this control when set to Entity.AutoTranslateModeEnum.Inherit. Note: Tooltips customized using Control._MakeCustomTooltip do not use this auto translate mode automatically.

public string TooltipText { get; set; }

The default tooltip text. The tooltip appears when the user's mouse cursor stays idle over this control for a few moments, provided that the Control.MouseFilter property is not Control.MouseFilterEnum.Ignore. The time required for the tooltip to appear can be changed with the ProjectSettings.gui/timers/tooltip_delay_sec setting. This string is the default return value of Control.GetTooltip. Override Control.GetTooltip to generate tooltip text dynamically. Override Control._MakeCustomTooltip to customize the tooltip interface and behavior. The tooltip popup will use either a default implementation, or a custom one that you can provide by overriding Control._MakeCustomTooltip. The default tooltip includes a PopupPanel and Label whose theme properties can be customized using Theme methods with the "TooltipPanel" and "TooltipLabel" respectively. For example:

var styleBox = new StyleBoxFlat();
styleBox.SetBgColor(new Color(1, 1, 0));
styleBox.SetBorderWidthAll(2);
// We assume here that the `Theme` property has been assigned a custom Theme beforehand.
Theme.SetStyleBox("panel", "TooltipPanel", styleBox);
Theme.SetColor("font_color", "TooltipLabel", new Color(0, 1, 1));

public StringName TranslationContext { get; set; }

Context for automatic translation lookup on a Control. For Label, set it before Text: changing context alone does not recalculate the existing internal text. Send NotificationTranslationChanged after changing it when immediate lookup is needed.

public void AcceptEvent();

Marks the current GUI event handled in the viewport. Call from _GuiInput after handling it to prevent later GUI/_UnhandledInput delivery. This cannot undo an earlier _Input or direct polling of Input state.

public void AccessibilityDrag();

Starts drag-and-drop operation without using a mouse.

public void AccessibilityDrop();

Ends drag-and-drop operation without using a mouse.

public void AddThemeColorOverride(StringName name, Color color);

Creates a local override for a theme Color with the specified name. Local overrides always take precedence when fetching theme items for the control. An override can be removed with Control.RemoveThemeColorOverride. See also Control.GetThemeColor. Example: Override a Label's color and reset it later:

// Given the child Label node "MyLabel", override its font color with a custom value.
GetEntity<Label>("MyLabel").AddThemeColorOverride("font_color", new Color(1, 0.5f, 0));
// Reset the font color of the child label.
GetEntity<Label>("MyLabel").RemoveThemeColorOverride("font_color");
// Alternatively it can be overridden with the default value from the Label type.
GetEntity<Label>("MyLabel").AddThemeColorOverride("font_color", GetThemeColor("font_color", "Label"));

public void AddThemeConstantOverride(StringName name, int constant);

Creates a local override for a theme constant with the specified name. Local overrides always take precedence when fetching theme items for the control. An override can be removed with Control.RemoveThemeConstantOverride. See also Control.GetThemeConstant.

public void AddThemeFontOverride(StringName name, Font font);

Creates a local override for a theme Font with the specified name. Local overrides always take precedence when fetching theme items for the control. An override can be removed with Control.RemoveThemeFontOverride. See also Control.GetThemeFont.

public void AddThemeFontSizeOverride(StringName name, int fontSize);

Creates a local override for a theme font size with the specified name. Local overrides always take precedence when fetching theme items for the control. An override can be removed with Control.RemoveThemeFontSizeOverride. See also Control.GetThemeFontSize.

public void AddThemeIconOverride(StringName name, Texture2D texture);

Creates a local override for a theme icon with the specified name. Local overrides always take precedence when fetching theme items for the control. An override can be removed with Control.RemoveThemeIconOverride. See also Control.GetThemeIcon.

public void AddThemeSoundOverride(StringName name, AudioStream audio);

Creates a local override for a theme sound with the specified name. Local overrides always take precedence when fetching theme items for the control. An override can be removed with Control.RemoveThemeSoundOverride. See also Control.GetThemeSound.

public void AddThemeStyleboxOverride(StringName name, StyleBox stylebox);

Creates a local override for a theme StyleBox with the specified name. Local overrides always take precedence when fetching theme items for the control. An override can be removed with Control.RemoveThemeStyleboxOverride. See also Control.GetThemeStylebox. Example: Modify a property in a StyleBox by duplicating it:

// The snippet below assumes the child node "MyButton" has a StyleBoxFlat assigned.
// Resources are shared across instances, so we need to duplicate it
// to avoid modifying the appearance of all other buttons.
StyleBoxFlat newStyleboxNormal = GetEntity<Button>("MyButton").GetThemeStylebox("normal").Duplicate() as StyleBoxFlat;
newStyleboxNormal.BorderWidthTop = 3;
newStyleboxNormal.BorderColor = new Color(0, 1, 0.5f);
GetEntity<Button>("MyButton").AddThemeStyleboxOverride("normal", newStyleboxNormal);
// Remove the stylebox override.
GetEntity<Button>("MyButton").RemoveThemeStyleboxOverride("normal");

public void BeginBulkThemeOverride();

Prevents *_theme_*_override methods from emitting Control.NotificationThemeChanged until Control.EndBulkThemeOverride is called.

public void EndBulkThemeOverride();

Ends a bulk theme override update. See Control.BeginBulkThemeOverride.

public Control FindNextValidFocus();

Finds the next (below in the tree) Control that can receive the focus.

public Control FindPrevValidFocus();

Finds the previous (above in the tree) Control that can receive the focus.

public Control FindValidFocusNeighbor(Side side);

Finds the next Control that can receive the focus on the specified Side. Note: This is different from Control.GetFocusNeighbor, which returns the path of a specified focus neighbor.

public void ForceDrag(Variant data, Control preview);

Forces drag and bypasses Control._GetDragData and Control.SetDragPreview by passing data and preview. Drag will start even if the mouse is neither over nor pressed on this control. The methods Control._CanDropData and Control._DropData must be implemented on controls that want to receive drop data.

public float GetAnchor(Side side);

Returns the anchor for the specified Side. A getter method for Control.AnchorBottom, Control.AnchorLeft, Control.AnchorRight and Control.AnchorTop.

public Vector2 GetBegin();

Returns Control.OffsetLeft and Control.OffsetTop. See also Control.Position.

public Vector2 GetBoundMinimumSize();

Returns the bound value of Control.GetCombinedMinimumSize by Control.GetCombinedMaximumSize. This value is the true minimum size of the container, as the maximum size has priority over the minimum size. For example, if the combined minimum size is (100, 100) and the combined maximum size is (50, 150), the bound minimum size will be (50, 100).

public Vector2 GetCombinedMaximumSize();

Returns the combined maximum size from Control.CustomMaximumSize and Control.GetMaximumSize, as well as the Control.CustomMaximumSize of this node's parent if it is a Control node with Control.PropagateMaximumSize set to true.

public Vector2 GetCombinedMinimumSize();

Returns the combined minimum size from Control.CustomMinimumSize and Control.GetMinimumSize.

public Vector2 GetCombinedPivotOffset();

Returns the combined value of Control.PivotOffset and Control.PivotOffsetRatio, in pixels. The ratio is multiplied by the control's size.

public Control.CursorShape GetCursorShape(Vector2? atPosition = default);

Virtual method to be implemented by the user. Returns the cursor shape for the position at_position in the control's local coordinates, which will typically be used while hovering over this control. See Control.GetCursorShape. If not overridden, defaults to Control.MouseDefaultCursorShape.

public Vector2 GetEnd();

Returns Control.OffsetRight and Control.OffsetBottom.

public Control.FocusModeEnum GetFocusModeWithOverride();

Returns the Control.FocusMode, but takes the Control.FocusBehaviorRecursive into account. If Control.FocusBehaviorRecursive is set to Control.FocusBehaviorRecursiveEnum.Disabled, or it is set to Control.FocusBehaviorRecursiveEnum.Inherited and its ancestor is set to Control.FocusBehaviorRecursiveEnum.Disabled, then this returns Control.FocusModeEnum.None.

public EntityPath GetFocusNeighbor(Side side);

Returns the focus neighbor for the specified Side. A getter method for Control.FocusNeighborBottom, Control.FocusNeighborLeft, Control.FocusNeighborRight and Control.FocusNeighborTop. Note: To find the next Control on the specific Side, even if a neighbor is not assigned, use Control.FindValidFocusNeighbor.

public Rect2 GetGlobalRect();

Returns the position and size of the control relative to the containing canvas. See Control.GlobalPosition and Control.Size. Note: If the node itself or any parent CanvasItem between the node and the canvas have a non default rotation or skew, the resulting size is likely not meaningful. Note: Setting Viewport.GuiSnapControlsToPixels to true can lead to rounding inaccuracies between the displayed control and the returned Rect2.

public Vector2 GetMaximumSize();

Virtual method to be implemented by the user. Returns the maximum size for this control. Alternative to Control.CustomMaximumSize for controlling maximum size via code. The actual maximum size will be the max value of these two (in each axis separately). If not overridden, defaults to Vector2.Zero. Note: This method will not be called when the script is attached to a Control node that already overrides its maximum size (e.g. ScrollContainer). Note: It is recommended to use Control.GetBoundMinimumSize instead of Control.GetCombinedMinimumSize when implementing this method, as the former respects maximum size limits when calculating the minimum size, while the latter does not.

public Vector2 GetMinimumSize();

Virtual method to be implemented by the user. Returns the minimum size for this control. Alternative to Control.CustomMinimumSize for controlling minimum size via code. The actual minimum size will be the max value of these two (in each axis separately). If not overridden, defaults to Vector2.Zero. Note: This method will not be called when the script is attached to a Control node that already overrides its minimum size (e.g. Label, Button, PanelContainer etc.). It can only be used with most basic GUI nodes, like Control, Container, Panel etc.

public Control.MouseFilterEnum GetMouseFilterWithOverride();

Returns the Control.MouseFilter, but takes the Control.MouseBehaviorRecursive into account. If Control.MouseBehaviorRecursive is set to Control.MouseBehaviorRecursiveEnum.Disabled, or it is set to Control.MouseBehaviorRecursiveEnum.Inherited and its ancestor is set to Control.MouseBehaviorRecursiveEnum.Disabled, then this returns Control.MouseFilterEnum.Ignore.

public float GetOffset(Side offset);

Returns the offset for the specified Side. A getter method for Control.OffsetBottom, Control.OffsetLeft, Control.OffsetRight and Control.OffsetTop.

public Vector2 GetParentAreaSize();

Returns the width/height occupied in the parent control.

public Control GetParentControl();

Returns the parent control node.

public Rect2 GetRect();

Returns the position and size of the control in the coordinate system of the containing node. See Control.Position, Control.Scale and Control.Size. Note: If Control.Rotation is not the default rotation, the resulting size is not meaningful. Note: Setting Viewport.GuiSnapControlsToPixels to true can lead to rounding inaccuracies between the displayed control and the returned Rect2.

public Vector2 GetScreenPosition();

Returns the position of this Control in global screen coordinates (i.e. taking window position into account). Mostly useful for editor plugins. Equivalent to get_screen_transform().origin (see CanvasItem.GetScreenTransform). Example: Show a popup at the mouse position:

public Color GetThemeColor(StringName name, StringName themeType = null);

Returns a Color from the first matching Theme in the tree if that Theme has a color item with the specified name and theme_type. If theme_type is omitted the class name of the current control is used as the type, or Control.ThemeTypeVariation if it is defined. If the type is a class name its parent classes are also checked, in order of inheritance. If the type is a variation its base types are checked, in order of dependency, then the control's class name and its parent classes are checked. For the current control its local overrides are considered first (see Control.AddThemeColorOverride), then its assigned Control.Theme. After the current control, each parent control and its assigned Control.Theme are considered; controls without a Control.Theme assigned are skipped. If no matching Theme is found in the tree, the custom project Theme (see ProjectSettings.gui/theme/custom) and the default Theme are used (see ThemeDB).

public override void _Ready()
{
    // Get the font color defined for the current Control's class, if it exists.
    Modulate = GetThemeColor("font_color");
    // Get the font color defined for the Button class.
    Modulate = GetThemeColor("font_color", "Button");
}

public int GetThemeConstant(StringName name, StringName themeType = null);

Returns a constant from the first matching Theme in the tree if that Theme has a constant item with the specified name and theme_type. See Control.GetThemeColor for details.

public float GetThemeDefaultBaseScale();

Returns the default base scale value from the first matching Theme in the tree if that Theme has a valid Theme.DefaultBaseScale value. See Control.GetThemeColor for details.

public Font GetThemeDefaultFont();

Returns the default font from the first matching Theme in the tree if that Theme has a valid Theme.DefaultFont value. See Control.GetThemeColor for details.

public int GetThemeDefaultFontSize();

Returns the default font size value from the first matching Theme in the tree if that Theme has a valid Theme.DefaultFontSize value. See Control.GetThemeColor for details.

public Font GetThemeFont(StringName name, StringName themeType = null);

Returns a Font from the first matching Theme in the tree if that Theme has a font item with the specified name and theme_type. See Control.GetThemeColor for details.

public int GetThemeFontSize(StringName name, StringName themeType = null);

Returns a font size from the first matching Theme in the tree if that Theme has a font size item with the specified name and theme_type. See Control.GetThemeColor for details.

public Texture2D GetThemeIcon(StringName name, StringName themeType = null);

Returns an icon from the first matching Theme in the tree if that Theme has an icon item with the specified name and theme_type. See Control.GetThemeColor for details.

public AudioStream GetThemeSound(StringName name, StringName themeType = null);

Returns a sound from the first matching Theme in the tree if that Theme has a sound item with the specified name and theme_type. See Control.GetThemeColor for details.

public StyleBox GetThemeStylebox(StringName name, StringName themeType = null);

Returns a StyleBox from the first matching Theme in the tree if that Theme has a stylebox item with the specified name and theme_type. See Control.GetThemeColor for details.

public string GetTooltip(Vector2? atPosition = default);

Virtual method to be implemented by the user. Returns the tooltip text for the position at_position in the control's local coordinates, which will typically appear when the cursor is resting over this control. See Control.GetTooltip. Note: If this method returns an empty string and Control._MakeCustomTooltip is not overridden, no tooltip is displayed.

public void GrabClickFocus();

Creates an InputEventMouseButton that attempts to click the control. If the event is received, the control gains focus.

public override void _Process(double delta)
{
    GrabClickFocus(); // When clicking another Control node, this node will be clicked instead.
}

public void GrabFocus();

Assigns focus to this visible eligible control. Deferring initial selection until hierarchy readiness is useful. Hiding releases focus; assign it again when opening a screen. The hideFocus overload controls the indicator, not input availability.

public void GrabFocus(bool hideFocus = false);

Assigns focus to this visible eligible control. Deferring initial selection until hierarchy readiness is useful. Hiding releases focus; assign it again when opening a screen. The hideFocus overload controls the indicator, not input availability.

public bool HasFocus();

Returns true if this is the current focused control. See Control.FocusMode. If ignore_hidden_focus is true, controls that have their focus hidden will always return false. Hidden focus happens automatically when controls gain focus via mouse input, or manually using Control.GrabFocus with hide_focus set to true.

public bool HasFocus(bool ignoreHiddenFocus = false);

Returns true if this is the current focused control. See Control.FocusMode. If ignore_hidden_focus is true, controls that have their focus hidden will always return false. Hidden focus happens automatically when controls gain focus via mouse input, or manually using Control.GrabFocus with hide_focus set to true.

public bool HasThemeColor(StringName name, StringName themeType = null);

Returns true if there is a matching Theme in the tree that has a color item with the specified name and theme_type. See Control.GetThemeColor for details.

public bool HasThemeColorOverride(StringName name);

Returns true if there is a local override for a theme Color with the specified name in this Control node. See Control.AddThemeColorOverride.

public bool HasThemeConstant(StringName name, StringName themeType = null);

Returns true if there is a matching Theme in the tree that has a constant item with the specified name and theme_type. See Control.GetThemeColor for details.

public bool HasThemeConstantOverride(StringName name);

Returns true if there is a local override for a theme constant with the specified name in this Control node. See Control.AddThemeConstantOverride.

public bool HasThemeFont(StringName name, StringName themeType = null);

Returns true if there is a matching Theme in the tree that has a font item with the specified name and theme_type. See Control.GetThemeColor for details.

public bool HasThemeFontOverride(StringName name);

Returns true if there is a local override for a theme Font with the specified name in this Control node. See Control.AddThemeFontOverride.

public bool HasThemeFontSize(StringName name, StringName themeType = null);

Returns true if there is a matching Theme in the tree that has a font size item with the specified name and theme_type. See Control.GetThemeColor for details.

public bool HasThemeFontSizeOverride(StringName name);

Returns true if there is a local override for a theme font size with the specified name in this Control node. See Control.AddThemeFontSizeOverride.

public bool HasThemeIcon(StringName name, StringName themeType = null);

Returns true if there is a matching Theme in the tree that has an icon item with the specified name and theme_type. See Control.GetThemeColor for details.

public bool HasThemeIconOverride(StringName name);

Returns true if there is a local override for a theme icon with the specified name in this Control node. See Control.AddThemeIconOverride.

public bool HasThemeSound(StringName name, StringName themeType = null);

Returns true if there is a matching Theme in the tree that has a sound item with the specified name and theme_type. See Control.GetThemeColor for details.

public bool HasThemeSoundOverride(StringName name);

Returns true if there is a local override for a theme sound with the specified name in this Control node. See Control.AddThemeSoundOverride.

public bool HasThemeStylebox(StringName name, StringName themeType = null);

Returns true if there is a matching Theme in the tree that has a stylebox item with the specified name and theme_type. See Control.GetThemeColor for details.

public bool HasThemeStyleboxOverride(StringName name);

Returns true if there is a local override for a theme StyleBox with the specified name in this Control node. See Control.AddThemeStyleboxOverride.

public bool IsDragSuccessful();

Returns true if a drag operation is successful. Alternative to Viewport.GuiIsDragSuccessful. Best used with Entity.NotificationDragEnd.

public bool IsLayoutRtl();

Returns the effective Control layout direction using LayoutDirection and inheritance. Does not determine the direction of every text string or switch the game locale.

public void ReleaseFocus();

Give up the focus. No other control will be able to receive input.

public void RemoveThemeColorOverride(StringName name);

Removes a local override for a theme Color with the specified name previously added by Control.AddThemeColorOverride or via the Inspector dock.

public void RemoveThemeConstantOverride(StringName name);

Removes a local override for a theme constant with the specified name previously added by Control.AddThemeConstantOverride or via the Inspector dock.

public void RemoveThemeFontOverride(StringName name);

Removes a local override for a theme Font with the specified name previously added by Control.AddThemeFontOverride or via the Inspector dock.

public void RemoveThemeFontSizeOverride(StringName name);

Removes a local override for a theme font size with the specified name previously added by Control.AddThemeFontSizeOverride or via the Inspector dock.

public void RemoveThemeIconOverride(StringName name);

Removes a local override for a theme icon with the specified name previously added by Control.AddThemeIconOverride or via the Inspector dock.

public void RemoveThemeSoundOverride(StringName name);

Removes a local override for a theme sound with the specified name previously added by Control.AddThemeSoundOverride or via the Inspector dock.

public void RemoveThemeStyleboxOverride(StringName name);

Removes a local override for a theme StyleBox with the specified name previously added by Control.AddThemeStyleboxOverride or via the Inspector dock.

public void ResetSize();

Resets the size to Control.GetCombinedMinimumSize. This is equivalent to calling set_size(Vector2()) (or any size below the minimum).