Struct GraphNode

Source

pub struct GraphNode { /* private fields */ }

Expand description

core class GraphNode inherits Container (unsafe).

§Official documentation

See the documentation of this class in the Godot engine’s official documentation. The method descriptions are generated from it and typically contain code samples in GDScript, not Rust.

§Memory management

Non reference counted objects such as the ones of this type are usually owned by the engine.

GraphNode is a reference-only type. Persistent references can only exist in the unsafe Ref<GraphNode> form.

In the cases where Rust code owns an object of this type, for example if the object was just created on the Rust side and not passed to the engine yet, ownership should be either given to the engine or the object must be manually destroyed using Ref::free, or Ref::queue_free if it is a Node.

§Class hierarchy

GraphNode inherits methods from:

§Safety

All types in the Godot API have “interior mutability” in Rust parlance. To enforce that the official thread-safety guidelines are followed, the typestate pattern is used in the Ref and TRef smart pointers, and the Instance API. The typestate Access in these types tracks whether the access is unique, shared, or exclusive to the current thread. For more information, see the type-level documentation on Ref.

Implementations§

Source §

impl GraphNode

Constants

Source

pub fn new() -> Ref<Self, Unique>

Creates a new instance of this object.

Because this type is not reference counted, the lifetime of the returned object is not automatically managed.

Sets properties of the slot with ID idx. If enable_left/right, a port will appear and the slot will be able to be connected from this side. type_left/right is an arbitrary type of the port. Only ports with the same type values can be connected. color_left/right is the tint of the port’s icon on this side. custom_left/right is a custom texture for this side’s port. Note: This method only sets properties of the slot. To create the slot, add a Control-derived child to the GraphNode.

§Default Arguments

custom_left - null
custom_right - null

Source

pub fn set_title(&self, title: impl Into<GodotString>)

The text displayed in the GraphNode’s title bar.

Methods from Deref<Target = Container>§

Source

pub const NOTIFICATION_SORT_CHILDREN: i64 = 50i64

Source

pub fn fit_child_in_rect(&self, child: impl AsArg<Control>, rect: Rect2)

Fit a child control in a given rect. This is mainly a helper for creating custom container classes.

pub fn add_color_override(&self, name: impl Into<GodotString>, color: Color)

Sample code is GDScript unless otherwise noted.

Overrides the Color with given name in the [member 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)

pub fn find_next_valid_focus(&self) -> Option<Ref<Control, Shared>>

Source

pub fn find_prev_valid_focus(&self) -> Option<Ref<Control, Shared>>

Source

pub fn force_drag( &self, data: impl OwnedToVariant, preview: impl AsArg<Control>, )

