class-description NEWS COMMUNITY STORE TUTORIALS SIGN UP LOGIN LOGOUT ROKOJORI NEWSLETTER SIGN UP LOGIN LOGOUT NEWS COMMUNITY STORE TUTORIALS TOGGLE FULLSCREEN VOLLBILD AN/AUS ObjectNodeCanvasItem Control
Base class for all GUI controls. Adapts its position and size based on its parent control.
 Base class for all UI-related nodes. Control features a bounding rectangle that defines its extents, an anchor position relative to its parent control or the current viewport, and offsets relative to the anchor. The offsets update automatically when the node, any of its parents, or the screen size change.
For more information on Godot's UI system, anchors, offsets, and containers, see the related tutorials in the manual. To build flexible UIs, you'll need a mix of UI elements that inherit from Control and Container nodes.
Note: Since both Node2D and Control inherit from CanvasItem, they share several concepts from the class such as the [member CanvasItem.z_index] and [member CanvasItem.visible] properties.
User Interface nodes and input
Godot propagates input events via viewports. Each Viewport is responsible for propagating InputEvents to their child nodes. As the [member SceneTree.root] is a Window, this already happens automatically for all UI elements in your game.
Input events are propagated through the SceneTree from the root node to all child nodes by calling [method Node._input]. For UI elements specifically, it makes more sense to override the virtual method _gui_input, which filters out unrelated input events, such as by checking z-order, mouse_filter, focus, or if the event was inside of the control's bounding box.
Call accept_event so no other node receives the event. Once you accept an input, it becomes handled so [method Node._unhandled_input] will not process it.
Only one Control node can be in focus. Only the node in focus will receive events. To get the focus, call grab_focus. Control nodes lose focus when another node grabs it, or if you hide the node in focus. Focus will not be represented visually if gained via mouse/touch input, only appearing with keyboard/gamepad input (for accessibility), or via grab_focus.
Sets mouse_filter to MOUSE_FILTER_IGNORE to tell a Control node to ignore mouse or touch events. You'll need it if you place an icon on top of a button.
Theme resources change the control's appearance. The theme of a Control node affects all of its direct and indirect children (as long as a chain of controls is uninterrupted). To override some of the theme items, call one of the add_theme_*_override methods, like add_theme_font_override. You can also override theme items in the Inspector.
Note: Theme items are not Object properties. This means you can't access their values using [method Object.get] and [method Object.set]. Instead, use the get_theme_* and add_theme_*_override methods provided by this class.
 Enum FocusMode<>():Enum

FOCUS_NONE:null = 0
The node cannot grab focus. Use with focus_mode.


FOCUS_CLICK:null = 1
The node can only grab focus on mouse clicks. Use with focus_mode.


FOCUS_ALL:null = 2
The node can grab focus on mouse click, using the arrows and the Tab keys on the keyboard, or using the D-pad buttons on a gamepad. Use with focus_mode.


FOCUS_ACCESSIBILITY:null = 3
The node can grab focus only when screen reader is active. Use with focus_mode.
 Enum FocusBehaviorRecursive<>():Enum

FOCUS_BEHAVIOR_INHERITED:null = 0
Inherits the focus_behavior_recursive from the parent control. If there is no parent control, this is the same as FOCUS_BEHAVIOR_ENABLED.


FOCUS_BEHAVIOR_DISABLED:null = 1
Prevents the control from getting focused. get_focus_mode_with_override will return FOCUS_NONE.


FOCUS_BEHAVIOR_ENABLED:null = 2
Allows the control to be focused, depending on the focus_mode. This can be used to ignore the parent's focus_behavior_recursive. get_focus_mode_with_override will return the focus_mode.
 Enum MouseBehaviorRecursive<>():Enum

MOUSE_BEHAVIOR_INHERITED:null = 0
Inherits the mouse_behavior_recursive from the parent control. If there is no parent control, this is the same as MOUSE_BEHAVIOR_ENABLED.


MOUSE_BEHAVIOR_DISABLED:null = 1
Prevents the control from receiving mouse input. get_mouse_filter_with_override will return MOUSE_FILTER_IGNORE.


MOUSE_BEHAVIOR_ENABLED:null = 2
Allows the control to be receive mouse input, depending on the mouse_filter. This can be used to ignore the parent's mouse_behavior_recursive. get_mouse_filter_with_override will return the mouse_filter.
 * Constants<>():*

NOTIFICATION_RESIZED:null = 40
Sent when the node changes size. Use size to get the new size.


NOTIFICATION_MOUSE_ENTER:null = 41
Sent when the mouse cursor enters the control's (or any child control's) visible area, that is not occluded behind other Controls or Windows, provided its mouse_filter lets the event reach it and regardless if it's currently focused or not.
Note: [member CanvasItem.z_index] doesn't affect which Control receives the notification.
See also NOTIFICATION_MOUSE_ENTER_SELF.


NOTIFICATION_MOUSE_EXIT:null = 42
Sent when the mouse cursor leaves the control's (and all child control's) visible area, that is not occluded behind other Controls or Windows, provided its mouse_filter lets the event reach it and regardless if it's currently focused or not.
Note: [member CanvasItem.z_index] doesn't affect which Control receives the notification.
See also NOTIFICATION_MOUSE_EXIT_SELF.


NOTIFICATION_MOUSE_ENTER_SELF:null = 60
Sent when the mouse cursor enters the control's visible area, that is not occluded behind other Controls or Windows, provided its mouse_filter lets the event reach it and regardless if it's currently focused or not.
Note: [member CanvasItem.z_index] doesn't affect which Control receives the notification.
See also NOTIFICATION_MOUSE_ENTER.


NOTIFICATION_MOUSE_EXIT_SELF:null = 61
Sent when the mouse cursor leaves the control's visible area, that is not occluded behind other Controls or Windows, provided its mouse_filter lets the event reach it and regardless if it's currently focused or not.
Note: [member CanvasItem.z_index] doesn't affect which Control receives the notification.
See also NOTIFICATION_MOUSE_EXIT.


NOTIFICATION_FOCUS_ENTER:null = 43
Sent when the node grabs focus.


NOTIFICATION_FOCUS_EXIT:null = 44
Sent when the node loses focus.


NOTIFICATION_THEME_CHANGED:null = 45
Sent when the node needs to refresh its theme items. This happens in one of the following cases:
- The theme property is changed on this node or any of its ancestors.
- The theme_type_variation property is changed on this node.
- One of the node's theme property overrides is changed.
- The node enters the scene tree.
Note: As an optimization, this notification won't be sent from changes that occur while this node is outside of the scene tree. Instead, all of the theme item updates can be applied at once when the node enters the scene tree.
Note: This notification is received alongside [constant Node.NOTIFICATION_ENTER_TREE], so if you are instantiating a scene, the child nodes will not be initialized yet. You can use it to setup theming for this node, child nodes created from script, or if you want to access child nodes added in the editor, make sure the node is ready using [method Node.is_node_ready].
func _notification(what): if what == NOTIFICATION_THEME_CHANGED: if not is_node_ready(): await ready # Wait until ready signal. $Label.add_theme_color_override("font_color", Color.YELLOW)


NOTIFICATION_SCROLL_BEGIN:null = 47
Sent when this node is inside a ScrollContainer which has begun being scrolled when dragging the scrollable area with a touch event. This notification is not sent when scrolling by dragging the scrollbar, scrolling with the mouse wheel or scrolling with keyboard/gamepad events.
Note: This signal is only emitted on Android or iOS, or on desktop/web platforms when [member ProjectSettings.input_devices/pointing/emulate_touch_from_mouse] is enabled.


