Struct gdnative::Area

pub struct Area { /* fields omitted */ }

core class Area inherits CollisionObject (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.

Area is an unsafe pointer, and all of its methods are unsafe.

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 Area::free.

Class hierarchy

Area inherits methods from:

• CollisionObject
• Spatial
• Node
• Object

Methods

impl Area

Constants

pub const SPACE_OVERRIDE_REPLACE_COMBINE: i64

pub const SPACE_OVERRIDE_COMBINE: i64

pub const SPACE_OVERRIDE_COMBINE_REPLACE: i64

pub const SPACE_OVERRIDE_REPLACE: i64

pub const SPACE_OVERRIDE_DISABLED: i64

impl Area

pub fn new() -> Area

Constructor.

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 Area::free.

pub unsafe fn free(self)

Manually deallocate the object.

pub unsafe fn _area_enter_tree(&mut self, id: i64)

pub unsafe fn _area_exit_tree(&mut self, id: i64)

pub unsafe fn _area_inout(
    &mut self,
    arg0: i64,
    arg1: Rid,
    arg2: i64,
    arg3: i64,
    arg4: i64
)

pub unsafe fn _body_enter_tree(&mut self, id: i64)

pub unsafe fn _body_exit_tree(&mut self, id: i64)

pub unsafe fn _body_inout(
    &mut self,
    arg0: i64,
    arg1: Rid,
    arg2: i64,
    arg3: i64,
    arg4: i64
)

pub unsafe fn get_angular_damp(&self) -> f64

pub unsafe fn get_audio_bus(&self) -> GodotString

pub unsafe fn get_collision_layer(&self) -> i64

pub unsafe fn get_collision_layer_bit(&self, bit: i64) -> bool

pub unsafe fn get_collision_mask(&self) -> i64

pub unsafe fn get_collision_mask_bit(&self, bit: i64) -> bool

pub unsafe fn get_gravity(&self) -> f64

pub unsafe fn get_gravity_distance_scale(&self) -> f64

pub unsafe fn get_gravity_vector(&self) -> Vector3D<f32, UnknownUnit>

pub unsafe fn get_linear_damp(&self) -> f64

pub unsafe fn get_overlapping_areas(&self) -> VariantArray

pub unsafe fn get_overlapping_bodies(&self) -> VariantArray

pub unsafe fn get_priority(&self) -> f64

pub unsafe fn get_reverb_amount(&self) -> f64

pub unsafe fn get_reverb_bus(&self) -> GodotString

pub unsafe fn get_reverb_uniformity(&self) -> f64

pub unsafe fn get_space_override_mode(&self) -> AreaSpaceOverride

pub unsafe fn is_gravity_a_point(&self) -> bool

pub unsafe fn is_monitorable(&self) -> bool

pub unsafe fn is_monitoring(&self) -> bool

pub unsafe fn is_overriding_audio_bus(&self) -> bool

pub unsafe fn is_using_reverb_bus(&self) -> bool

pub unsafe fn overlaps_area(&self, area: Option<Node>) -> bool

pub unsafe fn overlaps_body(&self, body: Option<Node>) -> bool

pub unsafe fn set_angular_damp(&mut self, angular_damp: f64)

pub unsafe fn set_audio_bus(&mut self, name: GodotString)

pub unsafe fn set_audio_bus_override(&mut self, enable: bool)

pub unsafe fn set_collision_layer(&mut self, collision_layer: i64)

pub unsafe fn set_collision_layer_bit(&mut self, bit: i64, value: bool)

pub unsafe fn set_collision_mask(&mut self, collision_mask: i64)

pub unsafe fn set_collision_mask_bit(&mut self, bit: i64, value: bool)

pub unsafe fn set_gravity(&mut self, gravity: f64)

pub unsafe fn set_gravity_distance_scale(&mut self, distance_scale: f64)

pub unsafe fn set_gravity_is_point(&mut self, enable: bool)

pub unsafe fn set_gravity_vector(&mut self, vector: Vector3D<f32, UnknownUnit>)

pub unsafe fn set_linear_damp(&mut self, linear_damp: f64)

pub unsafe fn set_monitorable(&mut self, enable: bool)

pub unsafe fn set_monitoring(&mut self, enable: bool)

pub unsafe fn set_priority(&mut self, priority: f64)

pub unsafe fn set_reverb_amount(&mut self, amount: f64)

pub unsafe fn set_reverb_bus(&mut self, name: GodotString)

pub unsafe fn set_reverb_uniformity(&mut self, amount: f64)

pub unsafe fn set_space_override_mode(&mut self, enable: i64)

pub unsafe fn set_use_reverb_bus(&mut self, enable: bool)

pub unsafe fn to_collision_object(&self) -> CollisionObject

Up-cast.

pub unsafe fn to_spatial(&self) -> Spatial

Up-cast.

pub unsafe fn to_node(&self) -> Node

Up-cast.

pub unsafe fn to_object(&self) -> Object

Up-cast.

pub unsafe fn cast<T>(&self) -> Option<T> where
    T: GodotObject, 

Generic dynamic cast.

Methods from Deref<Target = CollisionObject>

pub unsafe fn _input_event(
    &mut self,
    camera: Option<Object>,
    event: Option<InputEvent>,
    click_position: Vector3D<f32, UnknownUnit>,
    click_normal: Vector3D<f32, UnknownUnit>,
    shape_idx: i64
)

pub unsafe fn create_shape_owner(&mut self, owner: Option<Object>) -> i64

pub unsafe fn get_capture_input_on_drag(&self) -> bool

pub unsafe fn get_rid(&self) -> Rid

pub unsafe fn get_shape_owners(&mut self) -> VariantArray

pub unsafe fn is_ray_pickable(&self) -> bool

pub unsafe fn is_shape_owner_disabled(&self, owner_id: i64) -> bool

pub unsafe fn remove_shape_owner(&mut self, owner_id: i64)

pub unsafe fn set_capture_input_on_drag(&mut self, enable: bool)

pub unsafe fn set_ray_pickable(&mut self, ray_pickable: bool)

pub unsafe fn shape_find_owner(&self, shape_index: i64) -> i64

pub unsafe fn shape_owner_add_shape(
    &mut self,
    owner_id: i64,
    shape: Option<Shape>
)

pub unsafe fn shape_owner_clear_shapes(&mut self, owner_id: i64)

pub unsafe fn shape_owner_get_owner(&self, owner_id: i64) -> Option<Object>

pub unsafe fn shape_owner_get_shape(
    &self,
    owner_id: i64,
    shape_id: i64
) -> Option<Shape>

pub unsafe fn shape_owner_get_shape_count(&self, owner_id: i64) -> i64

pub unsafe fn shape_owner_get_shape_index(
    &self,
    owner_id: i64,
    shape_id: i64
) -> i64

pub unsafe fn shape_owner_get_transform(&self, owner_id: i64) -> Transform

pub unsafe fn shape_owner_remove_shape(&mut self, owner_id: i64, shape_id: i64)

pub unsafe fn shape_owner_set_disabled(&mut self, owner_id: i64, disabled: bool)

pub unsafe fn shape_owner_set_transform(
    &mut self,
    owner_id: i64,
    transform: Transform
)

pub unsafe fn to_spatial(&self) -> Spatial

Up-cast.

pub unsafe fn to_node(&self) -> Node

Up-cast.

pub unsafe fn to_object(&self) -> Object

Up-cast.

pub unsafe fn cast<T>(&self) -> Option<T> where
    T: GodotObject, 

Generic dynamic cast.

Trait Implementations

impl Clone for Area

fn clone(&self) -> Area

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for Area

impl Debug for Area

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

Formats the value using the given formatter.

impl Deref for Area

type Target = CollisionObject

The resulting type after dereferencing.

fn deref(&self) -> &CollisionObject

Dereferences the value.

impl DerefMut for Area

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

Mutably dereferences the value.

impl Free for Area

unsafe fn godot_free(self)

impl FromVariant for Area

fn from_variant(variant: &Variant) -> Result<Area, FromVariantError>

impl GodotObject for Area

fn class_name() -> &'static str

unsafe fn from_sys(obj: *mut c_void) -> Area

unsafe fn from_return_position_sys(obj: *mut c_void) -> Area

unsafe fn to_sys(&self) -> *mut c_void

impl Instanciable for Area

fn construct() -> Area

impl QueueFree for Area

unsafe fn godot_queue_free(&mut self)

impl ToVariant for Area

fn to_variant(&self) -> Variant