Forces drag and bypasses [method get_drag_data] and [method 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 [method can_drop_data] and [method drop_data] must be implemented on controls that want to receive drop data.

Source

pub fn anchor(&self, margin: i64) -> f64

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 [enum Anchor] constants for convenience.

Source

pub fn get_begin(&self) -> Vector2

Returns [member margin_left] and [member margin_top]. See also [member rect_position].

Source

pub fn get_color( &self, name: impl Into<GodotString>, node_type: impl Into<GodotString>, ) -> Color

Sample code is GDScript unless otherwise noted.

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

§Default Arguments

type - ""

Returns a font from assigned Theme with given name and associated with Control of given type.

§Default Arguments

type - ""

Source

pub fn global_position(&self) -> Vector2

The node’s global position, relative to the world (usually to the top-left corner of the window).

Source

pub fn get_global_rect(&self) -> Rect2

Returns the position and size of the control relative to the top-left corner of the screen. See [member rect_position] and [member rect_size].

Source

pub fn h_grow_direction(&self) -> GrowDirection

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.

Source

pub fn h_size_flags(&self) -> i64

Tells the parent Container nodes how they should resize and place the node on the X axis. Use one of the [enum SizeFlags] constants to change the flags. See the constants to learn what each does.

Source

pub fn get_icon( &self, name: impl Into<GodotString>, node_type: impl Into<GodotString>, ) -> Option<Ref<Texture, Shared>>

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

§Default Arguments

type - ""

pub fn get_stylebox( &self, name: impl Into<GodotString>, node_type: impl Into<GodotString>, ) -> Option<Ref<StyleBox, Shared>>

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

§Default Arguments

type - ""

Source

pub fn theme(&self) -> Option<Ref<Theme, Shared>>

Changing this property replaces the current Theme resource this node and all its Control children use.

Returns the tooltip, which will appear when the cursor is resting over this control. See [member hint_tooltip].

§Default Arguments

at_position - Vector2( 0, 0 )

Source

pub fn v_grow_direction(&self) -> GrowDirection

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.

Source

pub fn v_size_flags(&self) -> i64

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

Source

pub fn grab_click_focus(&self)

Sample code is GDScript unless otherwise noted.

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

Source

pub fn grab_focus(&self)

Steal the focus from another control and become the focused control (see [member focus_mode]).

Source

pub fn has_color( &self, name: impl Into<GodotString>, node_type: impl Into<GodotString>, ) -> bool

Returns true if Color with given name and associated with Control of given type exists in assigned Theme.

§Default Arguments

type - ""

Source

pub fn has_color_override(&self, name: impl Into<GodotString>) -> bool

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

Source

pub fn has_constant( &self, name: impl Into<GodotString>, node_type: impl Into<GodotString>, ) -> bool

Returns true if constant with given name and associated with Control of given type exists in assigned Theme.

§Default Arguments

type - ""

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

Source

pub fn has_stylebox( &self, name: impl Into<GodotString>, node_type: impl Into<GodotString>, ) -> bool

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

§Default Arguments

type - ""

Source

pub fn has_stylebox_override(&self, name: impl Into<GodotString>) -> bool

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

Source

pub fn is_clipping_contents(&self) -> bool

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.

Source

pub fn minimum_size_changed(&self)

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

Sets [member margin_left] and [member margin_top] at the same time. Equivalent of changing [member rect_position].

Source

pub fn set_clip_contents(&self, enable: bool)

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.

Source

pub fn set_custom_minimum_size(&self, size: Vector2)

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.

Source

pub fn set_default_cursor_shape(&self, shape: i64)

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.

Source

pub fn set_drag_forwarding(&self, target: impl AsArg<Control>)

Sample code is GDScript unless otherwise noted.

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 [method get_drag_data], [method can_drop_data], and [method drop_data] but with two differences:

The function name must be suffixed with _fw
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()

Source

pub fn set_drag_preview(&self, control: impl AsArg<Control>)

Sample code is GDScript unless otherwise noted.

Shows the given control at the mouse pointer. A good time to call this method is in [method 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

§Default Arguments

keep_margins - false

Source

pub fn set_h_grow_direction(&self, direction: i64)

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.

Source

pub fn set_h_size_flags(&self, flags: i64)

Tells the parent Container nodes how they should resize and place the node on the X axis. Use one of the [enum SizeFlags] constants to change the flags. See the constants to learn what each does.

Source

pub fn set_margin(&self, margin: i64, offset: f64)

Distance between the node’s top edge and its parent control, based on [member 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.

Source

pub fn set_margins_preset(&self, preset: i64, resize_mode: i64, margin: i64)

Sets the margins to a preset from [enum Control.LayoutPreset] enum. This is code equivalent of using the Layout menu in 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.

§Default Arguments

resize_mode - 0
margin - 0

Sets the rotation (in radians).

Source

pub fn set_rotation_degrees(&self, degrees: f64)

The node’s rotation around its pivot, in degrees. See [member rect_pivot_offset] to change the pivot’s position.

Source

pub fn set_scale(&self, scale: Vector2)

The node’s scale, relative to its [member rect_size]. Change this property to scale the node around its [member rect_pivot_offset]. The Control’s [member 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 [url=https://docs.godotengine.org/en/latest/tutorials/viewports/multiple_resolutions.html]documentation[/url] 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 [member rect_scale] property.

Source

pub fn set_size(&self, size: Vector2, keep_margins: bool)

Sets the size (see [member rect_size]). If keep_margins is true, control’s anchors will be updated instead of margins.

§Default Arguments

keep_margins - false

Source

pub fn set_stretch_ratio(&self, ratio: f64)

If the node and at least one of its neighbours uses the [constant 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.

Source

pub fn set_theme(&self, theme: impl AsArg<Theme>)

Changing this property replaces the current Theme resource this node and all its Control children use.

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 [member mouse_filter] property is not [constant MOUSE_FILTER_IGNORE]. You can change the time required for the tooltip to appear with gui/timers/tooltip_delay_sec option in Project Settings.

Source

pub fn set_v_grow_direction(&self, direction: i64)

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.

Source

pub fn set_v_size_flags(&self, flags: i64)

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

Source

pub fn show_modal(&self, exclusive: bool)

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.

§Default Arguments

exclusive - false

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

§Default Arguments

width - 1.0
antialiased - false

Source

pub fn draw_char( &self, font: impl AsArg, position: Vector2, char: impl Into<GodotString>, next: impl Into<GodotString>, modulate: Color, ) -> f64

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

§Default Arguments

modulate - Color( 1, 1, 1, 1 )

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

Source

pub fn draw_set_transform_matrix(&self, xform: Transform2D)

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

Source

pub fn draw_string( &self, font: impl AsArg, position: Vector2, text: impl Into<GodotString>, modulate: Color, clip_w: i64, )

Sample code is GDScript unless otherwise noted.

Draws text using the specified font at the position (top-left corner). 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")

§Default Arguments

modulate - Color( 1, 1, 1, 1 )
clip_w - -1

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.

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 [member owner] in addition to calling [method add_child]. This is typically relevant for [url=https://godot.readthedocs.io/en/latest/tutorials/misc/running_code_in_the_editor.html]tool scripts[/url] and [url=https://godot.readthedocs.io/en/latest/tutorials/plugins/editor/index.html]editor plugins[/url]. If [method add_child] is called without setting [member owner], the newly added Node will not be visible in the scene tree, though it will be visible in the 2D/3D view.

§Default Arguments

legible_unique_name - false

Source

pub fn add_child_below_node( &self, node: impl AsArg<Node>, child_node: impl AsArg<Node>, legible_unique_name: bool, )

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 an human-readable name based on the name of the node being instanced instead of its type.

§Default Arguments

legible_unique_name - false

Source

pub fn add_to_group(&self, group: impl Into<GodotString>, persistent: bool)

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 [method is_inside_tree]). 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.

§Default Arguments

persistent - false

Possible paths are:

get_node("Sword")
get_node("Backpack/Dagger")
get_node("../Swamp/Alligator")
get_node("/root/MyGame")

Source

pub fn get_node_and_resource(&self, path: impl Into<NodePath>) -> VariantArray

Sample code is GDScript unless otherwise noted.

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]

pub fn print_tree_pretty(&self)

Sample code is GDScript unless otherwise noted.

Similar to [method print_tree], 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

Source

pub fn propagate_call( &self, method: impl Into<GodotString>, args: VariantArray, parent_first: bool, )

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.

§Default Arguments

args - [ ]
parent_first - false

Source

pub fn replace_by(&self, node: impl AsArg<Node>, keep_data: bool)

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

§Default Arguments

keep_data - false

§Default Arguments

recursive - true

arguments - [ ]

Source

pub unsafe fn call( &self, method: impl Into<GodotString>, varargs: &[Variant], ) -> Variant

Sample code is GDScript unless otherwise noted.

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

§Safety

This function bypasses Rust’s static type checks (aliasing, thread boundaries, calls to free(), …).

Source

pub unsafe fn call_deferred( &self, method: impl Into<GodotString>, varargs: &[Variant], ) -> Variant

Sample code is GDScript unless otherwise noted.

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

§Safety

This function bypasses Rust’s static type checks (aliasing, thread boundaries, calls to free(), …).

Source

pub unsafe fn callv( &self, method: impl Into<GodotString>, arg_array: VariantArray, ) -> Variant

Sample code is GDScript unless otherwise noted.

Calls the method on the object and returns the result. Contrarily to [method call], 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) ])

§Safety

This function bypasses Rust’s static type checks (aliasing, thread boundaries, calls to free(), …).

Source

pub fn can_translate_messages(&self) -> bool

Returns true if the object can translate strings. See [method set_message_translation] and [method tr].

Source

pub fn connect( &self, signal: impl Into<GodotString>, target: impl AsArg<Object>, method: impl Into<GodotString>, binds: VariantArray, flags: i64, ) -> GodotResult

Sample code is GDScript unless otherwise noted.

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 [method emit_signal]. Use flags to set deferred or one-shot connections. See [enum ConnectFlags] 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 [constant CONNECT_REFERENCE_COUNTED]. To avoid this, first, use [method is_connected] 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 [method connect] and parameters used when calling [method emit_signal]:

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

§Default Arguments

binds - [ ]
flags - 0

Source

pub fn disconnect( &self, signal: impl Into<GodotString>, target: impl AsArg<Object>, method: impl Into<GodotString>, )

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 [method is_connected] to ensure that the connection exists.

Source

pub fn emit_signal( &self, signal: impl Into<GodotString>, varargs: &[Variant], ) -> Variant

Sample code is GDScript unless otherwise noted.

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

Source

pub fn get(&self, property: impl Into<GodotString>) -> Variant

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

Source

pub fn get_class(&self) -> GodotString

Returns the object’s class as a String.

Source

pub fn get_incoming_connections(&self) -> VariantArray

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.

§Default Arguments

reversed - false

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)

Source

pub fn set_message_translation(&self, enable: bool)

Defines whether the object can translate strings (with calls to [method tr]). Enabled by default.

Source

pub fn set_meta(&self, name: impl Into<GodotString>, value: impl OwnedToVariant)

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 [method remove_meta]. 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".

Source

pub fn set_script(&self, script: impl AsArg<Reference>)

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 _init] method will be called.

