Struct gdnative::Area

pub struct Area { /* fields omitted */ }

core class Area : CollisionObject (manually managed)

Base class

Area inherits CollisionObject and all of its methods.

Memory management

Non reference counted objects such as the ones of this type are usually owned by the engine. In the cases where Rust code owns an object of this type, ownership should be either passed to the engine or the object must be manually destroyed using Area::free.

Methods

impl Area

pub fn as_collision_object(&self) -> CollisionObject

Up-cast.

pub fn new() -> Self

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 fn _body_enter_tree(&mut self, id: i64)

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

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

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

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

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

pub fn is_gravity_a_point(&self) -> bool

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

pub fn get_gravity_distance_scale(&self) -> f64

pub fn set_gravity_vector(&mut self, vector: Vector3)

pub fn get_gravity_vector(&self) -> Vector3

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

pub fn get_gravity(&self) -> f64

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

pub fn get_angular_damp(&self) -> f64

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

pub fn get_linear_damp(&self) -> f64

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

pub fn get_priority(&self) -> f64

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

pub fn get_collision_mask(&self) -> i64

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

pub fn get_collision_layer(&self) -> i64

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

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

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

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

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

pub fn is_monitorable(&self) -> bool

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

pub fn is_monitoring(&self) -> bool

pub fn get_overlapping_bodies(&self) -> VariantArray

pub fn get_overlapping_areas(&self) -> VariantArray

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

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

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

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

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

pub fn is_overriding_audio_bus(&self) -> bool

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

pub fn get_audio_bus(&self) -> GodotString

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

pub fn is_using_reverb_bus(&self) -> bool

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

pub fn get_reverb_bus(&self) -> GodotString

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

pub fn get_reverb_amount(&self) -> f64

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

pub fn get_reverb_uniformity(&self) -> f64

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

Methods from Deref<Target = CollisionObject>

pub fn as_spatial(&self) -> Spatial

Up-cast.

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

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

pub fn is_ray_pickable(&self) -> bool

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

pub fn get_capture_input_on_drag(&self) -> bool

pub fn get_rid(&self) -> Rid

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

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

pub fn get_shape_owners(&mut self) -> VariantArray

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

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

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

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

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

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

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

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

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

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

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

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

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

Trait Implementations

impl GodotObject for Area

fn class_name() -> &'static str

unsafe fn from_sys(obj: *mut godot_object) -> Self

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

impl Deref for Area

type Target = CollisionObject

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for Area

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.