Struct gdnative::api::VisualScript

pub struct VisualScript { /* fields omitted */ }

core class VisualScript inherits Script (reference counted).

Official documentation

See the documentation of this class in the Godot engine's official documentation.

Memory management

The lifetime of this object is automatically managed through reference counting.

Class hierarchy

VisualScript inherits methods from:

• Script
• Resource
• Reference
• Object

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

impl VisualScript

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

Creates a new instance of this object.

This is a reference-counted type. The returned object is automatically managed by Ref.

pub fn add_custom_signal(&self, name: impl Into<GodotString>)

pub fn add_function(&self, name: impl Into<GodotString>)

pub fn add_node(
    &self,
    func: impl Into<GodotString>,
    id: i64,
    node: impl AsArg<VisualScriptNode>,
    position: Vector2D<f32, UnknownUnit>
)

pub fn add_variable(
    &self,
    name: impl Into<GodotString>,
    default_value: impl OwnedToVariant,
    export: bool
)

pub fn custom_signal_add_argument(
    &self,
    name: impl Into<GodotString>,
    _type: i64,
    argname: impl Into<GodotString>,
    index: i64
)

pub fn custom_signal_get_argument_count(
    &self,
    name: impl Into<GodotString>
) -> i64

pub fn custom_signal_get_argument_name(
    &self,
    name: impl Into<GodotString>,
    argidx: i64
) -> GodotString

pub fn custom_signal_get_argument_type(
    &self,
    name: impl Into<GodotString>,
    argidx: i64
) -> VariantType

pub fn custom_signal_remove_argument(
    &self,
    name: impl Into<GodotString>,
    argidx: i64
)

pub fn custom_signal_set_argument_name(
    &self,
    name: impl Into<GodotString>,
    argidx: i64,
    argname: impl Into<GodotString>
)

pub fn custom_signal_set_argument_type(
    &self,
    name: impl Into<GodotString>,
    argidx: i64,
    _type: i64
)

pub fn custom_signal_swap_argument(
    &self,
    name: impl Into<GodotString>,
    argidx: i64,
    withidx: i64
)

pub fn data_connect(
    &self,
    func: impl Into<GodotString>,
    from_node: i64,
    from_port: i64,
    to_node: i64,
    to_port: i64
)

pub fn data_disconnect(
    &self,
    func: impl Into<GodotString>,
    from_node: i64,
    from_port: i64,
    to_node: i64,
    to_port: i64
)

pub fn get_function_node_id(&self, name: impl Into<GodotString>) -> i64

pub fn get_function_scroll(
    &self,
    name: impl Into<GodotString>
) -> Vector2D<f32, UnknownUnit>

pub fn get_node(
    &self,
    func: impl Into<GodotString>,
    id: i64
) -> Option<Ref<VisualScriptNode, Shared>>

pub fn get_node_position(
    &self,
    func: impl Into<GodotString>,
    id: i64
) -> Vector2D<f32, UnknownUnit>

pub fn get_variable_default_value(
    &self,
    name: impl Into<GodotString>
) -> Variant

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

pub fn get_variable_info(
    &self,
    name: impl Into<GodotString>
) -> Dictionary<Shared>

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

pub fn has_data_connection(
    &self,
    func: impl Into<GodotString>,
    from_node: i64,
    from_port: i64,
    to_node: i64,
    to_port: i64
) -> bool

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

pub fn has_node(&self, func: impl Into<GodotString>, id: i64) -> bool

pub fn has_sequence_connection(
    &self,
    func: impl Into<GodotString>,
    from_node: i64,
    from_output: i64,
    to_node: i64
) -> bool

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

pub fn remove_custom_signal(&self, name: impl Into<GodotString>)

pub fn remove_function(&self, name: impl Into<GodotString>)

pub fn remove_node(&self, func: impl Into<GodotString>, id: i64)

pub fn remove_variable(&self, name: impl Into<GodotString>)

pub fn rename_custom_signal(
    &self,
    name: impl Into<GodotString>,
    new_name: impl Into<GodotString>
)

pub fn rename_function(
    &self,
    name: impl Into<GodotString>,
    new_name: impl Into<GodotString>
)

pub fn rename_variable(
    &self,
    name: impl Into<GodotString>,
    new_name: impl Into<GodotString>
)

pub fn sequence_connect(
    &self,
    func: impl Into<GodotString>,
    from_node: i64,
    from_output: i64,
    to_node: i64
)