Source

pub fn to_string(&self) -> GodotString

Returns a String representing the object. If not overridden, defaults to "[ClassName:RID]". Override the method [method _to_string] to customize the String representation.

Source

pub fn tr(&self, message: impl Into<GodotString>) -> GodotString

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 [method set_message_translation].

Trait Implementations§

Source §

impl Debug for GraphNode

Source §

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Source §

impl Deref for GraphNode

Source §

type Target = Container

The resulting type after dereferencing.

Recovers a instance ID previously returned by Object::get_instance_id if the object is still alive, and panics otherwise. This does NOT guarantee that the resulting reference is safe to use. Read more

Source §

impl SubClass<Object> for GraphNode

The type returned in the event of a conversion error.

Source §

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

Source §

impl<T, U> TryInto for T
where U: TryFrom<T>,

Source §

type Error = >::Error

The type returned in the event of a conversion error.

Source §

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Source §

Struct GraphNodeCopy item path

§Official documentation

§Memory management

§Class hierarchy

§Safety

Implementations§

impl GraphNode

pub const OVERLAY_BREAKPOINT: i64 = 1i64

pub const OVERLAY_DISABLED: i64 = 0i64

pub const OVERLAY_POSITION: i64 = 2i64

impl GraphNode

pub fn new() -> Ref<Self, Unique>