NOTIFICATION_SCROLL_END:null = 48
Sent when this node is inside a ScrollContainer which has stopped being scrolled when dragging the scrollable area with a touch event. This notification is not sent when scrolling by dragging the scrollbar, scrolling with the mouse wheel or scrolling with keyboard/gamepad events.
Note: This signal is only emitted on Android or iOS, or on desktop/web platforms when [member ProjectSettings.input_devices/pointing/emulate_touch_from_mouse] is enabled.


NOTIFICATION_LAYOUT_DIRECTION_CHANGED:null = 49
Sent when the control layout direction is changed from LTR or RTL or vice versa. This notification is propagated to child Control nodes as result of a change to layout_direction.
 Enum CursorShape<>():Enum

CURSOR_ARROW:null = 0
Show the system's arrow mouse cursor when the user hovers the node. Use with mouse_default_cursor_shape.


CURSOR_IBEAM:null = 1
Show the system's I-beam mouse cursor when the user hovers the node. The I-beam pointer has a shape similar to "I". It tells the user they can highlight or insert text.


CURSOR_POINTING_HAND:null = 2
Show the system's pointing hand mouse cursor when the user hovers the node.


CURSOR_CROSS:null = 3
Show the system's cross mouse cursor when the user hovers the node.


CURSOR_WAIT:null = 4
Show the system's wait mouse cursor when the user hovers the node. Often an hourglass.


CURSOR_BUSY:null = 5
Show the system's busy mouse cursor when the user hovers the node. Often an arrow with a small hourglass.


CURSOR_DRAG:null = 6
Show the system's drag mouse cursor, often a closed fist or a cross symbol, when the user hovers the node. It tells the user they're currently dragging an item, like a node in the Scene dock.


CURSOR_CAN_DROP:null = 7
Show the system's drop mouse cursor when the user hovers the node. It can be an open hand. It tells the user they can drop an item they're currently grabbing, like a node in the Scene dock.


CURSOR_FORBIDDEN:null = 8
Show the system's forbidden mouse cursor when the user hovers the node. Often a crossed circle.


CURSOR_VSIZE:null = 9
Show the system's vertical resize mouse cursor when the user hovers the node. A double-headed vertical arrow. It tells the user they can resize the window or the panel vertically.


CURSOR_HSIZE:null = 10
Show the system's horizontal resize mouse cursor when the user hovers the node. A double-headed horizontal arrow. It tells the user they can resize the window or the panel horizontally.


CURSOR_BDIAGSIZE:null = 11
Show the system's window resize mouse cursor when the user hovers the node. The cursor is a double-headed arrow that goes from the bottom left to the top right. It tells the user they can resize the window or the panel both horizontally and vertically.


CURSOR_FDIAGSIZE:null = 12
Show the system's window resize mouse cursor when the user hovers the node. The cursor is a double-headed arrow that goes from the top left to the bottom right, the opposite of CURSOR_BDIAGSIZE. It tells the user they can resize the window or the panel both horizontally and vertically.


CURSOR_MOVE:null = 13
Show the system's move mouse cursor when the user hovers the node. It shows 2 double-headed arrows at a 90 degree angle. It tells the user they can move a UI element freely.


CURSOR_VSPLIT:null = 14
Show the system's vertical split mouse cursor when the user hovers the node. On Windows, it's the same as CURSOR_VSIZE.


CURSOR_HSPLIT:null = 15
Show the system's horizontal split mouse cursor when the user hovers the node. On Windows, it's the same as CURSOR_HSIZE.


CURSOR_HELP:null = 16
Show the system's help mouse cursor when the user hovers the node, a question mark.
 Enum LayoutPreset<>():Enum

PRESET_TOP_LEFT:null = 0
Snap all 4 anchors to the top-left of the parent control's bounds. Use with set_anchors_preset.


PRESET_TOP_RIGHT:null = 1
Snap all 4 anchors to the top-right of the parent control's bounds. Use with set_anchors_preset.


PRESET_BOTTOM_LEFT:null = 2
Snap all 4 anchors to the bottom-left of the parent control's bounds. Use with set_anchors_preset.


PRESET_BOTTOM_RIGHT:null = 3
Snap all 4 anchors to the bottom-right of the parent control's bounds. Use with set_anchors_preset.


PRESET_CENTER_LEFT:null = 4
Snap all 4 anchors to the center of the left edge of the parent control's bounds. Use with set_anchors_preset.


PRESET_CENTER_TOP:null = 5
Snap all 4 anchors to the center of the top edge of the parent control's bounds. Use with set_anchors_preset.


PRESET_CENTER_RIGHT:null = 6
Snap all 4 anchors to the center of the right edge of the parent control's bounds. Use with set_anchors_preset.


PRESET_CENTER_BOTTOM:null = 7
Snap all 4 anchors to the center of the bottom edge of the parent control's bounds. Use with set_anchors_preset.


PRESET_CENTER:null = 8
Snap all 4 anchors to the center of the parent control's bounds. Use with set_anchors_preset.


PRESET_LEFT_WIDE:null = 9
Snap all 4 anchors to the left edge of the parent control. The left offset becomes relative to the left edge and the top offset relative to the top left corner of the node's parent. Use with set_anchors_preset.


PRESET_TOP_WIDE:null = 10
Snap all 4 anchors to the top edge of the parent control. The left offset becomes relative to the top left corner, the top offset relative to the top edge, and the right offset relative to the top right corner of the node's parent. Use with set_anchors_preset.


PRESET_RIGHT_WIDE:null = 11
Snap all 4 anchors to the right edge of the parent control. The right offset becomes relative to the right edge and the top offset relative to the top right corner of the node's parent. Use with set_anchors_preset.


PRESET_BOTTOM_WIDE:null = 12
Snap all 4 anchors to the bottom edge of the parent control. The left offset becomes relative to the bottom left corner, the bottom offset relative to the bottom edge, and the right offset relative to the bottom right corner of the node's parent. Use with set_anchors_preset.


PRESET_VCENTER_WIDE:null = 13
Snap all 4 anchors to a vertical line that cuts the parent control in half. Use with set_anchors_preset.


PRESET_HCENTER_WIDE:null = 14
Snap all 4 anchors to a horizontal line that cuts the parent control in half. Use with set_anchors_preset.


PRESET_FULL_RECT:null = 15
Snap all 4 anchors to the respective corners of the parent control. Set all 4 offsets to 0 after you applied this preset and the Control will fit its parent control. Use with set_anchors_preset.
 Enum LayoutPresetMode<>():Enum

PRESET_MODE_MINSIZE:null = 0
The control will be resized to its minimum size.


PRESET_MODE_KEEP_WIDTH:null = 1
The control's width will not change.


PRESET_MODE_KEEP_HEIGHT:null = 2
The control's height will not change.


PRESET_MODE_KEEP_SIZE:null = 3
The control's size will not change.
 Enum SizeFlags<>():Enum

SIZE_SHRINK_BEGIN:null = 0
Tells the parent Container to align the node with its start, either the top or the left edge. It is mutually exclusive with SIZE_FILL and other shrink size flags, but can be used with SIZE_EXPAND in some containers. Use with size_flags_horizontal and size_flags_vertical.
Note: Setting this flag is equal to not having any size flags.