pub fn sequence_disconnect(
    &self,
    func: impl Into<GodotString>,
    from_node: i64,
    from_output: i64,
    to_node: i64
)

pub fn set_function_scroll(
    &self,
    name: impl Into<GodotString>,
    ofs: Vector2D<f32, UnknownUnit>
)

pub fn set_instance_base_type(&self, _type: impl Into<GodotString>)

pub fn set_node_position(
    &self,
    func: impl Into<GodotString>,
    id: i64,
    position: Vector2D<f32, UnknownUnit>
)

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

pub fn set_variable_export(&self, name: impl Into<GodotString>, enable: bool)

pub fn set_variable_info(
    &self,
    name: impl Into<GodotString>,
    value: Dictionary<Shared>
)

Methods from Deref<Target = Script>

pub fn can_instance(&self) -> bool

Returns [code]true[/code] if the script can be instanced.

pub fn get_base_script(&self) -> Option<Ref<Script, Shared>>

Returns the script directly inherited by this script.

pub fn get_instance_base_type(&self) -> GodotString

Returns the script's base type.

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

Returns the default value of the specified property.

pub fn get_script_constant_map(&self) -> Dictionary<Shared>

Returns a dictionary containing constant names and their values.

pub fn get_script_method_list(&self) -> VariantArray<Shared>

Returns the list of methods in this [Script].

pub fn get_script_property_list(&self) -> VariantArray<Shared>

Returns the list of properties in this [Script].

pub fn get_script_signal_list(&self) -> VariantArray<Shared>

Returns the list of user signals defined in this [Script].

pub fn source_code(&self) -> GodotString

The script source code or an empty string if source code is not available. When set, does not reload the class implementation automatically.

pub fn has_script_signal(&self, signal_name: impl Into<GodotString>) -> bool

Returns [code]true[/code] if the script, or a base class, defines a signal with the given name.

pub fn has_source_code(&self) -> bool

Returns [code]true[/code] if the script contains non-empty source code.

pub fn instance_has(&self, base_object: impl AsArg<Object>) -> bool

Returns [code]true[/code] if [code]base_object[/code] is an instance of this script.

pub fn is_tool(&self) -> bool

Returns [code]true[/code] if the script is a tool script. A tool script can run in the editor.

pub fn reload(&self, keep_state: bool) -> Result<(), GodotError>

Reloads the script's class implementation. Returns an error code.

Default Arguments

• keep_state - false

pub fn set_source_code(&self, source: impl Into<GodotString>)

The script source code or an empty string if source code is not available. When set, does not reload the class implementation automatically.

Trait Implementations

impl Debug for VisualScript

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

Formats the value using the given formatter.

impl Deref for VisualScript

type Target = Script

The resulting type after dereferencing.

fn deref(&self) -> &Script

Dereferences the value.

impl DerefMut for VisualScript

fn deref_mut(&mut self) -> &mut Script

Mutably dereferences the value.

impl GodotObject for VisualScript

type RefKind = RefCounted

The memory management kind of this type. This modifies the behavior of the Ref smart pointer. See its type-level documentation for more information.

fn class_name() -> &'static str

fn null() -> Null<Self>

Creates an explicitly null reference of Self as a method argument. This makes type inference easier for the compiler compared to Option.

fn new() -> Ref<Self, Unique> where
    Self: Instanciable, 

Creates a new instance of Self using a zero-argument constructor, as a Unique reference.

fn cast<T>(&self) -> Option<&T> where
    T: GodotObject + SubClass<Self>, 

Performs a dynamic reference downcast to target type.

fn upcast<T>(&self) -> &T where
    Self: SubClass<T>,
    T: GodotObject, 

Performs a static reference upcast to a supertype that is guaranteed to be valid.

unsafe fn assume_shared(&self) -> Ref<Self, Shared>

Creates a persistent reference to the same Godot object with shared thread access.

unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
    Self: GodotObject<RefKind = RefCounted>, 

Creates a persistent reference to the same Godot object with thread-local thread access.

unsafe fn assume_unique(&self) -> Ref<Self, Unique>

Creates a persistent reference to the same Godot object with unique access.

impl Instanciable for VisualScript

fn construct() -> Ref<VisualScript, Unique>

impl SubClass<Object> for VisualScript

impl SubClass<Reference> for VisualScript

impl SubClass<Resource> for VisualScript

impl SubClass<Script> for VisualScript