Inherits: CanvasItem < Node < Object
Inherited By: BaseButton, ColorRect, Container, GraphEdit, ItemList, Label, LineEdit, NinePatchRect, Panel, Popup, Range, ReferenceRect, RichTextLabel, Separator, Tabs, TextEdit, TextureRect, Tree, VideoPlayer
All user interface nodes inherit from Control. A control's anchors and margins adapt its position and size relative to its parent.
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 margins that represent an offset to the anchor. The margins update automatically when the node, any of its parents, or the screen size change.
For more information on Godot's UI system, anchors, margins, 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.
User Interface nodes and input
Godot sends input events to the scene's root node first, by calling Node._input. Node._input forwards the event down the node tree to the nodes under the mouse cursor, or on keyboard focus. To do so, it calls MainLoop._input_event. Call accept_event so no other node receives the event. Once you accepted an input, it becomes handled so Node._unhandled_input will not process it.
Only one Control node can be in keyboard focus. Only the node in focus will receive keyboard 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.
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. If you change the Theme on a Control node, it affects all of its children. To override some of the theme's parameters, call one of the add_*_override methods, like add_font_override. You can override the theme with the inspector.
Note: Theme items are not Object properties. This means you can't access their values using Object.get and Object.set. Instead, use get_color, get_constant, get_font, get_icon, get_stylebox, and the add_*_override methods provided by this class.
| float | anchor_bottom | 0.0 |
| float | anchor_left | 0.0 |
| float | anchor_right | 0.0 |
| float | anchor_top | 0.0 |
| FocusMode | focus_mode | 0 |
| NodePath | focus_neighbour_bottom | NodePath("") |
| NodePath | focus_neighbour_left | NodePath("") |
| NodePath | focus_neighbour_right | NodePath("") |
| NodePath | focus_neighbour_top | NodePath("") |
| NodePath | focus_next | NodePath("") |
| NodePath | focus_previous | NodePath("") |
| GrowDirection | grow_horizontal | 1 |
| GrowDirection | grow_vertical | 1 |
| String | hint_tooltip | "" |
| float | margin_bottom | 0.0 |
| float | margin_left | 0.0 |
| float | margin_right | 0.0 |
| float | margin_top | 0.0 |
| CursorShape | mouse_default_cursor_shape | 0 |
| MouseFilter | mouse_filter | 0 |
| bool | rect_clip_content | false |
| Vector2 | rect_global_position | |
| Vector2 | rect_min_size | Vector2( 0, 0 ) |
| Vector2 | rect_pivot_offset | Vector2( 0, 0 ) |
| Vector2 | rect_position | Vector2( 0, 0 ) |
| float | rect_rotation | 0.0 |
| Vector2 | rect_scale | Vector2( 1, 1 ) |
| Vector2 | rect_size | Vector2( 0, 0 ) |
| int | size_flags_horizontal | 1 |
| float | size_flags_stretch_ratio | 1.0 |
| int | size_flags_vertical | 1 |
| Theme | theme |
Emitted when the node gains keyboard focus.
Emitted when the node loses keyboard focus.
Emitted when the node receives an InputEvent.
Emitted when the node's minimum size changes.
Emitted when a modal Control is closed. See show_modal.
Emitted when the mouse enters the control's Rect area, provided its mouse_filter lets the event reach it.
Emitted when the mouse leaves the control's Rect area, provided its mouse_filter lets the event reach it.
Emitted when the control changes size.
Emitted when one of the size flags changes. See size_flags_horizontal and size_flags_vertical.
enum FocusMode:
enum CursorShape:
enum LayoutPreset:
Control will fit its parent control. This is equivalent to the "Full Rect" layout option in the editor. Use with set_anchors_preset.enum LayoutPresetMode:
enum SizeFlags:
enum MouseFilter:
enum GrowDirection:
enum Anchor:
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.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.add_*_override methods.| Default | 0.0 |
| Getter | get_anchor() |
Anchors the bottom edge of the node to the origin, the center, or the end of its parent control. It changes how the bottom margin updates when the node moves or changes size. You can use one of the Anchor constants for convenience.
| Default | 0.0 |
| Getter | get_anchor() |
Anchors the left edge of the node to the origin, the center or the end of its parent control. It changes how the left margin updates when the node moves or changes size. You can use one of the Anchor constants for convenience.
| Default | 0.0 |
| Getter | get_anchor() |
Anchors the right edge of the node to the origin, the center or the end of its parent control. It changes how the right margin updates when the node moves or changes size. You can use one of the Anchor constants for convenience.
| Default | 0.0 |
| Getter | get_anchor() |
Anchors the top edge of the node to the origin, the center or the end of its parent control. It changes how the top margin updates when the node moves or changes size. You can use one of the Anchor constants for convenience.
| Default | 0 |
| Setter | set_focus_mode(value) |
| Getter | get_focus_mode() |
The focus access mode for the control (None, Click or All). Only one Control can be focused at the same time, and it will receive keyboard signals.
| Default | NodePath("") |
| Setter | set_focus_neighbour(value) |
| Getter | get_focus_neighbour() |
Tells Godot which node it should give keyboard 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 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.
| Default | NodePath("") |
| Setter | set_focus_neighbour(value) |
| Getter | get_focus_neighbour() |
Tells Godot which node it should give keyboard 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 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.
| Default | NodePath("") |
| Setter | set_focus_neighbour(value) |
| Getter | get_focus_neighbour() |
Tells Godot which node it should give keyboard 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 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 bottom of this one.
| Default | NodePath("") |
| Setter | set_focus_neighbour(value) |
| Getter | get_focus_neighbour() |
Tells Godot which node it should give keyboard 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 ui_top 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.
| Default | NodePath("") |
| Setter | set_focus_next(value) |
| Getter | get_focus_next() |
Tells Godot which node it should give keyboard focus to if the user presses Tab on a keyboard by default. You can change the key by editing the 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.
| Default | NodePath("") |
| Setter | set_focus_previous(value) |
| Getter | get_focus_previous() |
Tells Godot which node it should give keyboard focus to if the user presses Shift+Tab on a keyboard by default. You can change the key by editing the 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.
| Default | 1 |
| Setter | set_h_grow_direction(value) |
| Getter | get_h_grow_direction() |
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.
| Default | 1 |
| Setter | set_v_grow_direction(value) |
| Getter | get_v_grow_direction() |
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.
| Default | "" |
| Setter | set_tooltip(value) |
Changes the 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. You can change the time required for the tooltip to appear with gui/timers/tooltip_delay_sec option in Project Settings.
| Default | 0.0 |
| Setter | set_margin(value) |
| Getter | get_margin() |
Distance between the node's bottom edge and its parent control, based on anchor_bottom.
Margins 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. Margins update automatically when you move or resize the node.
| Default | 0.0 |
| Setter | set_margin(value) |
| Getter | get_margin() |
Distance between the node's left edge and its parent control, based on anchor_left.
Margins 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. Margins update automatically when you move or resize the node.
| Default | 0.0 |
| Setter | set_margin(value) |
| Getter | get_margin() |
Distance between the node's right edge and its parent control, based on anchor_right.
Margins 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. Margins update automatically when you move or resize the node.
| Default | 0.0 |
| Setter | set_margin(value) |
| Getter | get_margin() |
Distance between the node's top edge and its parent control, based on anchor_top.
Margins 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. Margins update automatically when you move or resize the node.
| Default | 0 |
| Setter | set_default_cursor_shape(value) |
| Getter | get_default_cursor_shape() |
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.
| Default | 0 |
| Setter | set_mouse_filter(value) |
| Getter | get_mouse_filter() |
Controls whether the control will be able to receive mouse button input events through _gui_input and how these events should be handled. Also controls whether the control can receive the mouse_entered, and mouse_exited signals. See the constants to learn what each does.
| Default | false |
| Setter | set_clip_contents(value) |
| Getter | is_clipping_contents() |
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.
| Getter | get_global_position() |
The node's global position, relative to the world (usually to the top-left corner of the window).
| Default | Vector2( 0, 0 ) |
| Setter | set_custom_minimum_size(value) |
| Getter | get_custom_minimum_size() |
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, even if its content is smaller. If it's set to (0, 0), the node sizes automatically to fit its content, be it a texture or child nodes.
| Default | Vector2( 0, 0 ) |
| Setter | set_pivot_offset(value) |
| Getter | get_pivot_offset() |
By default, the node's pivot is its top-left corner. When you change its rect_scale, it will scale around this pivot. Set this property to rect_size / 2 to center the pivot in the node's rectangle.
| Default | Vector2( 0, 0 ) |
| Getter | get_position() |
The node's position, relative to its parent. It corresponds to the rectangle's top-left corner. The property is not affected by rect_pivot_offset.
| Default | 0.0 |
| Setter | set_rotation_degrees(value) |
| Getter | get_rotation_degrees() |
The node's rotation around its pivot, in degrees. See rect_pivot_offset to change the pivot's position.
| Default | Vector2( 1, 1 ) |
| Setter | set_scale(value) |
| Getter | get_scale() |
The node's scale, relative to its rect_size. Change this property to scale the node around its rect_pivot_offset. The Control's hint_tooltip will also scale according to this value.
Note: This property is mainly intended to be used for animation purposes. Text inside the Control will look pixelated or blurry when the Control is scaled. To support multiple resolutions in your project, use an appropriate viewport stretch mode as described in the documentation instead of scaling Controls individually.
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 instanced. To set the Control's scale when it's instanced, wait for one frame using yield(get_tree(), "idle_frame") then set its rect_scale property.
| Default | Vector2( 0, 0 ) |
| Getter | get_size() |
The size of the node's bounding rectangle, in pixels. Container nodes update this property automatically.
| Default | 1 |
| Setter | set_h_size_flags(value) |
| Getter | get_h_size_flags() |
Tells the parent Container nodes how they should resize and place the node on the X axis. Use one of the SizeFlags constants to change the flags. See the constants to learn what each does.
| Default | 1.0 |
| Setter | set_stretch_ratio(value) |
| Getter | get_stretch_ratio() |
If the node and at least one of its neighbours 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 neighbour a ratio of 1, this node will take two thirds of the available space.
| Default | 1 |
| Setter | set_v_size_flags(value) |
| Getter | get_v_size_flags() |
Tells the parent Container nodes how they should resize and place the node on the Y axis. Use one of the SizeFlags constants to change the flags. See the constants to learn what each does.
| Setter | set_theme(value) |
| Getter | get_theme() |
Changing this property replaces the current Theme resource this node and all its Control children use.
Virtual method to be implemented by the user. Returns whether _gui_input should not be called for children controls outside this control's rectangle. Input will be clipped to the Rect of this Control. Similar to rect_clip_content, but doesn't affect visibility.
If not overridden, defaults to false.
Virtual method to be implemented by the user. Returns the minimum size for this control. Alternative to rect_min_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 Vector2.ZERO.
Virtual method to be implemented by the user. Use this method to process and accept inputs on UI elements. See accept_event.
Example: clicking a control.
func _gui_input(event):
if event is InputEventMouseButton:
if event.button_index == BUTTON_LEFT and event.pressed:
print("I've been clicked D:")
The event won't trigger if:
* clicking outside the control (see has_point);
* control has mouse_filter set to MOUSE_FILTER_IGNORE;
* control is obstructed by another Control on top of it, which doesn't have mouse_filter set to MOUSE_FILTER_IGNORE;
* control's parent has mouse_filter set to MOUSE_FILTER_STOP or has accepted the event;
* it happens outside parent's rectangle and the parent has either rect_clip_content or _clips_input enabled.
Virtual method to be implemented by the user. Returns a Control node that should be used as a tooltip instead of the default one. Use for_text parameter to determine what text the tooltip should contain (likely the contents of hint_tooltip).
The returned node must be of type Control or Control-derieved. It can have child nodes of any type. It is freed when the tooltip disappears, so make sure you always provide a new instance, not e.g. a node from scene. When null or non-Control node is returned, the default tooltip will be used instead.
Note: The tooltip is shrunk to minimal size. If you want to ensure it's fully visible, you might want to set its rect_min_size to some non-zero value.
Example of usage with custom-constructed node:
func _make_custom_tooltip(for_text):
var label = Label.new()
label.text = for_text
return label
Example of usage with custom scene instance:
func _make_custom_tooltip(for_text):
var tooltip = preload("SomeTooltipScene.tscn").instance()
tooltip.get_node("Label").text = for_text
return tooltip
Marks an input event as handled. Once you accept an input event, it stops propagating, even to nodes listening to Node._unhandled_input or Node._unhandled_key_input.
Overrides the Color with given name in the theme resource the control uses.
Note: Unlike other theme overrides, there is no way to undo a color override without manually assigning the previous color.
Example of overriding a label's color and resetting it later:
# Override the child node "MyLabel"'s font color to orange.
$MyLabel.add_color_override("font_color", Color(1, 0.5, 0))
# Reset the color by creating a new node to get the default value:
var default_label_color = Label.new().get_color("font_color")
$MyLabel.add_color_override("font_color", default_label_color)
Overrides an integer constant with given name in the theme resource the control uses. If the constant is 0, the override is cleared and the constant from assigned Theme is used.
Overrides the font with given name in the theme resource the control uses. If font is null or invalid, the override is cleared and the font from assigned Theme is used.
Overrides the icon with given name in the theme resource the control uses. If icon is null or invalid, the override is cleared and the icon from assigned Theme is used.
Overrides the Shader with given name in the theme resource the control uses. If shader is null or invalid, the override is cleared and the shader from assigned Theme is used.
Overrides the StyleBox with given name in the theme resource the control uses. If stylebox is empty or invalid, the override is cleared and the StyleBox from assigned Theme is used.
Example of modifying 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_stylebox("normal").duplicate()
new_stylebox_normal.border_width_top = 3
new_stylebox_normal.border_color = Color(0, 1, 0.5)
$MyButton.add_stylebox_override("normal", new_stylebox_normal)
# Remove the stylebox override:
$MyButton.add_stylebox_override("normal", null)
Godot calls this method to test if data from a control's get_drag_data can be dropped at position. position is local to this control.
This method should only be used to test the data. Process the data in drop_data.
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")
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 position where position is local to this control.
func can_drop_data(position, data):
return typeof(data) == TYPE_DICTIONARY and data.has("color")
func drop_data(position, data):
color = data["color"]
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.
Returns the anchor identified by margin constant from Margin enum. A getter method for anchor_bottom, anchor_left, anchor_right and anchor_top.
Returns margin_left and margin_top. See also rect_position.
Returns a color from assigned Theme with given name and associated with Control of given type.
func _ready():
modulate = get_color("font_color", "Button") #get the color defined for button fonts
Returns combined minimum size from rect_min_size and get_minimum_size.
Returns a constant from assigned Theme with given name and associated with Control of given type.
Returns the mouse cursor shape the control displays on mouse hover. See CursorShape.
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. 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.
func get_drag_data(position):
var mydata = make_data()
set_drag_preview(make_preview(mydata))
return mydata
Returns margin_right and margin_bottom.
Returns the focus neighbour identified by margin constant from Margin enum. A getter method for focus_neighbour_bottom, focus_neighbour_left, focus_neighbour_right and focus_neighbour_top.
Returns the control that has the keyboard focus or null if none.
Returns a font from assigned Theme with given name and associated with Control of given type.
Returns the position and size of the control relative to the top-left corner of the screen. See rect_position and rect_size.
Returns an icon from assigned Theme with given name and associated with Control of given type.
Returns the anchor identified by margin constant from Margin enum. A getter method for margin_bottom, margin_left, margin_right and margin_top.
Returns the minimum size for this control. See rect_min_size.
Returns the width/height occupied in the parent control.
Returns the parent control node.
Returns the position and size of the control relative to the top-left corner of the parent Control. See rect_position and rect_size.
Returns the rotation (in radians).
Returns a StyleBox from assigned Theme with given name and associated with Control of given type.
Returns the tooltip, which will appear when the cursor is resting over this control. See hint_tooltip.
Creates an InputEventMouseButton that attempts to click the control. If the event is received, the control acquires focus.
func _process(delta):
grab_click_focus() #when clicking another Control node, this node will be clicked instead
Steal the focus from another control and become the focused control (see focus_mode).
Returns true if Color with given name and associated with Control of given type exists in assigned Theme.
Returns true if Color with given name has a valid override in this Control node.
Returns true if constant with given name and associated with Control of given type exists in assigned Theme.
Returns true if constant with given name has a valid override in this Control node.
Returns true if this is the current focused control. See focus_mode.
Returns true if font with given name and associated with Control of given type exists in assigned Theme.
Returns true if font with given name has a valid override in this Control node.
Returns true if icon with given name and associated with Control of given type exists in assigned Theme.
Returns true if icon with given name has a valid override in this Control node.
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 get_rect().has_point(point).
Returns true if Shader with given name has a valid override in this Control node.
Returns true if StyleBox with given name and associated with Control of given type exists in assigned Theme.
Returns true if StyleBox with given name has a valid override in this Control node.
Invalidates the size cache in this node and in parent nodes up to toplevel. Intended to be used with get_minimum_size when the return value is changed. Setting rect_min_size directly calls this method automatically.
Give up the focus. No other control will be able to receive keyboard input.
Sets the anchor identified by margin constant from Margin enum to value anchor. A setter method for anchor_bottom, anchor_left, anchor_right and anchor_top.
If keep_margin is true, margins 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.
Works the same as set_anchor, but instead of keep_margin argument and automatic update of margin, it allows to set the margin offset yourself (see set_margin).
Sets both anchor preset and margin preset. See set_anchors_preset and set_margins_preset.
Sets the anchors to a preset from LayoutPreset enum. This is code equivalent of using the Layout menu in 2D editor.
If keep_margins is true, control's position will also be updated.
Sets margin_left and margin_top at the same time. Equivalent of changing rect_position.
Forwards the handling of this control's drag and drop to target control.
Forwarding can be implemented in the target control similar to the methods get_drag_data, can_drop_data, and drop_data but with two differences:
# ThisControl.gd
extends Control
func _ready():
set_drag_forwarding(target_control)
# TargetControl.gd
extends Control
func can_drop_data_fw(position, data, from_control):
return true
func drop_data_fw(position, data, from_control):
my_handle_data(data)
func get_drag_data_fw(position, from_control):
set_drag_preview(my_preview)
return my_data()
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.
export (Color, RGBA) 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.rect_size = Vector2(50, 50)
set_drag_preview(cpb)
return color
Sets margin_right and margin_bottom at the same time.
Sets the anchor identified by margin constant from Margin enum to Control at neighbor node path. A setter method for focus_neighbour_bottom, focus_neighbour_left, focus_neighbour_right and focus_neighbour_top.
Sets the rect_global_position to given position.
If keep_margins is true, control's anchors will be updated instead of margins.
Sets the margin identified by margin constant from Margin enum to given offset. A setter method for margin_bottom, margin_left, margin_right and margin_top.
Sets the margins to a preset from LayoutPreset enum. This is code equivalent of using the Layout menu in 2D editor.
Use parameter resize_mode with constants from 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.
Sets the rect_position to given position.
If keep_margins is true, control's anchors will be updated instead of margins.
Sets the rotation (in radians).
Sets the size (see rect_size).
If keep_margins is true, control's anchors will be updated instead of margins.
Displays a control as modal. Control must be a subwindow. Modal controls capture the input signals until closed or the area outside them is accessed. When a modal control loses focus, or the ESC key is pressed, they automatically hide. Modal controls are used extensively for popup dialogs and menus.
If exclusive is true, other controls will not receive input and clicking outside this control will not close it.
Moves the mouse cursor to to_position, relative to rect_position of this Control.
© 2014–2020 Juan Linietsky, Ariel Manzur, Godot Engine contributors
Licensed under the MIT License.
https://docs.godotengine.org/en/3.2/classes/class_control.html