VSeparator Methods

Virtual method to be implemented by the user. Returns whether _GuiInput(InputEvent) should not be called for children controls outside this control's rectangle. Input will be clipped to the Rect of this Control. Similar to RectClipContent, but doesn't affect visibility.

If not overridden, defaults to false.

Overridable function called by the engine (if defined) to draw the canvas item.

Called when the node enters the SceneTree (e.g. upon instancing, scene changing, or after calling AddChild(Node, Boolean) in a script). If the node has children, its _EnterTree callback will be called first, and then that of the children.

Corresponds to the notification in _Notification(Int32).

Called when the node is about to leave the SceneTree (e.g. upon freeing, scene changing, or after calling RemoveChild(Node) in a script). If the node has children, its _ExitTree callback will be called last, after all its children have left the tree.

Corresponds to the notification in _Notification(Int32) and signal tree_exiting. To get notified when the node has already left the active tree, connect to the tree_exited.

Virtual method which can be overridden to customize the return value of Get(String).

Returns the given property. Returns null if the property does not exist.

The string returned from this method is displayed as a warning in the Scene Dock if the script that overrides it is a tool script.

Returning an empty string produces no warning.

Call UpdateConfigurationWarning when the warning needs to be updated for this node.

Virtual method to be implemented by the user. Returns the minimum size for this control. Alternative to RectMinSize 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 .

Virtual method which can be overridden to customize the return value of GetPropertyList.

Returns the object's property list as an Array of dictionaries.

Each property's Dictionary must contain at least name: String and type: int (see VariantType) entries. Optionally, it can also include hint: int (see PropertyHint), hint_string: String, and usage: int (see PropertyUsageFlags).

Virtual method to be implemented by the user. Use this method to process and accept inputs on UI elements. See AcceptEvent.

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 HasPoint(Vector2));

* control has MouseFilter set to ;

* control is obstructed by another Control on top of it, which doesn't have MouseFilter set to ;

* control's parent has MouseFilter set to or has accepted the event;

* it happens outside parent's rectangle and the parent has either RectClipContent or _ClipsInput enabled.

Called when there is an input event. The input event propagates up through the node tree until a node consumes it.

It is only called if input processing is enabled, which is done automatically if this method is overridden, and can be toggled with SetProcessInput(Boolean).

To consume the input event and stop it propagating further to other nodes, SetInputAsHandled can be called.

For gameplay input, _UnhandledInput(InputEvent) and _UnhandledKeyInput(InputEventKey) are usually a better fit as they allow the GUI to intercept the events first.