pub fn clear_all_slots(&self)

pub fn clear_slot(&self, idx: i64)

pub fn get_connection_input_color(&self, idx: i64) -> Color

pub fn get_connection_input_count(&self) -> i64

pub fn get_connection_input_position(&self, idx: i64) -> Vector2

pub fn get_connection_input_type(&self, idx: i64) -> i64

pub fn get_connection_output_color(&self, idx: i64) -> Color

pub fn get_connection_output_count(&self) -> i64

pub fn get_connection_output_position(&self, idx: i64) -> Vector2

pub fn get_connection_output_type(&self, idx: i64) -> i64

pub fn offset(&self) -> Vector2

pub fn overlay(&self) -> Overlay

pub fn get_slot_color_left(&self, idx: i64) -> Color

pub fn get_slot_color_right(&self, idx: i64) -> Color

pub fn get_slot_type_left(&self, idx: i64) -> i64

pub fn get_slot_type_right(&self, idx: i64) -> i64

pub fn title(&self) -> GodotString

pub fn is_close_button_visible(&self) -> bool

pub fn is_comment(&self) -> bool

pub fn is_resizable(&self) -> bool

pub fn is_selected(&self) -> bool

pub fn is_slot_enabled_left(&self, idx: i64) -> bool

pub fn is_slot_enabled_right(&self, idx: i64) -> bool