SIZE_FILL:null = 1
Tells the parent Container to expand the bounds of this node to fill all the available space without pushing any other node. It is mutually exclusive with shrink size flags. Use with size_flags_horizontal and size_flags_vertical.


SIZE_EXPAND:null = 2
Tells the parent Container to let this node take all the available space on the axis you flag. If multiple neighboring nodes are set to expand, they'll share the space based on their stretch ratio. See size_flags_stretch_ratio. Use with size_flags_horizontal and size_flags_vertical.


SIZE_EXPAND_FILL:null = 3
Sets the node's size flags to both fill and expand. See SIZE_FILL and SIZE_EXPAND for more information.


SIZE_SHRINK_CENTER:null = 4
Tells the parent Container to center the node in the available space. It is mutually exclusive with SIZE_FILL and other shrink size flags, but can be used with SIZE_EXPAND in some containers. Use with size_flags_horizontal and size_flags_vertical.


SIZE_SHRINK_END:null = 8
Tells the parent Container to align the node with its end, either the bottom or the right edge. It is mutually exclusive with SIZE_FILL and other shrink size flags, but can be used with SIZE_EXPAND in some containers. Use with size_flags_horizontal and size_flags_vertical.
 Enum MouseFilter<>():Enum

MOUSE_FILTER_STOP:null = 0
The control will receive mouse movement input events and mouse button input events if clicked on through _gui_input. The control will also receive the mouse_entered and mouse_exited signals. These events are automatically marked as handled, and they will not propagate further to other controls. This also results in blocking signals in other controls.


MOUSE_FILTER_PASS:null = 1
The control will receive mouse movement input events and mouse button input events if clicked on through _gui_input. The control will also receive the mouse_entered and mouse_exited signals.
If this control does not handle the event, the event will propagate up to its parent control if it has one. The event is bubbled up the node hierarchy until it reaches a non-CanvasItem, a control with MOUSE_FILTER_STOP, or a CanvasItem with [member CanvasItem.top_level] enabled. This will allow signals to fire in all controls it reaches. If no control handled it, the event will be passed to [method Node._shortcut_input] for further processing.


MOUSE_FILTER_IGNORE:null = 2
The control will not receive any mouse movement input events nor mouse button input events through _gui_input. The control will also not receive the mouse_entered nor mouse_exited signals. This will not block other controls from receiving these events or firing the signals. Ignored events will not be handled automatically. If a child has MOUSE_FILTER_PASS and an event was passed to this control, the event will further propagate up to the control's parent.
Note: If the control has received mouse_entered but not mouse_exited, changing the mouse_filter to MOUSE_FILTER_IGNORE will cause mouse_exited to be emitted.
 Enum GrowDirection<>():Enum

GROW_DIRECTION_BEGIN:null = 0
The control will grow to the left or top to make up if its minimum size is changed to be greater than its current size on the respective axis.


GROW_DIRECTION_END:null = 1
The control will grow to the right or bottom to make up if its minimum size is changed to be greater than its current size on the respective axis.


GROW_DIRECTION_BOTH:null = 2
The control will grow in both directions equally to make up if its minimum size is changed to be greater than its current size.
 Enum Anchor<>():Enum

ANCHOR_BEGIN:null = 0
Snaps one of the 4 anchor's sides to the origin of the node's Rect, in the top left. Use it with one of the anchor_* member variables, like anchor_left. To change all 4 anchors at once, use set_anchors_preset.


ANCHOR_END:null = 1
Snaps one of the 4 anchor's sides to the end of the node's Rect, in the bottom right. Use it with one of the anchor_* member variables, like anchor_left. To change all 4 anchors at once, use set_anchors_preset.
 Enum LayoutDirection<>():Enum

LAYOUT_DIRECTION_INHERITED:null = 0
Automatic layout direction, determined from the parent control layout direction.


LAYOUT_DIRECTION_APPLICATION_LOCALE:null = 1
Automatic layout direction, determined from the current locale. Right-to-left layout direction is automatically used for languages that require it such as Arabic and Hebrew, but only if a valid translation file is loaded for the given language (unless said language is configured as a fallback in [member ProjectSettings.internationalization/locale/fallback]). For all other languages (or if no valid translation file is found by Godot), left-to-right layout direction is used. If using TextServerFallback ([member ProjectSettings.internationalization/rendering/text_driver]), left-to-right layout direction is always used regardless of the language. Right-to-left layout direction can also be forced using [member ProjectSettings.internationalization/rendering/force_right_to_left_layout_direction].


LAYOUT_DIRECTION_LTR:null = 2
Left-to-right layout direction.


LAYOUT_DIRECTION_RTL:null = 3
Right-to-left layout direction.


LAYOUT_DIRECTION_SYSTEM_LOCALE:null = 4
Automatic layout direction, determined from the system locale. Right-to-left layout direction is automatically used for languages that require it such as Arabic and Hebrew, but only if a valid translation file is loaded for the given language. For all other languages (or if no valid translation file is found by Godot), left-to-right layout direction is used. If using TextServerFallback ([member ProjectSettings.internationalization/rendering/text_driver]), left-to-right layout direction is always used regardless of the language.


LAYOUT_DIRECTION_MAX:null = 5
Represents the size of the LayoutDirection enum.


LAYOUT_DIRECTION_LOCALE:null = 1
 Enum TextDirection<>():Enum

TEXT_DIRECTION_INHERITED:null = 3
Text writing direction is the same as layout direction.


TEXT_DIRECTION_AUTO:null = 0
Automatic text writing direction, determined from the current locale and text content.


TEXT_DIRECTION_LTR:null = 1
Left-to-right text writing direction.


TEXT_DIRECTION_RTL:null = 2
Right-to-left text writing direction.
 Signal focus_entered<>():Signal
Emitted when the node gains focus.

Signal focus_exited<>():Signal
Emitted when the node loses focus.

Signal gui_input<>( InputEvent event=, event:InputEvent=, ):Signal
Emitted when the node receives an InputEvent.

Signal minimum_size_changed<>():Signal
Emitted when the node's minimum size changes.

Signal mouse_entered<>():Signal
Emitted when the mouse cursor enters the control's (or any child control's) visible area, that is not occluded behind other Controls or Windows, provided its mouse_filter lets the event reach it and regardless if it's currently focused or not.

Note: [member CanvasItem.z_index] doesn't affect, which Control receives the signal.
 Signal mouse_exited<>():Signal
Emitted when the mouse cursor leaves the control's (and all child control's) visible area, that is not occluded behind other Controls or Windows, provided its mouse_filter lets the event reach it and regardless if it's currently focused or not.

Note: [member CanvasItem.z_index] doesn't affect, which Control receives the signal.
Note: If you want to check whether the mouse truly left the area, ignoring any top nodes, you can use code like this:
func _on_mouse_exited(): if not Rect2(Vector2(), size).has_point(get_local_mouse_position()): # Not hovering over area.
Signal resized<>():Signal
Emitted when the control changes size.

Signal size_flags_changed<>():Signal
Emitted when one of the size flags changes. See size_flags_horizontal and size_flags_vertical.

Signal theme_changed<>():Signal
Emitted when the NOTIFICATION_THEME_CHANGED notification is sent.

set get NodePath[] accessibility_controls_nodes<>():NodePath[] set get
The paths to the nodes which are controlled by this node.

set get NodePath[] accessibility_described_by_nodes<>():NodePath[] set get
The paths to the nodes which are describing this node.

