Struct gdnative_bindings::scene_state::SceneState

pub struct SceneState { /* fields omitted */ }

core class SceneState inherits Reference (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

SceneState inherits methods from:

• 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 SceneState

Constants

pub const GEN_EDIT_STATE_DISABLED: i64

pub const GEN_EDIT_STATE_INSTANCE: i64

pub const GEN_EDIT_STATE_MAIN: i64

impl SceneState

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

Returns the list of bound parameters for the signal at [code]idx[/code].

pub fn get_connection_count(&self) -> i64

Returns the number of signal connections in the scene.
				The [code]idx[/code] argument used to query connection metadata in other [code]get_connection_*[/code] methods in the interval [code][0, get_connection_count() - 1][/code].

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

Returns the connection flags for the signal at [code]idx[/code]. See [enum Object.ConnectFlags] constants.

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

Returns the method connected to the signal at [code]idx[/code].

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

Returns the name of the signal at [code]idx[/code].

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

Returns the path to the node that owns the signal at [code]idx[/code], relative to the root node.

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

Returns the path to the node that owns the method connected to the signal at [code]idx[/code], relative to the root node.

pub fn get_node_count(&self) -> i64

Returns the number of nodes in the scene.
				The [code]idx[/code] argument used to query node data in other [code]get_node_*[/code] methods in the interval [code][0, get_node_count() - 1][/code].

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

Returns the list of group names associated with the node at [code]idx[/code].

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

Returns the node's index, which is its position relative to its siblings. This is only relevant and saved in scenes for cases where new nodes are added to an instanced or inherited scene among siblings from the base scene. Despite the name, this index is not related to the [code]idx[/code] argument used here and in other methods.

pub fn get_node_instance(&self, idx: i64) -> Option<Ref<PackedScene, Shared>>

Returns a [PackedScene] for the node at [code]idx[/code] (i.e. the whole branch starting at this node, with its child nodes and resources), or [code]null[/code] if the node is not an instance.

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

Returns the path to the represented scene file if the node at [code]idx[/code] is an [InstancePlaceholder].

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

Returns the name of the node at [code]idx[/code].

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

Returns the path to the owner of the node at [code]idx[/code], relative to the root node.

pub fn get_node_path(&self, idx: i64, for_parent: bool) -> NodePath

Returns the path to the node at [code]idx[/code].
				If [code]for_parent[/code] is [code]true[/code], returns the path of the [code]idx[/code] node's parent instead.

Default Arguments

• for_parent - false

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

Returns the number of exported or overridden properties for the node at [code]idx[/code].
				The [code]prop_idx[/code] argument used to query node property data in other [code]get_node_property_*[/code] methods in the interval [code][0, get_node_property_count() - 1][/code].

pub fn get_node_property_name(&self, idx: i64, prop_idx: i64) -> GodotString

Returns the name of the property at [code]prop_idx[/code] for the node at [code]idx[/code].

pub fn get_node_property_value(&self, idx: i64, prop_idx: i64) -> Variant

Returns the value of the property at [code]prop_idx[/code] for the node at [code]idx[/code].

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

Returns the type of the node at [code]idx[/code].

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

Returns [code]true[/code] if the node at [code]idx[/code] is an [InstancePlaceholder].

Methods from Deref<Target = Reference>

pub fn init_ref(&self) -> bool

Initializes the internal reference counter. Use this only if you really know what you are doing.
				Returns whether the initialization was successful.

Trait Implementations

impl Debug for SceneState

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

Formats the value using the given formatter.

impl Deref for SceneState

type Target = Reference

The resulting type after dereferencing.

fn deref(&self) -> &Reference

Dereferences the value.

impl DerefMut for SceneState

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

Mutably dereferences the value.

impl GodotObject for SceneState

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 Sealed for SceneState

impl SubClass<Object> for SceneState

impl SubClass<Reference> for SceneState