Struct gdnative::api::VisualScriptYieldSignal

pub struct VisualScriptYieldSignal { /* fields omitted */ }

core class VisualScriptYieldSignal inherits VisualScriptNode (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

VisualScriptYieldSignal inherits methods from:

• VisualScriptNode
• 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 VisualScriptYieldSignal

Constants

pub const CALL_MODE_INSTANCE: i64

pub const CALL_MODE_NODE_PATH: i64

pub const CALL_MODE_SELF: i64

impl VisualScriptYieldSignal

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

Creates a new instance of this object.

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

pub fn base_path(&self) -> NodePath

pub fn base_type(&self) -> GodotString

pub fn call_mode(&self) -> CallMode

pub fn signal(&self) -> GodotString

pub fn set_base_path(&self, base_path: impl Into<NodePath>)

pub fn set_base_type(&self, base_type: impl Into<GodotString>)

pub fn set_call_mode(&self, mode: i64)

pub fn set_signal(&self, signal: impl Into<GodotString>)

Methods from Deref<Target = VisualScriptNode>

pub fn get_default_input_value(&self, port_idx: i64) -> Variant

pub fn get_visual_script(&self) -> Option<Ref<VisualScript, Shared>>

pub fn ports_changed_notify(&self)

pub fn set_default_input_value(&self, port_idx: i64, value: impl OwnedToVariant)

Trait Implementations

impl Debug for VisualScriptYieldSignal

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

Formats the value using the given formatter.

impl Deref for VisualScriptYieldSignal

type Target = VisualScriptNode

The resulting type after dereferencing.

fn deref(&self) -> &VisualScriptNode

Dereferences the value.

impl DerefMut for VisualScriptYieldSignal

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

Mutably dereferences the value.

impl GodotObject for VisualScriptYieldSignal

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 VisualScriptYieldSignal

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

impl SubClass<Object> for VisualScriptYieldSignal

impl SubClass<Reference> for VisualScriptYieldSignal

impl SubClass<Resource> for VisualScriptYieldSignal

impl SubClass<VisualScriptNode> for VisualScriptYieldSignal