set get String accessibility_description<>():String set get
The human-readable node description that is reported to assistive apps.

set get NodePath[] accessibility_flow_to_nodes<>():NodePath[] set get
The paths to the nodes which this node flows into.

set get NodePath[] accessibility_labeled_by_nodes<>():NodePath[] set get
The paths to the nodes which label this node.

set get int accessibility_live<>():int set get
The mode with which a live region updates. A live region is a Node that is updated as a result of an external event when the user's focus may be elsewhere.

set get String accessibility_name<>():String set get
The human-readable node name that is reported to assistive apps.

set get float anchor_bottom<>():float set get
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 Anchor constants for convenience.

set get float anchor_left<>():float set get
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 Anchor constants for convenience.

set get float anchor_right<>():float set get
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 Anchor constants for convenience.

set get float anchor_top<>():float set get
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 Anchor constants for convenience.

set get bool auto_translate<>():bool set get
Toggles if any text should automatically change to its translated version depending on the current locale.

set get bool clip_contents<>():bool set get
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.

set get Vector2 custom_minimum_size<>():Vector2 set get
The minimum size of the node's bounding rectangle. If you set it to a value greater than (0, 0), the node's bounding rectangle will always have at least this size. Note that Control nodes have their internal minimum size returned by get_minimum_size. It depends on the control's contents, like text, textures, or style boxes. The actual minimum size is the maximum value of this property and the internal minimum size (see get_combined_minimum_size).

set get int focus_behavior_recursive<>():int set get
Determines which controls can be focused together with focus_mode. See get_focus_mode_with_override. Since the default behavior is FOCUS_BEHAVIOR_INHERITED, this can be used to prevent all children controls from getting focused.

set get int focus_mode<>():int set get
Determines which controls can be focused. Only one control can be focused at a time, and the focused control will receive keyboard, gamepad, and mouse events in _gui_input. Use get_focus_mode_with_override to determine if a control can grab focus, since focus_behavior_recursive also affects it. See also grab_focus.

set get NodePath focus_neighbor_bottom<>():NodePath set get
Tells Godot 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 [member ProjectSettings.input/ui_down] input action. The node must be a Control. If this property is not set, Godot will give focus to the closest Control to the bottom of this one.

set get NodePath focus_neighbor_left<>():NodePath set get
Tells Godot 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 [member ProjectSettings.input/ui_left] input action. The node must be a Control. If this property is not set, Godot will give focus to the closest Control to the left of this one.

set get NodePath focus_neighbor_right<>():NodePath set get
Tells Godot 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 [member ProjectSettings.input/ui_right] input action. The node must be a Control. If this property is not set, Godot will give focus to the closest Control to the right of this one.

set get NodePath focus_neighbor_top<>():NodePath set get
Tells Godot 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 [member ProjectSettings.input/ui_up] input action. The node must be a Control. If this property is not set, Godot will give focus to the closest Control to the top of this one.

set get NodePath focus_next<>():NodePath set get
Tells Godot which node it should give focus to if the user presses kbdTab[/kbd] on a keyboard by default. You can change the key by editing the [member ProjectSettings.input/ui_focus_next] input action.

If this property is not set, Godot will select a "best guess" based on surrounding nodes in the scene tree.
 set get NodePath focus_previous<>():NodePath set get
Tells Godot which node it should give focus to if the user presses kbdShift + Tab[/kbd] on a keyboard by default. You can change the key by editing the [member ProjectSettings.input/ui_focus_prev] input action.

If this property is not set, Godot will select a "best guess" based on surrounding nodes in the scene tree.
 set get Vector2 global_position<>():Vector2 set get
The node's global position, relative to the world (usually to the CanvasLayer).

set get int grow_horizontal<>():int set get
Controls the direction on the horizontal axis in which the control should grow if its horizontal minimum size is changed to be greater than its current size, as the control always has to be at least the minimum size.

set get int grow_vertical<>():int set get
Controls the direction on the vertical axis in which the control should grow if its vertical minimum size is changed to be greater than its current size, as the control always has to be at least the minimum size.

set get int layout_direction<>():int set get
Controls layout direction and text writing direction. Right-to-left layouts are necessary for certain languages (e.g. Arabic and Hebrew). See also is_layout_rtl.

set get bool localize_numeral_system<>():bool set get
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 [method TextServer.format_number].
 set get int mouse_behavior_recursive<>():int set get
Determines which controls can receive mouse input together with mouse_filter. See get_mouse_filter_with_override. Since the default behavior is MOUSE_BEHAVIOR_INHERITED, this can be used to prevent all children controls from receiving mouse input.

set get int mouse_default_cursor_shape<>():int set get
The default cursor shape for this control. Useful for Godot 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.
 set get int mouse_filter<>():int set get
Determines which controls will be able to receive mouse button input events through _gui_input and the mouse_entered, and mouse_exited signals. Also determines how these events should be propagated. See the constants to learn what each does. Use get_mouse_filter_with_override to determine if a control can receive mouse input, since mouse_behavior_recursive also affects it.

set get bool mouse_force_pass_scroll_events<>():bool set get
When enabled, scroll wheel events processed by _gui_input will be passed to the parent control even if mouse_filter is set to MOUSE_FILTER_STOP.

You should disable it on the root of your UI if you do not want scroll events to go to the [method Node._unhandled_input] processing.
Note: Because this property defaults to true, this allows nested scrollable containers to work out of the box.
 set get float offset_bottom<>():float set get
Distance between the node's bottom edge and its parent control, based on anchor_bottom.

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.
 set get float offset_left<>():float set get
Distance between the node's left edge and its parent control, based on anchor_left.

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.
 set get float offset_right<>():float set get
Distance between the node's right edge and its parent control, based on anchor_right.

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.
 set get float offset_top<>():float set get
Distance between the node's top edge and its parent control, based on anchor_top.

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.
 set get int physics_interpolation_mode<>():int set get
set get Vector2 pivot_offset<>():Vector2 set get
By default, the node's pivot is its top-left corner. When you change its rotation or scale, it will rotate or scale around this pivot.

The actual offset is the combined value of this property and pivot_offset_ratio.
 set get Vector2 pivot_offset_ratio<>():Vector2 set get
Same as pivot_offset, 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 pivot_offset.
 set get Vector2 position<>():Vector2 set get
The node's position, relative to its containing node. It corresponds to the rectangle's top-left corner. The property is not affected by pivot_offset.

set get float rotation<>():float set get
The node's rotation around its pivot, in radians. See pivot_offset 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 rotation_degrees.
 set get float rotation_degrees<>():float set get
Helper property to access rotation in degrees instead of radians.