Note: This method is only called if the node is present in the scene tree (i.e. if it's not orphan).

Virtual method to be implemented by the user. Returns a Control node that should be used as a tooltip instead of the default one. The for_text includes the contents of the HintTooltip property.

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 SetStylebox(String, String, StyleBox) for the type "TooltipPanel" (see HintTooltip 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 RectMinSize to some non-zero value.

Example of usage with a custom-constructed node:

func _make_custom_tooltip(for_text):
    var label = Label.new()
    label.text = for_text
    return label

Example of usage with a custom scene instance:

func _make_custom_tooltip(for_text):
    var tooltip = preload("res://SomeTooltipScene.tscn").instance()
    tooltip.get_node("Label").text = for_text
    return tooltip

Called whenever the object receives a notification, which is identified in what by a constant. The base Object has two constants and , but subclasses such as Node define a lot more notifications which are also received by this method.

Called during the physics processing step of the main loop. Physics processing means that the frame rate is synced to the physics, i.e. the delta variable should be constant. delta is in seconds.

It is only called if physics processing is enabled, which is done automatically if this method is overridden, and can be toggled with SetPhysicsProcess(Boolean).

Corresponds to the notification in _Notification(Int32).

Note: This method is only called if the node is present in the scene tree (i.e. if it's not orphan).

Called during the processing step of the main loop. Processing happens at every frame and as fast as possible, so the delta time since the previous frame is not constant. delta is in seconds.

It is only called if processing is enabled, which is done automatically if this method is overridden, and can be toggled with SetProcess(Boolean).

Corresponds to the notification in _Notification(Int32).

Note: This method is only called if the node is present in the scene tree (i.e. if it's not orphan).

Called when the node is "ready", i.e. when both the node and its children have entered the scene tree. If the node has children, their _Ready callbacks get triggered first, and the parent node will receive the ready notification afterwards.

Corresponds to the notification in _Notification(Int32). See also the onready keyword for variables.

Usually used for initialization. For even earlier initialization, may be used. See also _EnterTree.

Note: _Ready may be called only once for each node. After removing a node from the scene tree and adding again, _ready will not be called for the second time. This can be bypassed with requesting another call with RequestReady, which may be called anywhere before adding the node again.

Virtual method which can be overridden to customize the return value of Set(String, Object).

Sets a property. Returns true if the property exists.

Called when an InputEvent hasn't been consumed by _Input(InputEvent) or any GUI. The input event propagates up through the node tree until a node consumes it.

It is only called if unhandled input processing is enabled, which is done automatically if this method is overridden, and can be toggled with SetProcessUnhandledInput(Boolean).

To consume the input event and stop it propagating further to other nodes, SetInputAsHandled can be called.

For gameplay input, this and _UnhandledKeyInput(InputEventKey) are usually a better fit than _Input(InputEvent) as they allow the GUI to intercept the events first.

Note: This method is only called if the node is present in the scene tree (i.e. if it's not orphan).

Called when an InputEventKey hasn't been consumed by _Input(InputEvent) or any GUI. The input event propagates up through the node tree until a node consumes it.

It is only called if unhandled key input processing is enabled, which is done automatically if this method is overridden, and can be toggled with SetProcessUnhandledKeyInput(Boolean).

To consume the input event and stop it propagating further to other nodes, SetInputAsHandled can be called.

For gameplay input, this and _UnhandledInput(InputEvent) are usually a better fit than _Input(InputEvent) as they allow the GUI to intercept the events first.

Note: This method is only called if the node is present in the scene tree (i.e. if it's not orphan).

Marks an input event as handled. Once you accept an input event, it stops propagating, even to nodes listening to _UnhandledInput(InputEvent) or _UnhandledKeyInput(InputEventKey).

Adds a child node. Nodes can have any number of children, but every child must have a unique name. Child nodes are automatically deleted when the parent node is deleted, so an entire scene can be removed by deleting its topmost node.

If legible_unique_name is true, the child node will have a human-readable name based on the name of the node being instanced instead of its type.

Note: If the child node already has a parent, the function will fail. Use RemoveChild(Node) first to remove the node from its current parent. For example:

if child_node.get_parent():
    child_node.get_parent().remove_child(child_node)
add_child(child_node)

Note: If you want a child to be persisted to a PackedScene, you must set Owner in addition to calling AddChild(Node, Boolean). This is typically relevant for tool scripts and editor plugins. If AddChild(Node, Boolean) is called without setting Owner, the newly added Node will not be visible in the scene tree, though it will be visible in the 2D/3D view.

Adds child_node as a child. The child is placed below the given node in the list of children.

If legible_unique_name is true, the child node will have a human-readable name based on the name of the node being instanced instead of its type.

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)

Adds the node to a group. Groups are helpers to name and organize a subset of nodes, for example "enemies" or "collectables". A node can be in any number of groups. Nodes can be assigned a group at any time, but will not be added until they are inside the scene tree (see IsInsideTree). See notes in the description, and the group methods in SceneTree.

The persistent option is used when packing node to PackedScene and saving to file. Non-persistent groups aren't stored.

Adds a user-defined signal. Arguments are optional, but can be added as an Array of dictionaries, each containing name: String and type: int (see VariantType) entries.

Calls the method on the object and returns the result. This method supports a variable number of arguments, so parameters are passed as a comma separated list. Example:

call("set", "position", Vector2(42.0, 0.0))

Note: In C#, the method name must be specified as snake_case if it is defined by a built-in Godot node. This doesn't apply to user-defined methods where you should use the same convention as in the C# source (typically PascalCase).

Calls the method on the object during idle time. This method supports a variable number of arguments, so parameters are passed as a comma separated list. Example:

call_deferred("set", "position", Vector2(42.0, 0.0))

Note: In C#, the method name must be specified as snake_case if it is defined by a built-in Godot node. This doesn't apply to user-defined methods where you should use the same convention as in the C# source (typically PascalCase).

Calls the method on the object and returns the result. Contrarily to Call(String, Object), this method does not support a variable number of arguments but expects all parameters to be via a single Array.

callv("set", [ "position", Vector2(42.0, 0.0) ])

Godot calls this method to test if data from a control's GetDragData(Vector2) 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 DropData(Vector2, Object).

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")

Returns true if the node can process while the scene tree is paused (see PauseMode). Always returns true if the scene tree is not paused, and false if the node is not in the tree.

Returns true if the object can translate strings. See SetMessageTranslation(Boolean) and Tr(String).

Connects a signal to a method on a target object. Pass optional binds to the call as an Array of parameters. These parameters will be passed to the method after any parameter used in the call to EmitSignal(String, Object). Use flags to set deferred or one-shot connections. See ObjectConnectFlags constants.

A signal can only be connected once to a method. It will throw an error if already connected, unless the signal was connected with . To avoid this, first, use IsConnected(String, Object, String) to check for existing connections.

If the target is destroyed in the game's lifecycle, the connection will be lost.

Examples:

connect("pressed", self, "_on_Button_pressed") # BaseButton signal
connect("text_entered", self, "_on_LineEdit_text_entered") # LineEdit signal
connect("hit", self, "_on_Player_hit", [ weapon_type, damage ]) # User-defined signal

An example of the relationship between binds passed to Connect(String, Object, String, Array, UInt32) and parameters used when calling EmitSignal(String, Object):

connect("hit", self, "_on_Player_hit", [ weapon_type, damage ]) # weapon_type and damage are passed last
emit_signal("hit", "Dark lord", 5) # "Dark lord" and 5 are passed first
func _on_Player_hit(hit_by, level, weapon_type, damage):
    print("Hit by %s (lvl %d) with weapon %s for %d damage" % [hit_by, level, weapon_type, damage])

Disconnects a signal from a method on the given target.

If you try to disconnect a connection that does not exist, the method will throw an error. Use IsConnected(String, Object, String) to ensure that the connection exists.

Draws an arc between the given angles. The larger the value of point_count, the smoother the curve.

Draws a string character using a custom font. Returns the advance, depending on the character width and kerning with an optional next character.

Draws a colored circle.

Draws a colored polygon of any amount of points, convex or concave.

Draws a line from a 2D point to another, with a given color and width. It can be optionally antialiased.

Draws a Mesh in 2D, using the provided texture. See MeshInstance2D for related documentation.

Draws multiple, parallel lines with a uniform color.

Note: width and antialiased are currently not implemented and have no effect.

Draws multiple, parallel lines with a uniform width and segment-by-segment coloring. Colors assigned to line segments match by index between points and colors.

Note: width and antialiased are currently not implemented and have no effect.

Draws a MultiMesh in 2D with the provided texture. See MultiMeshInstance2D for related documentation.

Draws a polygon of any amount of points, convex or concave.

Draws interconnected line segments with a uniform color and width and optional antialiasing.

Draws interconnected line segments with a uniform width, segment-by-segment coloring, and optional antialiasing. Colors assigned to line segments match by index between points and colors.

Draws a custom primitive. 1 point for a point, 2 points for a line, 3 points for a triangle and 4 points for a quad.

Draws a rectangle. If filled is true, the rectangle will be filled with the color specified. If filled is false, the rectangle will be drawn as a stroke with the color and width specified. If antialiased is true, the lines will be antialiased.

Note: width and antialiased are only effective if filled is false.

Sets a custom transform for drawing via components. Anything drawn afterwards will be transformed by this.

Sets a custom transform for drawing via matrix. Anything drawn afterwards will be transformed by this.

Draws text using the specified font at the position (bottom-left corner using the baseline of the font). The text will have its color multiplied by modulate. If clip_w is greater than or equal to 0, the text will be clipped if it exceeds the specified width.

Example using the default project font:

# If using this method in a script that redraws constantly, move the
# `default_font` declaration to a member variable assigned in `_ready()`
# so the Control is only created once.
var default_font = Control.new().get_font("font")
draw_string(default_font, Vector2(64, 64), "Hello world")

See also Draw(RID, Vector2, String, NullableColor, Int32, NullableColor).

Draws a styled rectangle.

Draws a texture at a given position.

Draws a textured rectangle at a given position, optionally modulated by a color. If transpose is true, the texture will have its X and Y coordinates swapped.

Draws a textured rectangle region at a given position, optionally modulated by a color. If transpose is true, the texture will have its X and Y coordinates swapped.

Godot calls this method to pass you the data from a control's GetDragData(Vector2) result. Godot first calls CanDropData(Vector2, Object) 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"]

Duplicates the node, returning a new node.

You can fine-tune the behavior using the flags (see NodeDuplicateFlags).

Note: It will not work properly if the node contains a script with constructor arguments (i.e. needs to supply arguments to method). In that case, the node will be duplicated without a script.

Emits the given signal. The signal must exist, so it should be a built-in signal of this class or one of its parent classes, or a user-defined signal. This method supports a variable number of arguments, so parameters are passed as a comma separated list. Example:

emit_signal("hit", weapon_type, damage)
emit_signal("game_over")

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

Finds a descendant of this node whose name matches mask as in String.match (i.e. case-sensitive, but "*" matches zero or more characters and "?" matches any single character except ".").

Note: It does not match against the full path, just against individual node names.

If owned is true, this method only finds nodes whose owner is this node. This is especially important for scenes instantiated through a script, because those scenes don't have an owner.

Note: As this method walks through all the descendants of the node, it is the slowest way to get a reference to another node. Whenever possible, consider using GetNode(NodePath) instead. To avoid using FindNode(String, Boolean, Boolean) too often, consider caching the node reference into a variable.

Finds the first parent of the current node whose name matches mask as in String.match (i.e. case-sensitive, but "*" matches zero or more characters and "?" matches any single character except ".").

Note: It does not match against the full path, just against individual node names.

Note: As this method walks upwards in the scene tree, it can be slow in large, deeply nested scene trees. Whenever possible, consider using GetNode(NodePath) instead. To avoid using FindParent(String) too often, consider caching the node reference into a variable.

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

Forces drag and bypasses GetDragData(Vector2) and SetDragPreview(Control) by passing data and preview. Drag will start even if the mouse is neither over nor pressed on this control.

The methods CanDropData(Vector2, Object) and DropData(Vector2, Object) must be implemented on controls that want to receive drop data.

Forces the transform to update. Transform changes in physics are not instant for performance reasons. Transforms are accumulated and then set. Use this if you need an up-to-date transform when doing physics operations.

Deletes the object from memory immediately. For Nodes, you may want to use QueueFree to queue the node for safe deletion at the end of the current frame.

Important: If you have a variable pointing to an object, it will not be assigned to null once the object is freed. Instead, it will point to a previously freed instance and you should validate it with @GDScript.is_instance_valid before attempting to call its methods or access its properties.

Returns the Variant value of the given property. If the property doesn't exist, this will return null.

Note: In C#, the property name must be specified as snake_case if it is defined by a built-in Godot node. This doesn't apply to user-defined properties where you should use the same convention as in the C# source (typically PascalCase).

Returns the anchor identified by margin constant from Margin enum. A getter method for AnchorBottom, AnchorLeft, AnchorRight and AnchorTop.

Returns MarginLeft and MarginTop. See also RectPosition.

Returns the RID of the World2D canvas where this item is in.

Returns the canvas item RID used by VisualServer for this item.

Returns the transform matrix of this item's canvas.

Returns the number of child nodes.

Returns an array of references to node's children.

Returns the object's class as a String.

Returns a color from assigned Theme with given name and associated with Control of given node_type.

func _ready():
    modulate = get_color("font_color", "Button") #get the color defined for button fonts

Returns combined minimum size from RectMinSize and GetMinimumSize.

Returns a constant from assigned Theme with given name and associated with Control of given node_type.

Returns the mouse cursor shape the control displays on mouse hover. See ControlCursorShape.

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 CanDropData(Vector2, Object) and DropData(Vector2, Object). position is local to this control. Drag may be forced with ForceDrag(Object, Control).

A preview that will follow the mouse that should represent the data can be set with SetDragPreview(Control). 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 MarginRight and MarginBottom.

Returns the focus neighbour identified by margin constant from Margin enum. A getter method for FocusNeighbourBottom, FocusNeighbourLeft, FocusNeighbourRight and FocusNeighbourTop.

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 node_type.

Returns the global position of the mouse.

Returns the position and size of the control relative to the top-left corner of the screen. See RectPosition and RectSize.

Returns the global transform matrix of this item.

Returns the global transform matrix of this item in relation to the canvas.

Returns an array listing the groups that the node is a member of.

Returns an icon from assigned Theme with given name and associated with Control of given node_type.

Returns an Array of dictionaries with information about signals that are connected to the object.

Each Dictionary contains three String entries:

- source is a reference to the signal emitter.

- signal_name is the name of the connected signal.

- method_name is the name of the method to which the signal is connected.

Returns the node's index, i.e. its position among the siblings of its parent.

Gets the object's property indexed by the given NodePath. The node path should be relative to the current object and can use the colon character (:) to access nested properties. Examples: "position:x" or "material:next_pass:blend_mode".

Returns the object's unique instance ID.

This ID can be saved in EncodedObjectAsID, and can be used to retrieve the object instance with @GDScript.instance_from_id.

Returns the mouse position relative to this item's position.

Returns the anchor identified by margin constant from Margin enum. A getter method for MarginBottom, MarginLeft, MarginRight and MarginTop.

Returns the object's metadata entry for the given name.

Returns the object's metadata as a String.

Returns the object's methods and their signatures as an Array.

Returns the minimum size for this control. See RectMinSize.

Returns the peer ID of the network master for this node. See SetNetworkMaster(Int32, Boolean).

Fetches a node and one of its resources as specified by the NodePath's subname (e.g. Area2D/CollisionShape2D:shape). If several nested resources are specified in the NodePath, the last one will be fetched.

The return value is an array of size 3: the first index points to the Node (or null if not found), the second index points to the Resource (or null if not found), and the third index is the remaining NodePath, if any.

For example, assuming that Area2D/CollisionShape2D is a valid node and that its shape property has been assigned a RectangleShape2D resource, one could have this kind of output:

print(get_node_and_resource("Area2D/CollisionShape2D")) # [[CollisionShape2D:1161], Null, ]
print(get_node_and_resource("Area2D/CollisionShape2D:shape")) # [[CollisionShape2D:1161], [RectangleShape2D:1156], ]
print(get_node_and_resource("Area2D/CollisionShape2D:shape:extents")) # [[CollisionShape2D:1161], [RectangleShape2D:1156], :extents]

Returns the width/height occupied in the parent control.

Returns the parent control node.

Returns the absolute path of the current node. This only works if the current node is inside the scene tree (see IsInsideTree).

Returns the relative NodePath from this node to the specified node. Both nodes must be in the same scene or the function will fail.

Returns the time elapsed (in seconds) since the last physics-bound frame (see _PhysicsProcess(Single)). This is always a constant value in physics processing unless the frames per second is changed via IterationsPerSecond.

Returns the node's order in the scene tree branch. For example, if called on the first child node the position is 0.

Returns the time elapsed (in seconds) since the last process callback. This value may vary from frame to frame.

Returns the object's property list as an Array of dictionaries.

Each property's Dictionary contain at least name: String and type: int (see VariantType) entries. Optionally, it can also include hint: int (see PropertyHint), hint_string: String, and usage: int (see PropertyUsageFlags).

Returns the position and size of the control relative to the top-left corner of the parent Control. See RectPosition and RectSize.

Returns the rotation (in radians).

Returns true if this is an instance load placeholder. See InstancePlaceholder.

Returns the object's Script instance, or null if none is assigned.

Returns an Array of connections for the given signal.

Returns the list of signals as an Array of dictionaries.

Returns a StyleBox from assigned Theme with given name and associated with Control of given node_type.

Returns the tooltip, which will appear when the cursor is resting over this control. See HintTooltip.

Returns the transform matrix of this item.

Returns the SceneTree that contains this node.

Returns the node's Viewport.

Returns the viewport's boundaries as a Rect2.

Returns this item's transform in relation to the viewport.

Returns the World2D where this item is in.

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 FocusMode).

Returns true if Color with given name and associated with Control of given node_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 node_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 FocusMode.

Returns true if font with given name and associated with Control of given node_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 node_type exists in assigned Theme.

Returns true if icon with given name has a valid override in this Control node.

Returns true if a metadata entry is found with the given name.

Returns true if the object contains the given method.

Returns true if the node that the NodePath points to exists.

Returns true if the NodePath points to a valid node and its subname points to a valid resource, e.g. Area2D/CollisionShape2D:shape. Properties with a non-Resource type (e.g. nodes or primitive math types) are not considered resources.

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 the given signal exists.

Returns true if StyleBox with given name and associated with Control of given node_type exists in assigned Theme.

Returns true if StyleBox with given name has a valid override in this Control node.

Returns true if the given user-defined signal exists. Only signals added using AddUserSignal(String, Array) are taken into account.

Hide the CanvasItem if it's currently visible.

Returns true if the given node is a direct or indirect child of the current node.

Returns true if signal emission blocking is enabled.

Returns true if the object inherits from the given class.

Returns true if a connection exists for a given signal, target, and method.

Returns true if the node is folded (collapsed) in the Scene dock.

Returns true if the given node occurs later in the scene hierarchy than the current node.

Returns true if this node is in the specified group. See notes in the description, and the group methods in SceneTree.

Returns true if this node is currently inside a SceneTree.

Returns true if local transform notifications are communicated to children.

Returns true if the local system is the master of this node.

Returns true if physics processing is enabled (see SetPhysicsProcess(Boolean)).

Returns true if internal physics processing is enabled (see SetPhysicsProcessInternal(Boolean)).

Returns true if processing is enabled (see SetProcess(Boolean)).

Returns true if the node is processing input (see SetProcessInput(Boolean)).

Returns true if internal processing is enabled (see SetProcessInternal(Boolean)).

Returns true if the node is processing unhandled input (see SetProcessUnhandledInput(Boolean)).

Returns true if the node is processing unhandled key input (see SetProcessUnhandledKeyInput(Boolean)).

Returns true if the QueueFree method was called for the object.

Returns true if the node is set as top-level. See SetAsToplevel(Boolean).

Returns true if global transform notifications are communicated to children.

Returns true if the node is present in the SceneTree, its Visible property is true and all its antecedents are also visible. If any antecedent is hidden, this node will not be visible in the scene tree.

Assigns screen_point as this node's new local transform.

Transformations issued by event's inputs are applied in local space instead of global space.

Invalidates the size cache in this node and in parent nodes up to toplevel. Intended to be used with GetMinimumSize when the return value is changed. Setting RectMinSize directly calls this method automatically.

Moves a child node to a different position (order) among the other children. Since calls, signals, etc are performed by tree order, changing the order of children nodes may be useful.

Send a given notification to the object, which will also trigger a call to the _Notification(Int32) method of all classes that the object inherits from.

If reversed is true, _Notification(Int32) is called first on the object's own class, and then up to its successive parent classes. If reversed is false, _Notification(Int32) is called first on the highest ancestor (Object itself), and then down to its successive inheriting classes.

Prints all stray nodes (nodes outside the SceneTree). Used for debugging. Works only in debug builds.

Prints the tree to stdout. Used mainly for debugging purposes. This version displays the path relative to the current node, and is good for copy/pasting into the GetNode(NodePath) function.

Example output:

TheGame
TheGame/Menu
TheGame/Menu/Label
TheGame/Menu/Camera2D
TheGame/SplashScreen
TheGame/SplashScreen/Camera2D

Similar to PrintTree, this prints the tree to stdout. This version displays a more graphical representation similar to what is displayed in the scene inspector. It is useful for inspecting larger trees.

Example output:

┖╴TheGame
   ┠╴Menu
   ┃  ┠╴Label
   ┃  ┖╴Camera2D
   ┖╴SplashScreen
      ┖╴Camera2D

Calls the given method (if present) with the arguments given in args on this node and recursively on all its children. If the parent_first argument is true, the method will be called on the current node first, then on all its children. If parent_first is false, the children will be called first.

Notifies the current node and all its children recursively by calling Notification(Int32, Boolean) on all of them.

Notify the editor that the property list has changed, so that editor plugins can take the new values into account. Does nothing on export builds.

Queues a node for deletion at the end of the current frame. When deleted, all of its child nodes will be deleted as well. This method ensures it's safe to delete the node, contrary to Free. Use IsQueuedForDeletion to check whether a node will be deleted at the end of the frame.

Important: If you have a variable pointing to a node, it will not be assigned to null once the node is freed. Instead, it will point to a previously freed instance and you should validate it with @GDScript.is_instance_valid before attempting to call its methods or access its properties.

Moves this node to the bottom of parent node's children hierarchy. This is often useful in GUIs (Control nodes), because their order of drawing depends on their order in the tree. The top Node is drawn first, then any siblings below the top Node in the hierarchy are successively drawn on top of it. After using raise, a Control will be drawn on top of its siblings.

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

Removes a node and sets all its children as children of the parent node (if it exists). All event subscriptions that pass by the removed node will be unsubscribed.

Removes a child node. The node is NOT deleted and must be deleted manually.

Removes a node from a group. See notes in the description, and the group methods in SceneTree.

Removes a given entry from the object's metadata. See also SetMeta(String, Object).

Replaces a node in a scene by the given one. Subscriptions that pass through this node will be lost.

Requests that _ready be called again. Note that the method won't be called immediately, but is scheduled for when the node is added to the scene tree again (see _Ready). _ready is called only for the node which requested it, which means that you need to request ready for each child if you want them to call _ready too (in which case, _ready will be called in the same order as it would normally).

Sends a remote procedure call request for the given method to peers on the network (and locally), optionally sending all additional arguments as arguments to the method called by the RPC. The call request will only be received by nodes with the same NodePath, including the exact same node name. Behaviour depends on the RPC configuration for the given method, see RpcConfig(String, MultiplayerAPIRPCMode). Methods are not exposed to RPCs by default. See also Rset(String, Object) and RsetConfig(String, MultiplayerAPIRPCMode) for properties. Returns an empty Variant.

Note: You can only safely use RPCs on clients after you received the connected_to_server signal from the SceneTree. You also need to keep track of the connection state, either by the SceneTree signals like server_disconnected or by checking SceneTree.network_peer.get_connection_status() == CONNECTION_CONNECTED.

Changes the RPC mode for the given method to the given mode. See MultiplayerAPIRPCMode. An alternative is annotating methods and properties with the corresponding keywords (remote, master, puppet, remotesync, mastersync, puppetsync). By default, methods are not exposed to networking (and RPCs). See also Rset(String, Object) and RsetConfig(String, MultiplayerAPIRPCMode) for properties.

Sends a Rpc(String, Object) to a specific peer identified by peer_id (see SetTargetPeer(Int32)). Returns an empty Variant.

Sends a Rpc(String, Object) using an unreliable protocol. Returns an empty Variant.

Sends a Rpc(String, Object) to a specific peer identified by peer_id using an unreliable protocol (see SetTargetPeer(Int32)). Returns an empty Variant.

Remotely changes a property's value on other peers (and locally). Behaviour depends on the RPC configuration for the given property, see RsetConfig(String, MultiplayerAPIRPCMode). See also Rpc(String, Object) for RPCs for methods, most information applies to this method as well.

Changes the RPC mode for the given property to the given mode. See MultiplayerAPIRPCMode. An alternative is annotating methods and properties with the corresponding keywords (remote, master, puppet, remotesync, mastersync, puppetsync). By default, properties are not exposed to networking (and RPCs). See also Rpc(String, Object) and RpcConfig(String, MultiplayerAPIRPCMode) for methods.

Remotely changes the property's value on a specific peer identified by peer_id (see SetTargetPeer(Int32)).

Remotely changes the property's value on other peers (and locally) using an unreliable protocol.

Remotely changes property's value on a specific peer identified by peer_id using an unreliable protocol (see SetTargetPeer(Int32)).

Assigns a new value to the given property. If the property does not exist, nothing will happen.

Note: In C#, the property name must be specified as snake_case if it is defined by a built-in Godot node. This doesn't apply to user-defined properties where you should use the same convention as in the C# source (typically PascalCase).

Sets the anchor identified by margin constant from Margin enum to value anchor. A setter method for AnchorBottom, AnchorLeft, AnchorRight and AnchorTop.

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 SetAnchor(Margin, Single, Boolean, Boolean), but instead of keep_margin argument and automatic update of margin, it allows to set the margin offset yourself (see SetMargin(Margin, Single)).

Sets both anchor preset and margin preset. See SetAnchorsPreset(ControlLayoutPreset, Boolean) and SetMarginsPreset(ControlLayoutPreset, ControlLayoutPresetMode, Int32).

Sets the anchors to a preset from ControlLayoutPreset 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.

If enable is true, the node won't inherit its transform from parent canvas items.

Sets MarginLeft and MarginTop at the same time. Equivalent of changing RectPosition.

If set to true, signal emission is blocked.

Assigns a new value to the given property, after the current frame's physics step. This is equivalent to calling Set(String, Object) via CallDeferred(String, Object), i.e. call_deferred("set", property, value).

Note: In C#, the property name must be specified as snake_case if it is defined by a built-in Godot node. This doesn't apply to user-defined properties where you should use the same convention as in the C# source (typically PascalCase).

Sets the folded state of the node in the Scene dock.

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 GetDragData(Vector2), CanDropData(Vector2, Object), and DropData(Vector2, Object) but with two differences:

1. The function name must be suffixed with _fw

2. The function must take an extra argument that is the control doing the forwarding

# 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 GetDragData(Vector2). 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 (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 MarginRight and MarginBottom at the same time.

Sets the anchor identified by margin constant from Margin enum to Control at neighbor node path. A setter method for FocusNeighbourBottom, FocusNeighbourLeft, FocusNeighbourRight and FocusNeighbourTop.

Sets the RectGlobalPosition to given position.

If keep_margins is true, control's anchors will be updated instead of margins.

Assigns a new value to the property identified by the NodePath. The node path should be relative to the current object and can use the colon character (:) to access nested properties. Example:

set_indexed("position", Vector2(42, 0))
set_indexed("position:y", -10)
print(position) # (42, -10)

Sets the margin identified by margin constant from Margin enum to given offset. A setter method for MarginBottom, MarginLeft, MarginRight and MarginTop.

Sets the margins to a preset from ControlLayoutPreset enum. This is code equivalent of using the Layout menu in 2D editor.

Use parameter resize_mode with constants from ControlLayoutPresetMode 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.

Defines whether the object can translate strings (with calls to Tr(String)). Enabled by default.

Adds, changes or removes a given entry in the object's metadata. Metadata are serialized and can take any Variant value.

To remove a given entry from the object's metadata, use RemoveMeta(String). Metadata is also removed if its value is set to null. This means you can also use set_meta("name", null) to remove metadata for "name".

Sets the node's network master to the peer with the given peer ID. The network master is the peer that has authority over the node on the network. Useful in conjunction with the master and puppet keywords. Inherited from the parent node by default, which ultimately defaults to peer ID 1 (the server). If recursive, the given peer is recursively set as the master for all children of this node.

If enable is true, children will be updated with local transform data.

If enable is true, children will be updated with global transform data.

Enables or disables physics (i.e. fixed framerate) processing. When a node is being processed, it will receive a at a fixed (usually 60 FPS, see IterationsPerSecond to change) interval (and the _PhysicsProcess(Single) callback will be called if exists). Enabled automatically if _PhysicsProcess(Single) is overridden. Any calls to this before _Ready will be ignored.

Enables or disables internal physics for this node. Internal physics processing happens in isolation from the normal _PhysicsProcess(Single) calls and is used by some nodes internally to guarantee proper functioning even if the node is paused or physics processing is disabled for scripting (SetPhysicsProcess(Boolean)). Only useful for advanced uses to manipulate built-in nodes' behavior.

Warning: Built-in Nodes rely on the internal processing for their own logic, so changing this value from your code may lead to unexpected behavior. Script access to this internal logic is provided for specific advanced uses, but is unsafe and not supported.

Sets the RectPosition to given position.

If keep_margins is true, control's anchors will be updated instead of margins.

Enables or disables processing. When a node is being processed, it will receive a on every drawn frame (and the _Process(Single) callback will be called if exists). Enabled automatically if _Process(Single) is overridden. Any calls to this before _Ready will be ignored.

Enables or disables input processing. This is not required for GUI controls! Enabled automatically if _Input(InputEvent) is overridden. Any calls to this before _Ready will be ignored.

Enables or disabled internal processing for this node. Internal processing happens in isolation from the normal _Process(Single) calls and is used by some nodes internally to guarantee proper functioning even if the node is paused or processing is disabled for scripting (SetProcess(Boolean)). Only useful for advanced uses to manipulate built-in nodes' behavior.

Warning: Built-in Nodes rely on the internal processing for their own logic, so changing this value from your code may lead to unexpected behavior. Script access to this internal logic is provided for specific advanced uses, but is unsafe and not supported.

Enables unhandled input processing. This is not required for GUI controls! It enables the node to receive all input that was not previously handled (usually by a Control). Enabled automatically if _UnhandledInput(InputEvent) is overridden. Any calls to this before _Ready will be ignored.

Enables unhandled key input processing. Enabled automatically if _UnhandledKeyInput(InputEventKey) is overridden. Any calls to this before _Ready will be ignored.

Sets the rotation (in radians).

Sets whether this is an instance load placeholder. See InstancePlaceholder.

Assigns a script to the object. Each object can have a single script assigned to it, which are used to extend its functionality.

If the object already had a script, the previous script instance will be freed and its variables and state will be lost. The new script's method will be called.

Sets the size (see RectSize).

If keep_margins is true, control's anchors will be updated instead of margins.

Show the CanvasItem if it's currently hidden. For controls that inherit Popup, the correct way to make them visible is to call one of the multiple popup*() functions instead.

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.

Translates a message using translation catalogs configured in the Project Settings.

Only works if message translation is enabled (which it is by default), otherwise it returns the message unchanged. See SetMessageTranslation(Boolean).

Queue the CanvasItem for update. will be called on idle time to request redraw.

Updates the warning displayed for this node in the Scene Dock.

Use _GetConfigurationWarning to setup the warning message to display.

Moves the mouse cursor to to_position, relative to RectPosition of this Control.