Struct gdnative_bindings::VisibilityEnabler2D

pub struct VisibilityEnabler2D { /* fields omitted */ }

core class VisibilityEnabler2D inherits VisibilityNotifier2D (unsafe).

Official documentation

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

Memory management

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

VisibilityEnabler2D is a reference-only type. Persistent references can only exist in the unsafe Ref<VisibilityEnabler2D> 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

VisibilityEnabler2D inherits methods from:

• VisibilityNotifier2D
• Node2D
• CanvasItem
• Node
• 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 VisibilityEnabler2D

Constants

pub const ENABLER_FREEZE_BODIES: i64

pub const ENABLER_MAX: i64

pub const ENABLER_PARENT_PHYSICS_PROCESS: i64

pub const ENABLER_PARENT_PROCESS: i64

pub const ENABLER_PAUSE_ANIMATED_SPRITES: i64

pub const ENABLER_PAUSE_ANIMATIONS: i64

pub const ENABLER_PAUSE_PARTICLES: i64

impl VisibilityEnabler2D

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.

Immediately after creation, the object is owned by the caller, and can be passed to the engine (in which case the engine will be responsible for destroying the object) or destroyed manually using Ref::free, or preferably Ref::queue_free if it is a Node.

pub fn is_enabler_enabled(&self, enabler: i64) -> bool

If [code]true[/code], the parent's [method Node._process] will be stopped.

pub fn set_enabler(&self, enabler: i64, enabled: bool)

If [code]true[/code], the parent's [method Node._process] will be stopped.

Methods from Deref<Target = VisibilityNotifier2D>

pub fn rect(&self) -> Rect2

The VisibilityNotifier2D's bounding rectangle.

pub fn is_on_screen(&self) -> bool

If [code]true[/code], the bounding rectangle is on the screen.
				[b]Note:[/b] It takes one frame for the node's visibility to be assessed once added to the scene tree, so this method will return [code]false[/code] right after it is instantiated, even if it will be on screen in the draw pass.

pub fn set_rect(&self, rect: Rect2)

The VisibilityNotifier2D's bounding rectangle.

Trait Implementations

impl Debug for VisibilityEnabler2D

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

Formats the value using the given formatter.

impl Deref for VisibilityEnabler2D

type Target = VisibilityNotifier2D

The resulting type after dereferencing.

fn deref(&self) -> &VisibilityNotifier2D

Dereferences the value.

impl DerefMut for VisibilityEnabler2D

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

Mutably dereferences the value.

impl GodotObject for VisibilityEnabler2D

type RefKind = ManuallyManaged

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 VisibilityEnabler2D

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

impl QueueFree for VisibilityEnabler2D

unsafe fn godot_queue_free(obj: *mut godot_object)

impl Sealed for VisibilityEnabler2D

impl SubClass<CanvasItem> for VisibilityEnabler2D

impl SubClass<Node> for VisibilityEnabler2D

impl SubClass<Node2D> for VisibilityEnabler2D

impl SubClass<Object> for VisibilityEnabler2D

impl SubClass<VisibilityNotifier2D> for VisibilityEnabler2D