pub fn set_comment(&self, comment: bool)

pub fn set_offset(&self, offset: Vector2)

pub fn set_overlay(&self, overlay: i64)

pub fn set_resizable(&self, resizable: bool)

pub fn set_selected(&self, selected: bool)

pub fn set_show_close_button(&self, show: bool)

pub fn set_slot( &self, idx: i64, enable_left: bool, type_left: i64, color_left: Color, enable_right: bool, type_right: i64, color_right: Color, custom_left: impl AsArg<Texture>, custom_right: impl AsArg<Texture>, )

§Default Arguments

pub fn set_title(&self, title: impl Into<GodotString>)

Methods from Deref<Target = Container>§

pub const NOTIFICATION_SORT_CHILDREN: i64 = 50i64

pub fn fit_child_in_rect(&self, child: impl AsArg<Control>, rect: Rect2)

pub fn queue_sort(&self)

Methods from Deref<Target = Control>§

pub const ANCHOR_BEGIN: i64 = 0i64

pub const ANCHOR_END: i64 = 1i64

pub const CURSOR_ARROW: i64 = 0i64

pub const CURSOR_BDIAGSIZE: i64 = 11i64

pub const CURSOR_BUSY: i64 = 5i64

pub const CURSOR_CAN_DROP: i64 = 7i64

pub const CURSOR_CROSS: i64 = 3i64

pub const CURSOR_DRAG: i64 = 6i64

pub const CURSOR_FDIAGSIZE: i64 = 12i64

pub const CURSOR_FORBIDDEN: i64 = 8i64

pub const CURSOR_HELP: i64 = 16i64

pub const CURSOR_HSIZE: i64 = 10i64

pub const CURSOR_HSPLIT: i64 = 15i64

pub const CURSOR_IBEAM: i64 = 1i64

pub const CURSOR_MOVE: i64 = 13i64

pub const CURSOR_POINTING_HAND: i64 = 2i64

pub const CURSOR_VSIZE: i64 = 9i64

pub const CURSOR_VSPLIT: i64 = 14i64

pub const CURSOR_WAIT: i64 = 4i64

pub const FOCUS_ALL: i64 = 2i64

pub const FOCUS_CLICK: i64 = 1i64

pub const FOCUS_NONE: i64 = 0i64

pub const GROW_DIRECTION_BEGIN: i64 = 0i64

pub const GROW_DIRECTION_BOTH: i64 = 2i64

pub const GROW_DIRECTION_END: i64 = 1i64

pub const MOUSE_FILTER_IGNORE: i64 = 2i64

pub const MOUSE_FILTER_PASS: i64 = 1i64

pub const MOUSE_FILTER_STOP: i64 = 0i64

pub const NOTIFICATION_FOCUS_ENTER: i64 = 43i64

pub const NOTIFICATION_FOCUS_EXIT: i64 = 44i64

pub const NOTIFICATION_MODAL_CLOSE: i64 = 46i64

Struct GraphNode