set get Vector2 scale<>():Vector2 set get
The node's scale, relative to its size. Change this property to scale the node around its pivot_offset. 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 [url=$DOCS_URL/tutorials/rendering/multiple_resolutions.html]documentation[/url] instead of scaling Controls individually.
Note: [member FontFile.oversampling] does not take 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 [member 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, [member SystemFont.multichannel_signed_distance_field] 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 scale property.
 set get Node shortcut_context<>():Node set get
The Node 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.

set get Vector2 size<>():Vector2 set get
The size of the node's bounding rectangle, in the node's coordinate system. Container nodes update this property automatically.

set get int size_flags_horizontal<>():int set get
Tells the parent Container nodes how they should resize and place the node on the X axis. Use a combination of the SizeFlags constants to change the flags. See the constants to learn what each does.

set get float size_flags_stretch_ratio<>():float set get
If the node and at least one of its neighbors uses the SIZE_EXPAND size flag, the parent Container will let it take more or less space depending on this property. If this node has a stretch ratio of 2 and its neighbor a ratio of 1, this node will take two thirds of the available space.

set get int size_flags_vertical<>():int set get
Tells the parent Container nodes how they should resize and place the node on the Y axis. Use a combination of the SizeFlags constants to change the flags. See the constants to learn what each does.

set get Theme theme<>():Theme set get
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.
 set get StringName theme_type_variation<>():StringName set get
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. [code skip-lint]Button[/code] for the 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 [method Theme.set_type_variation]. 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 theme property. The earliest match against any type/class name is returned. The project-level Theme and the default Theme are checked last.
 set get int tooltip_auto_translate_mode<>():int set get
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 [constant Node.AUTO_TRANSLATE_MODE_INHERIT].

Note: Tooltips customized using _make_custom_tooltip do not use this auto translate mode automatically.
 set get String tooltip_text<>():String set get
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 mouse_filter property is not MOUSE_FILTER_IGNORE. The time required for the tooltip to appear can be changed with the [member ProjectSettings.gui/timers/tooltip_delay_sec] setting.

This string is the default return value of get_tooltip. Override _get_tooltip to generate tooltip text dynamically. Override _make_custom_tooltip 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 _make_custom_tooltip. 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 style_box = StyleBoxFlat.new() style_box.set_bg_color(Color(1, 1, 0)) style_box.set_border_width_all(2) # We assume here that the `theme` property has been assigned a custom Theme beforehand. theme.set_stylebox("panel", "TooltipPanel", style_box) theme.set_color("font_color", "TooltipLabel", Color(0, 1, 1))
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));

String _accessibility_get_contextual_info<>():String
Return the description of the keyboard shortcuts and other contextual help for this control.

bool _can_drop_data<>( Vector2 at_position=, at_position:Vector2=, Variant data=, data:Variant=, ):bool
Godot calls this method to test if data from a control's _get_drag_data can be dropped at at_position. at_position is local to this control.

