[−][src]Struct gdnative::prelude::PackedScene
core class PackedScene
inherits Resource
(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
PackedScene 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
impl PackedScene
[src]
Constants
pub const GEN_EDIT_STATE_DISABLED: i64
[src]
pub const GEN_EDIT_STATE_INSTANCE: i64
[src]
pub const GEN_EDIT_STATE_MAIN: i64
[src]
impl PackedScene
[src]
pub fn new() -> Ref<PackedScene, Unique>
[src]
Creates a new instance of this object.
This is a reference-counted type. The returned object is automatically managed
by Ref
.
pub fn can_instance(&self) -> bool
[src]
pub fn get_state(&self) -> Option<Ref<SceneState, Shared>>
[src]
pub fn instance(&self, edit_state: i64) -> Option<Ref<Node, Shared>>
[src]
pub fn pack(&self, path: impl AsArg<Node>) -> Result<(), GodotError>
[src]
Methods from Deref<Target = Resource>
pub fn duplicate(&self, subresources: bool) -> Option<Ref<Resource, Shared>>
[src]
pub fn get_local_scene(&self) -> Option<Ref<Node, Shared>>
[src]
pub fn name(&self) -> GodotString
[src]
pub fn path(&self) -> GodotString
[src]
pub fn get_rid(&self) -> Rid
[src]
pub fn is_local_to_scene(&self) -> bool
[src]
pub fn set_local_to_scene(&self, enable: bool)
[src]
pub fn set_name(&self, name: impl Into<GodotString>)
[src]
pub fn set_path(&self, path: impl Into<GodotString>)
[src]
pub fn setup_local_to_scene(&self)
[src]
pub fn take_over_path(&self, path: impl Into<GodotString>)
[src]
Trait Implementations
impl Debug for PackedScene
[src]
impl Deref for PackedScene
[src]
impl DerefMut for PackedScene
[src]
impl GodotObject for PackedScene
[src]
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. Read more
fn class_name() -> &'static str
[src]
fn null() -> Null<Self>
[src]
fn new() -> Ref<Self, Unique> where
Self: Instanciable,
[src]
Self: Instanciable,
fn cast<T>(&self) -> Option<&T> where
T: GodotObject + SubClass<Self>,
[src]
T: GodotObject + SubClass<Self>,
fn upcast<T>(&self) -> &T where
Self: SubClass<T>,
T: GodotObject,
[src]
Self: SubClass<T>,
T: GodotObject,
unsafe fn assume_shared(&self) -> Ref<Self, Shared>
[src]
unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
Self: GodotObject<RefKind = RefCounted>,
[src]
Self: GodotObject<RefKind = RefCounted>,
unsafe fn assume_unique(&self) -> Ref<Self, Unique>
[src]
impl Instanciable for PackedScene
[src]
fn construct() -> Ref<PackedScene, Unique>
[src]
impl SubClass<Object> for PackedScene
[src]
impl SubClass<Reference> for PackedScene
[src]
impl SubClass<Resource> for PackedScene
[src]
Auto Trait Implementations
impl RefUnwindSafe for PackedScene
impl !Send for PackedScene
impl !Sync for PackedScene
impl Unpin for PackedScene
impl UnwindSafe for PackedScene
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> SubClass<T> for T where
T: GodotObject,
[src]
T: GodotObject,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,