Struct gdnative::api::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 a reference-only type. Persistent references can only exist in the unsafe Ref<Area> 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

Area inherits methods from:

• CollisionObject
• Spatial
• 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 Area

Constants

pub const SPACE_OVERRIDE_COMBINE: i64

pub const SPACE_OVERRIDE_COMBINE_REPLACE: i64

pub const SPACE_OVERRIDE_DISABLED: i64

pub const SPACE_OVERRIDE_REPLACE: i64

pub const SPACE_OVERRIDE_REPLACE_COMBINE: i64

impl Area

pub fn new() -> Ref<Area, 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 angular_damp(&self) -> f64

The rate at which objects stop spinning in this area. Represents the angular velocity lost per second. Values range from [code]0[/code] (no damping) to [code]1[/code] (full damping).

pub fn audio_bus(&self) -> GodotString

The name of the area's audio bus.

pub fn collision_layer(&self) -> i64

The area's physics layer(s). Collidable objects can exist in any of 32 different layers. A contact is detected if object A is in any of the layers that object B scans, or object B is in any layers that object A scans. See also [member collision_mask]. See [url=https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information.

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

Returns an individual bit on the layer mask.

pub fn collision_mask(&self) -> i64

The physics layers this area scans to determine collision detection. See [url=https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information.

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

Returns an individual bit on the collision mask.

pub fn gravity(&self) -> f64

The area's gravity intensity (ranges from -1024 to 1024). This value multiplies the gravity vector. This is useful to alter the force of gravity without altering its direction.

pub fn gravity_distance_scale(&self) -> f64

The falloff factor for point gravity. The greater the value, the faster gravity decreases with distance.

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

The area's gravity vector (not normalized). If gravity is a point (see [member gravity_point]), this will be the point of attraction.

pub fn linear_damp(&self) -> f64

The rate at which objects stop moving in this area. Represents the linear velocity lost per second. Values range from [code]0[/code] (no damping) to [code]1[/code] (full damping).

pub fn get_overlapping_areas(&self) -> VariantArray<Shared>

Returns a list of intersecting [Area]s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead.

pub fn get_overlapping_bodies(&self) -> VariantArray<Shared>

Returns a list of intersecting [PhysicsBody]s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead.

pub fn priority(&self) -> f64

The area's priority. Higher priority areas are processed first.

pub fn reverb_amount(&self) -> f64

The degree to which this area applies reverb to its associated audio. Ranges from [code]0[/code] to [code]1[/code] with [code]0.1[/code] precision.

pub fn reverb_bus(&self) -> GodotString

The reverb bus name to use for this area's associated audio.

pub fn reverb_uniformity(&self) -> f64

The degree to which this area's reverb is a uniform effect. Ranges from [code]0[/code] to [code]1[/code] with [code]0.1[/code] precision.

pub fn space_override_mode(&self) -> SpaceOverride

Override mode for gravity and damping calculations within this area. See [enum SpaceOverride] for possible values.

pub fn is_gravity_a_point(&self) -> bool

If [code]true[/code], gravity is calculated from a point (set via [member gravity_vec]). See also [member space_override].

pub fn is_monitorable(&self) -> bool

If [code]true[/code], other monitoring areas can detect this area.

pub fn is_monitoring(&self) -> bool

If [code]true[/code], the area detects bodies or areas entering and exiting it.

pub fn is_overriding_audio_bus(&self) -> bool

If [code]true[/code], the area's audio bus overrides the default audio bus.

pub fn is_using_reverb_bus(&self) -> bool

If [code]true[/code], the area applies reverb to its associated audio.

pub fn overlaps_area(&self, area: impl AsArg<Node>) -> bool

If [code]true[/code], the given area overlaps the Area.
				[b]Note:[/b] The result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead.

pub fn overlaps_body(&self, body: impl AsArg<Node>) -> bool

If [code]true[/code], the given physics body overlaps the Area.
				[b]Note:[/b] The result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead.
				The [code]body[/code] argument can either be a [PhysicsBody] or a [GridMap] instance (while GridMaps are not physics body themselves, they register their tiles with collision shapes as a virtual physics body).

pub fn set_angular_damp(&self, angular_damp: f64)

The rate at which objects stop spinning in this area. Represents the angular velocity lost per second. Values range from [code]0[/code] (no damping) to [code]1[/code] (full damping).

pub fn set_audio_bus(&self, name: impl Into<GodotString>)

The name of the area's audio bus.

pub fn set_audio_bus_override(&self, enable: bool)

If [code]true[/code], the area's audio bus overrides the default audio bus.

pub fn set_collision_layer(&self, collision_layer: i64)

The area's physics layer(s). Collidable objects can exist in any of 32 different layers. A contact is detected if object A is in any of the layers that object B scans, or object B is in any layers that object A scans. See also [member collision_mask]. See [url=https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information.

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

Set/clear individual bits on the layer mask. This simplifies editing this [Area]'s layers.

pub fn set_collision_mask(&self, collision_mask: i64)

The physics layers this area scans to determine collision detection. See [url=https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information.

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

Set/clear individual bits on the collision mask. This simplifies editing which [Area] layers this [Area] scans.

pub fn set_gravity(&self, gravity: f64)

The area's gravity intensity (ranges from -1024 to 1024). This value multiplies the gravity vector. This is useful to alter the force of gravity without altering its direction.

pub fn set_gravity_distance_scale(&self, distance_scale: f64)

The falloff factor for point gravity. The greater the value, the faster gravity decreases with distance.

pub fn set_gravity_is_point(&self, enable: bool)

If [code]true[/code], gravity is calculated from a point (set via [member gravity_vec]). See also [member space_override].

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

The area's gravity vector (not normalized). If gravity is a point (see [member gravity_point]), this will be the point of attraction.

pub fn set_linear_damp(&self, linear_damp: f64)

The rate at which objects stop moving in this area. Represents the linear velocity lost per second. Values range from [code]0[/code] (no damping) to [code]1[/code] (full damping).

pub fn set_monitorable(&self, enable: bool)

If [code]true[/code], other monitoring areas can detect this area.

pub fn set_monitoring(&self, enable: bool)

If [code]true[/code], the area detects bodies or areas entering and exiting it.

pub fn set_priority(&self, priority: f64)

The area's priority. Higher priority areas are processed first.

pub fn set_reverb_amount(&self, amount: f64)

The degree to which this area applies reverb to its associated audio. Ranges from [code]0[/code] to [code]1[/code] with [code]0.1[/code] precision.

pub fn set_reverb_bus(&self, name: impl Into<GodotString>)

The reverb bus name to use for this area's associated audio.

pub fn set_reverb_uniformity(&self, amount: f64)

The degree to which this area's reverb is a uniform effect. Ranges from [code]0[/code] to [code]1[/code] with [code]0.1[/code] precision.

pub fn set_space_override_mode(&self, enable: i64)

Override mode for gravity and damping calculations within this area. See [enum SpaceOverride] for possible values.

pub fn set_use_reverb_bus(&self, enable: bool)

If [code]true[/code], the area applies reverb to its associated audio.

Methods from Deref<Target = CollisionObject>

pub fn create_shape_owner(&self, owner: impl AsArg<Object>) -> i64

Creates a new shape owner for the given object. Returns [code]owner_id[/code] of the new owner for future reference.

pub fn capture_input_on_drag(&self) -> bool

If [code]true[/code], the [CollisionObject] will continue to receive input events as the mouse is dragged across its shapes.

pub fn get_rid(&self) -> Rid

Returns the object's [RID].

pub fn get_shape_owners(&self) -> VariantArray<Shared>

Returns an [Array] of [code]owner_id[/code] identifiers. You can use these ids in other methods that take [code]owner_id[/code] as an argument.

pub fn is_ray_pickable(&self) -> bool

If [code]true[/code], the [CollisionObject]'s shapes will respond to [RayCast]s.

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

If [code]true[/code], the shape owner and its shapes are disabled.

pub fn remove_shape_owner(&self, owner_id: i64)

Removes the given shape owner.

pub fn set_capture_input_on_drag(&self, enable: bool)

If [code]true[/code], the [CollisionObject] will continue to receive input events as the mouse is dragged across its shapes.

pub fn set_ray_pickable(&self, ray_pickable: bool)

If [code]true[/code], the [CollisionObject]'s shapes will respond to [RayCast]s.

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

Returns the [code]owner_id[/code] of the given shape.

pub fn shape_owner_add_shape(&self, owner_id: i64, shape: impl AsArg<Shape>)

Adds a [Shape] to the shape owner.

pub fn shape_owner_clear_shapes(&self, owner_id: i64)

Removes all shapes from the shape owner.

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

Returns the parent object of the given shape owner.

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

Returns the [Shape] with the given id from the given shape owner.

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

Returns the number of shapes the given shape owner contains.

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

Returns the child index of the [Shape] with the given id from the given shape owner.

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

Returns the shape owner's [Transform].

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

Removes a shape from the given shape owner.

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

If [code]true[/code], disables the given shape owner.

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

Sets the [Transform] of the given shape owner.

Trait Implementations

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 GodotObject for Area

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 Area

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

impl QueueFree for Area

unsafe fn godot_queue_free(obj: *mut c_void)

impl SubClass<CollisionObject> for Area

impl SubClass<Node> for Area

impl SubClass<Object> for Area

impl SubClass<Spatial> for Area