This method should only be used to test the data. Process the data in _drop_data.
Note: If the drag was initiated by a keyboard shortcut or accessibility_drag, at_position is set to [constant Vector2.INF], and the currently selected item/text position should be used as the drop position.
func _can_drop_data(position, data): # Check position if it is relevant to you # Otherwise, just check data return typeof(data) == TYPE_DICTIONARY and data.has("expected")
public override bool _CanDropData(Vector2 atPosition, Variant data) { // Check position if it is relevant to you // Otherwise, just check data return data.VariantType == Variant.Type.Dictionary && data.AsGodotDictionary().ContainsKey("expected"); }

void _drop_data<>( Vector2 at_position=, at_position:Vector2=, Variant data=, data:Variant=, ):void
Godot calls this method to pass you the data from a control's _get_drag_data result. Godot first calls _can_drop_data to test if data is allowed to drop at at_position where at_position is local to this control.

Note: If the drag was initiated by a keyboard shortcut or accessibility_drag, at_position is set to [constant Vector2.INF], and the currently selected item/text position should be used as the drop position.
func _can_drop_data(position, data): return typeof(data) == TYPE_DICTIONARY and data.has("color") func _drop_data(position, data): var color = data["color"]
public override bool _CanDropData(Vector2 atPosition, Variant data) { return data.VariantType == Variant.Type.Dictionary && data.AsGodotDictionary().ContainsKey("color"); } public override void _DropData(Vector2 atPosition, Variant data) { Color color = data.AsGodotDictionary()["color"].AsColor(); }

String _get_accessibility_container_name<>( Node node=, node:Node=, ):String
Override this method to return a human-readable description of the position of the child node in the custom container, added to the accessibility_name.

Variant _get_drag_data<>( Vector2 at_position=, at_position:Vector2=, ):Variant
Godot calls this method to get data that can be dragged and dropped onto controls that expect drop data. Returns null if there is no data to drag. Controls that want to receive drop data should implement _can_drop_data and _drop_data. at_position is local to this control. Drag may be forced with force_drag.

A preview that will follow the mouse that should represent the data can be set with set_drag_preview. A good time to set the preview is in this method.
Note: If the drag was initiated by a keyboard shortcut or accessibility_drag, at_position is set to [constant Vector2.INF], and the currently selected item/text position should be used as the drag position.
func _get_drag_data(position): var mydata = make_data() # This is your custom method generating the drag data. set_drag_preview(make_preview(mydata)) # This is your custom method generating the preview of the drag data. return mydata
public override Variant _GetDragData(Vector2 atPosition) { var myData = MakeData(); // This is your custom method generating the drag data. SetDragPreview(MakePreview(myData)); // This is your custom method generating the preview of the drag data. return myData; }

Vector2 _get_minimum_size<>():Vector2
Virtual method to be implemented by the user. Returns the minimum size for this control. Alternative to custom_minimum_size 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 [constant 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.
 String _get_tooltip<>( Vector2 at_position=, at_position:Vector2=, ):String
Virtual method to be implemented by the user. Returns the tooltip text for the position at_position in control's local coordinates, which will typically appear when the cursor is resting over this control. See get_tooltip.

Note: If this method returns an empty String and _make_custom_tooltip is not overridden, no tooltip is displayed.
 void _gui_input<>( InputEvent event=, event:InputEvent=, ):void
Virtual method to be implemented by the user. Override this method to handle and accept inputs on UI elements. See also accept_event.

Example: Click on the control to print a message:
func _gui_input(event): if event is InputEventMouseButton: if event.button_index == MOUSE_BUTTON_LEFT and event.pressed: print("I've been clicked D:")
public override void _GuiInput(InputEvent @event) { if (@event is InputEventMouseButton mb) { if (mb.ButtonIndex == MouseButton.Left && mb.Pressed) { GD.Print("I've been clicked D:"); } } }

If the event inherits InputEventMouse, this method will not be called when:
- the control's mouse_filter is set to MOUSE_FILTER_IGNORE;
- the control is obstructed by another control on top, that doesn't have mouse_filter set to MOUSE_FILTER_IGNORE;
- the control's parent has mouse_filter set to MOUSE_FILTER_STOP or has accepted the event;
- the control's parent has clip_contents enabled and the event's position is outside the parent's rectangle;
- the event's position is outside the control (see _has_point).
Note: The event's position is relative to this control's origin.
 bool _has_point<>( Vector2 point=, point:Vector2=, ):bool
Virtual method to be implemented by the user. Returns whether the given point is inside this control.

If not overridden, default behavior is checking if the point is within control's Rect.
Note: If you want to check if a point is inside the control, you can use Rect2(Vector2.ZERO, size).has_point(point).
 Object _make_custom_tooltip<>( String for_text=, for_text:String=, ):Object
Virtual method to be implemented by the user. Returns a Control node that should be used as a tooltip instead of the default one. for_text is the return value of get_tooltip.

The returned node must be of type Control or Control-derived. It can have child nodes of any type. It is freed when the tooltip disappears, so make sure you always provide a new instance (if you want to use a pre-existing node from your scene tree, you can duplicate it and pass the duplicated instance). When null or a non-Control node is returned, the default tooltip will be used instead.
The returned node will be added as child to a PopupPanel, so you should only provide the contents of that panel. That PopupPanel can be themed using [method Theme.set_stylebox] for the type "TooltipPanel" (see tooltip_text for an example).
Note: The tooltip is shrunk to minimal size. If you want to ensure it's fully visible, you might want to set its custom_minimum_size to some non-zero value.
Note: The node (and any relevant children) should have their [member CanvasItem.visible] set to true when returned, otherwise, the viewport that instantiates it will not be able to calculate its minimum size reliably.
Note: If overridden, this method is called even if get_tooltip returns an empty string. When this happens with the default tooltip, it is not displayed. To copy this behavior, return null in this method when for_text is empty.
Example: Use a constructed node as a tooltip:
func _make_custom_tooltip(for_text): var label = Label.new() label.text = for_text return label
public override Control _MakeCustomTooltip(string forText) { var label = new Label(); label.Text = forText; return label; }

Example: Use a scene instance as a tooltip:
func _make_custom_tooltip(for_text): var tooltip = preload("res://some_tooltip_scene.tscn").instantiate() tooltip.get_node("Label").text = for_text return tooltip
public override Control _MakeCustomTooltip(string forText) { Node tooltip = ResourceLoader.Load<PackedScene>("res://some_tooltip_scene.tscn").Instantiate(); tooltip.GetNode<Label>("Label").Text = forText; return tooltip; }

Vector3i[] _structured_text_parser<>( Array args=, args:Array=, String text=, text:String=, ):Vector3i[]
User defined BiDi algorithm override function.

Returns an Array of Vector3i text ranges and text base directions, in the left-to-right order. Ranges should cover full source text without overlaps. BiDi algorithm will be used on each range separately.
 void accept_event<>():void
Marks an input event as handled. Once you accept an input event, it stops propagating, even to nodes listening to [method Node._unhandled_input] or [method Node._unhandled_key_input].

Note: This does not affect the methods in Input, only the way events are propagated.
 void accessibility_drag<>():void
Starts drag-and-drop operation without using a mouse.

void accessibility_drop<>():void
Ends drag-and-drop operation without using a mouse.

void add_theme_color_override<>( StringName name=, name:StringName=, Color color=, color:Color=, ):void
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 remove_theme_color_override.

See also get_theme_color.
Example: Override a Label's color and reset it later:
# Given the child Label node "MyLabel", override its font color with a custom value. $MyLabel.add_theme_color_override("font_color", Color(1, 0.5, 0)) # Reset the font color of the child label. $MyLabel.remove_theme_color_override("font_color") # Alternatively it can be overridden with the default value from the Label type. $MyLabel.add_theme_color_override("font_color", get_theme_color("font_color", "Label"))
// Given the child Label node "MyLabel", override its font color with a custom value. GetNode<Label>("MyLabel").AddThemeColorOverride("font_color", new Color(1, 0.5f, 0)); // Reset the font color of the child label. GetNode<Label>("MyLabel").RemoveThemeColorOverride("font_color"); // Alternatively it can be overridden with the default value from the Label type. GetNode<Label>("MyLabel").AddThemeColorOverride("font_color", GetThemeColor("font_color", "Label"));

void add_theme_constant_override<>( StringName name=, name:StringName=, int constant=, constant:int=, ):void
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 remove_theme_constant_override.

See also get_theme_constant.
 void add_theme_font_override<>( StringName name=, name:StringName=, Font font=, font:Font=, ):void
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 remove_theme_font_override.

See also get_theme_font.
 void add_theme_font_size_override<>( StringName name=, name:StringName=, int font_size=, font_size:int=, ):void
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 remove_theme_font_size_override.
 void add_theme_icon_override<>( StringName name=, name:StringName=, Texture2D texture=, texture:Texture2D=, ):void
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 remove_theme_icon_override.

See also get_theme_icon.
 void add_theme_stylebox_override<>( StringName name=, name:StringName=, StyleBox stylebox=, stylebox:StyleBox=, ):void
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 remove_theme_stylebox_override.

See also get_theme_stylebox.
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. var new_stylebox_normal = $MyButton.get_theme_stylebox("normal").duplicate() new_stylebox_normal.border_width_top = 3 new_stylebox_normal.border_color = Color(0, 1, 0.5) $MyButton.add_theme_stylebox_override("normal", new_stylebox_normal) # Remove the stylebox override. $MyButton.remove_theme_stylebox_override("normal")
// 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 = GetNode<Button>("MyButton").GetThemeStylebox("normal").Duplicate() as StyleBoxFlat; newStyleboxNormal.BorderWidthTop = 3; newStyleboxNormal.BorderColor = new Color(0, 1, 0.5f); GetNode<Button>("MyButton").AddThemeStyleboxOverride("normal", newStyleboxNormal); // Remove the stylebox override. GetNode<Button>("MyButton").RemoveThemeStyleboxOverride("normal");

void begin_bulk_theme_override<>():void
Prevents *_theme_*_override methods from emitting NOTIFICATION_THEME_CHANGED until end_bulk_theme_override is called.

void end_bulk_theme_override<>():void
Ends a bulk theme override update. See begin_bulk_theme_override.

Control find_next_valid_focus<>():Control
Finds the next (below in the tree) Control that can receive the focus.

Control find_prev_valid_focus<>():Control
Finds the previous (above in the tree) Control that can receive the focus.

Control find_valid_focus_neighbor<>( int side=, side:int=, ):Control
Finds the next Control that can receive the focus on the specified Side.

Note: This is different from get_focus_neighbor, which returns the path of a specified focus neighbor.
 void force_drag<>( Variant data=, data:Variant=, Control preview=, preview:Control=, ):void
Forces drag and bypasses _get_drag_data and set_drag_preview by passing data and preview. Drag will start even if the mouse is neither over nor pressed on this control.

The methods _can_drop_data and _drop_data must be implemented on controls that want to receive drop data.
 float get_anchor<>( int side=, side:int=, ):float
Returns the anchor for the specified Side. A getter method for anchor_bottom, anchor_left, anchor_right and anchor_top.

Vector2 get_begin<>():Vector2
Returns offset_left and offset_top. See also position.

Vector2 get_combined_minimum_size<>():Vector2
Returns combined minimum size from custom_minimum_size and get_minimum_size.

Vector2 get_combined_pivot_offset<>():Vector2
Returns the combined value of pivot_offset and pivot_offset_ratio, in pixels. The ratio is multiplied by the control's size.

int get_cursor_shape<>( Vector2 position=Vector2(0, 0), position:Vector2=Vector2(0, 0), ):int
Returns the mouse cursor shape for this control when hovered over position in local coordinates. For most controls, this is the same as mouse_default_cursor_shape, but some built-in controls implement more complex logic.

Vector2 get_end<>():Vector2

int get_focus_mode_with_override<>():int
Returns the focus_mode, but takes the focus_behavior_recursive into account. If focus_behavior_recursive is set to FOCUS_BEHAVIOR_DISABLED, or it is set to FOCUS_BEHAVIOR_INHERITED and its ancestor is set to FOCUS_BEHAVIOR_DISABLED, then this returns FOCUS_NONE.

NodePath get_focus_neighbor<>( int side=, side:int=, ):NodePath
Returns the focus neighbor for the specified Side. A getter method for focus_neighbor_bottom, focus_neighbor_left, focus_neighbor_right and focus_neighbor_top.

Note: To find the next Control on the specific Side, even if a neighbor is not assigned, use find_valid_focus_neighbor.
 Rect2 get_global_rect<>():Rect2
Returns the position and size of the control relative to the containing canvas. See global_position and 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 [member Viewport.gui_snap_controls_to_pixels] to true can lead to rounding inaccuracies between the displayed control and the returned Rect2.
 Vector2 get_minimum_size<>():Vector2
Returns the minimum size for this control. See custom_minimum_size.

int get_mouse_filter_with_override<>():int
Returns the mouse_filter, but takes the mouse_behavior_recursive into account. If mouse_behavior_recursive is set to MOUSE_BEHAVIOR_DISABLED, or it is set to MOUSE_BEHAVIOR_INHERITED and its ancestor is set to MOUSE_BEHAVIOR_DISABLED, then this returns MOUSE_FILTER_IGNORE.

float get_offset<>( int offset=, offset:int=, ):float
Returns the offset for the specified Side. A getter method for offset_bottom, offset_left, offset_right and offset_top.

Vector2 get_parent_area_size<>():Vector2
Returns the width/height occupied in the parent control.

Control get_parent_control<>():Control
Returns the parent control node.

Rect2 get_rect<>():Rect2
Returns the position and size of the control in the coordinate system of the containing node. See position, scale and size.

Note: If rotation is not the default rotation, the resulting size is not meaningful.
Note: Setting [member Viewport.gui_snap_controls_to_pixels] to true can lead to rounding inaccuracies between the displayed control and the returned Rect2.
 Vector2 get_screen_position<>():Vector2
Returns the position of this Control in global screen coordinates (i.e. taking window position into account). Mostly useful for editor plugins.

Equals to global_position if the window is embedded (see [member Viewport.gui_embed_subwindows]).
Example: Show a popup at the mouse position:
popup_menu.position = get_screen_position() + get_local_mouse_position() popup_menu.reset_size() popup_menu.popup()
Color get_theme_color<>( StringName name=, name:StringName=, StringName theme_type=&"", theme_type:StringName=&"", ):Color
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 theme_type_variation 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 add_theme_color_override), then its assigned theme. After the current control, each parent control and its assigned theme are considered; controls without a theme assigned are skipped. If no matching Theme is found in the tree, the custom project Theme (see [member ProjectSettings.gui/theme/custom]) and the default Theme are used (see ThemeDB).
func _ready(): # Get the font color defined for the current Control's class, if it exists. modulate = get_theme_color("font_color") # Get the font color defined for the Button class. modulate = get_theme_color("font_color", "Button")
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"); }

int get_theme_constant<>( StringName name=, name:StringName=, StringName theme_type=&"", theme_type:StringName=&"", ):int
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 get_theme_color for details.
 float get_theme_default_base_scale<>():float
Returns the default base scale value from the first matching Theme in the tree if that Theme has a valid [member Theme.default_base_scale] value.

See get_theme_color for details.
 Font get_theme_default_font<>():Font
Returns the default font from the first matching Theme in the tree if that Theme has a valid [member Theme.default_font] value.

See get_theme_color for details.
 int get_theme_default_font_size<>():int
Returns the default font size value from the first matching Theme in the tree if that Theme has a valid [member Theme.default_font_size] value.

See get_theme_color for details.
 Font get_theme_font<>( StringName name=, name:StringName=, StringName theme_type=&"", theme_type:StringName=&"", ):Font
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 get_theme_color for details.
 int get_theme_font_size<>( StringName name=, name:StringName=, StringName theme_type=&"", theme_type:StringName=&"", ):int
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 get_theme_color for details.
 Texture2D get_theme_icon<>( StringName name=, name:StringName=, StringName theme_type=&"", theme_type:StringName=&"", ):Texture2D
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 get_theme_color for details.
 StyleBox get_theme_stylebox<>( StringName name=, name:StringName=, StringName theme_type=&"", theme_type:StringName=&"", ):StyleBox
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 get_theme_color for details.
 String get_tooltip<>( Vector2 at_position=Vector2(0, 0), at_position:Vector2=Vector2(0, 0), ):String
Returns the tooltip text for the position at_position in control's local coordinates, which will typically appear when the cursor is resting over this control. By default, it returns tooltip_text.

This method can be overridden to customize its behavior. See _get_tooltip.
Note: If this method returns an empty String and _make_custom_tooltip is not overridden, no tooltip is displayed.
 void grab_click_focus<>():void
Creates an InputEventMouseButton that attempts to click the control. If the event is received, the control gains focus.

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

void grab_focus<>( bool hide_focus=false, hide_focus:bool=false, ):void
Steal the focus from another control and become the focused control (see focus_mode).

If hide_focus is true, the control will not visually show its focused state. Has no effect for LineEdit and TextEdit when [member ProjectSettings.gui/common/show_focus_state_on_pointer_event] is set to Control Supports Keyboard Input, or for any control when it is set to Always.
Note: Using this method together with [method Callable.call_deferred] makes it more reliable, especially when called inside [method Node._ready].
 bool has_focus<>( bool ignore_hidden_focus=false, ignore_hidden_focus:bool=false, ):bool
Returns true if this is the current focused control. See focus_mode.

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 grab_focus with hide_focus set to true.
 bool has_theme_color<>( StringName name=, name:StringName=, StringName theme_type=&"", theme_type:StringName=&"", ):bool
Returns true if there is a matching Theme in the tree that has a color item with the specified name and theme_type.

See get_theme_color for details.
 bool has_theme_color_override<>( StringName name=, name:StringName=, ):bool
Returns true if there is a local override for a theme Color with the specified name in this Control node.
 bool has_theme_constant<>( StringName name=, name:StringName=, StringName theme_type=&"", theme_type:StringName=&"", ):bool
Returns true if there is a matching Theme in the tree that has a constant item with the specified name and theme_type.

See get_theme_color for details.
 bool has_theme_constant_override<>( StringName name=, name:StringName=, ):bool
Returns true if there is a local override for a theme constant with the specified name in this Control node.
 bool has_theme_font<>( StringName name=, name:StringName=, StringName theme_type=&"", theme_type:StringName=&"", ):bool
Returns true if there is a matching Theme in the tree that has a font item with the specified name and theme_type.

See get_theme_color for details.
 bool has_theme_font_override<>( StringName name=, name:StringName=, ):bool
Returns true if there is a local override for a theme Font with the specified name in this Control node.
 bool has_theme_font_size<>( StringName name=, name:StringName=, StringName theme_type=&"", theme_type:StringName=&"", ):bool
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 get_theme_color for details.
 bool has_theme_font_size_override<>( StringName name=, name:StringName=, ):bool
Returns true if there is a local override for a theme font size with the specified name in this Control node.
 bool has_theme_icon<>( StringName name=, name:StringName=, StringName theme_type=&"", theme_type:StringName=&"", ):bool
Returns true if there is a matching Theme in the tree that has an icon item with the specified name and theme_type.

See get_theme_color for details.
 bool has_theme_icon_override<>( StringName name=, name:StringName=, ):bool
Returns true if there is a local override for a theme icon with the specified name in this Control node.
 bool has_theme_stylebox<>( StringName name=, name:StringName=, StringName theme_type=&"", theme_type:StringName=&"", ):bool
Returns true if there is a matching Theme in the tree that has a stylebox item with the specified name and theme_type.

See get_theme_color for details.
 bool has_theme_stylebox_override<>( StringName name=, name:StringName=, ):bool
Returns true if there is a local override for a theme StyleBox with the specified name in this Control node.
 bool is_drag_successful<>():bool
Returns true if a drag operation is successful. Alternative to [method Viewport.gui_is_drag_successful].

Best used with [constant Node.NOTIFICATION_DRAG_END].
 bool is_layout_rtl<>():bool
Returns true if the layout is right-to-left. See also layout_direction.

void release_focus<>():void
Give up the focus. No other control will be able to receive input.

void remove_theme_color_override<>( StringName name=, name:StringName=, ):void
Removes a local override for a theme Color with the specified name previously added by add_theme_color_override or via the Inspector dock.

void remove_theme_constant_override<>( StringName name=, name:StringName=, ):void
Removes a local override for a theme constant with the specified name previously added by add_theme_constant_override or via the Inspector dock.

void remove_theme_font_override<>( StringName name=, name:StringName=, ):void
Removes a local override for a theme Font with the specified name previously added by add_theme_font_override or via the Inspector dock.

void remove_theme_font_size_override<>( StringName name=, name:StringName=, ):void
Removes a local override for a theme font size with the specified name previously added by add_theme_font_size_override or via the Inspector dock.

void remove_theme_icon_override<>( StringName name=, name:StringName=, ):void
Removes a local override for a theme icon with the specified name previously added by add_theme_icon_override or via the Inspector dock.

void remove_theme_stylebox_override<>( StringName name=, name:StringName=, ):void
Removes a local override for a theme StyleBox with the specified name previously added by add_theme_stylebox_override or via the Inspector dock.

void reset_size<>():void
Resets the size to get_combined_minimum_size. This is equivalent to calling set_size(Vector2()) (or any size below the minimum).

void set_anchor<>( int side=, side:int=, float anchor=, anchor:float=, bool keep_offset=false, keep_offset:bool=false, bool push_opposite_anchor=true, push_opposite_anchor:bool=true, ):void
Sets the anchor for the specified Side to anchor. A setter method for anchor_bottom, anchor_left, anchor_right and anchor_top.

If keep_offset is true, offsets aren't updated after this operation.
If push_opposite_anchor is true and the opposite anchor overlaps this anchor, the opposite one will have its value overridden. For example, when setting left anchor to 1 and the right anchor has value of 0.5, the right anchor will also get value of 1. If push_opposite_anchor was false, the left anchor would get value 0.5.
 void set_anchor_and_offset<>( int side=, side:int=, float anchor=, anchor:float=, float offset=, offset:float=, bool push_opposite_anchor=false, push_opposite_anchor:bool=false, ):void
Works the same as set_anchor, but instead of keep_offset argument and automatic update of offset, it allows to set the offset yourself (see set_offset).

void set_anchors_and_offsets_preset<>( int preset=, preset:int=, int resize_mode=0, resize_mode:int=0, int margin=0, margin:int=0, ):void
Sets both anchor preset and offset preset. See set_anchors_preset and set_offsets_preset.

void set_anchors_preset<>( int preset=, preset:int=, bool keep_offsets=false, keep_offsets:bool=false, ):void
Sets the anchors to a preset from [enum Control.LayoutPreset] enum. This is the code equivalent to using the Layout menu in the 2D editor.

If keep_offsets is true, control's position will also be updated.
 void set_begin<>( Vector2 position=, position:Vector2=, ):void
Sets offset_left and offset_top at the same time. Equivalent of changing position.

void set_drag_forwarding<>( Callable drag_func=, drag_func:Callable=, Callable can_drop_func=, can_drop_func:Callable=, Callable drop_func=, drop_func:Callable=, ):void
Sets the given callables to be used instead of the control's own drag-and-drop virtual methods. If a callable is empty, its respective virtual method is used as normal.

The arguments for each callable should be exactly the same as their respective virtual methods, which would be:
- drag_func corresponds to _get_drag_data and requires a Vector2;
- can_drop_func corresponds to _can_drop_data and requires both a Vector2 and a Variant;
- drop_func corresponds to _drop_data and requires both a Vector2 and a Variant.
 void set_drag_preview<>( Control control=, control:Control=, ):void
Shows the given control at the mouse pointer. A good time to call this method is in _get_drag_data. The control must not be in the scene tree. You should not free the control, and you should not keep a reference to the control beyond the duration of the drag. It will be deleted automatically after the drag has ended.

@export var color = Color(1, 0, 0, 1) func _get_drag_data(position): # Use a control that is not in the tree var cpb = ColorPickerButton.new() cpb.color = color cpb.size = Vector2(50, 50) set_drag_preview(cpb) return color
[Export] private Color _color = new Color(1, 0, 0, 1); public override Variant _GetDragData(Vector2 atPosition) { // Use a control that is not in the tree var cpb = new ColorPickerButton(); cpb.Color = _color; cpb.Size = new Vector2(50, 50); SetDragPreview(cpb); return _color; }

void set_end<>( Vector2 position=, position:Vector2=, ):void
Sets offset_right and offset_bottom at the same time.

void set_focus_neighbor<>( int side=, side:int=, NodePath neighbor=, neighbor:NodePath=, ):void
Sets the focus neighbor for the specified Side to the Control at neighbor node path. A setter method for focus_neighbor_bottom, focus_neighbor_left, focus_neighbor_right and focus_neighbor_top.

void set_global_position<>( Vector2 position=, position:Vector2=, bool keep_offsets=false, keep_offsets:bool=false, ):void
Sets the global_position to given position.

If keep_offsets is true, control's anchors will be updated instead of offsets.
 void set_offset<>( int side=, side:int=, float offset=, offset:float=, ):void
Sets the offset for the specified Side to offset. A setter method for offset_bottom, offset_left, offset_right and offset_top.

void set_offsets_preset<>( int preset=, preset:int=, int resize_mode=0, resize_mode:int=0, int margin=0, margin:int=0, ):void
Sets the offsets to a preset from [enum Control.LayoutPreset] enum. This is the code equivalent to using the Layout menu in the 2D editor.

Use parameter resize_mode with constants from [enum Control.LayoutPresetMode] to better determine the resulting size of the Control. Constant size will be ignored if used with presets that change size, e.g. PRESET_LEFT_WIDE.
Use parameter margin to determine the gap between the Control and the edges.
 void set_position<>( Vector2 position=, position:Vector2=, bool keep_offsets=false, keep_offsets:bool=false, ):void
Sets the position to given position.

If keep_offsets is true, control's anchors will be updated instead of offsets.
 void set_size<>( Vector2 size=, size:Vector2=, bool keep_offsets=false, keep_offsets:bool=false, ):void
Sets the size (see size).

If keep_offsets is true, control's anchors will be updated instead of offsets.
 void update_minimum_size<>():void
Invalidates the size cache in this node and in parent nodes up to top level. Intended to be used with get_minimum_size when the return value is changed. Setting custom_minimum_size directly calls this method automatically.

void warp_mouse<>( Vector2 position=, position:Vector2=, ):void
Moves the mouse cursor to position, relative to position of this Control.

Note: warp_mouse is only supported on Windows, macOS and Linux. It has no effect on Android, iOS and Web.


All social media brands are registrated trademarks and belong to their respective owners.





CONTACT IMPRINT TERMS OF USE PRIVACY © ROKOROJI ® 2021 rokojori.com CONTACT IMPRINT TERMS OF USE PRIVACY © ROKOROJI ® 2021 rokojori.com We are using cookies on this site. Read more... Wir benutzen Cookies auf dieser Seite. Mehr lesen...