Area3D

Inherits: CollisionObject3D < Node3D < Node < Object

3D area for detection and physics and audio influence.

Description

3D area that detects CollisionObject3D nodes overlapping, entering, or exiting. Can also alter or override local physics parameters (gravity, damping) and route audio to custom audio buses.

Tutorials

Properties

float

angular_damp

0.1

SpaceOverride

angular_damp_space_override

0

StringName

audio_bus_name

&"Master"

bool

audio_bus_override

false

float

gravity

9.8

Vector3

gravity_direction

Vector3(0, -1, 0)

bool

gravity_point

false

Vector3

gravity_point_center

Vector3(0, -1, 0)

float

gravity_point_distance_scale

0.0

SpaceOverride

gravity_space_override

0

float

linear_damp

0.1

SpaceOverride

linear_damp_space_override

0

bool

monitorable

true

bool

monitoring

true

float

priority

0.0

float

reverb_bus_amount

0.0

bool

reverb_bus_enable

false

StringName

reverb_bus_name

&"Master"

float

reverb_bus_uniformity

0.0

float

wind_attenuation_factor

0.0

float

wind_force_magnitude

0.0

NodePath

wind_source_path

NodePath("")

Methods

Area3D[]

get_overlapping_areas ( ) const

Node3D[]

get_overlapping_bodies ( ) const

bool

overlaps_area ( Node area ) const

bool

overlaps_body ( Node body ) const

Signals

  • area_entered ( Area3D area )

Emitted when another Area3D enters this Area3D. Requires monitoring to be set to true.

area the other Area3D.


Emitted when another Area3D exits this Area3D. Requires monitoring to be set to true.

area the other Area3D.


  • area_shape_entered ( RID area_rid, Area3D area, int area_shape_index, int local_shape_index )

Emitted when one of another Area3D's Shape3Ds enters one of this Area3D's Shape3Ds. Requires monitoring to be set to true.

area_rid the RID of the other Area3D's CollisionObject3D used by the PhysicsServer3D.

area the other Area3D.

area_shape_index the index of the Shape3D of the other Area3D used by the PhysicsServer3D. Get the CollisionShape3D node with area.shape_owner_get_owner(area.shape_find_owner(area_shape_index)).

local_shape_index the index of the Shape3D of this Area3D used by the PhysicsServer3D. Get the CollisionShape3D node with self.shape_owner_get_owner(self.shape_find_owner(local_shape_index)).


  • area_shape_exited ( RID area_rid, Area3D area, int area_shape_index, int local_shape_index )

Emitted when one of another Area3D's Shape3Ds exits one of this Area3D's Shape3Ds. Requires monitoring to be set to true.

area_rid the RID of the other Area3D's CollisionObject3D used by the PhysicsServer3D.

area the other Area3D.

area_shape_index the index of the Shape3D of the other Area3D used by the PhysicsServer3D. Get the CollisionShape3D node with area.shape_owner_get_owner(area.shape_find_owner(area_shape_index)).

local_shape_index the index of the Shape3D of this Area3D used by the PhysicsServer3D. Get the CollisionShape3D node with self.shape_owner_get_owner(self.shape_find_owner(local_shape_index)).


  • body_entered ( Node3D body )

Emitted when a PhysicsBody3D or GridMap enters this Area3D. Requires monitoring to be set to true. GridMaps are detected if the MeshLibrary has Collision Shape3Ds.

body the Node, if it exists in the tree, of the other PhysicsBody3D or GridMap.


Emitted when a PhysicsBody3D or GridMap exits this Area3D. Requires monitoring to be set to true. GridMaps are detected if the MeshLibrary has Collision Shape3Ds.

body the Node, if it exists in the tree, of the other PhysicsBody3D or GridMap.


  • body_shape_entered ( RID body_rid, Node3D body, int body_shape_index, int local_shape_index )

Emitted when one of a PhysicsBody3D or GridMap's Shape3Ds enters one of this Area3D's Shape3Ds. Requires monitoring to be set to true. GridMaps are detected if the MeshLibrary has Collision Shape3Ds.

body_rid the RID of the PhysicsBody3D or MeshLibrary's CollisionObject3D used by the PhysicsServer3D.

body the Node, if it exists in the tree, of the PhysicsBody3D or GridMap.

body_shape_index the index of the Shape3D of the PhysicsBody3D or GridMap used by the PhysicsServer3D. Get the CollisionShape3D node with body.shape_owner_get_owner(body.shape_find_owner(body_shape_index)).

local_shape_index the index of the Shape3D of this Area3D used by the PhysicsServer3D. Get the CollisionShape3D node with self.shape_owner_get_owner(self.shape_find_owner(local_shape_index)).


  • body_shape_exited ( RID body_rid, Node3D body, int body_shape_index, int local_shape_index )

Emitted when one of a PhysicsBody3D or GridMap's Shape3Ds enters one of this Area3D's Shape3Ds. Requires monitoring to be set to true. GridMaps are detected if the MeshLibrary has Collision Shape3Ds.

body_rid the RID of the PhysicsBody3D or MeshLibrary's CollisionObject3D used by the PhysicsServer3D.

body the Node, if it exists in the tree, of the PhysicsBody3D or GridMap.

body_shape_index the index of the Shape3D of the PhysicsBody3D or GridMap used by the PhysicsServer3D. Get the CollisionShape3D node with body.shape_owner_get_owner(body.shape_find_owner(body_shape_index)).

local_shape_index the index of the Shape3D of this Area3D used by the PhysicsServer3D. Get the CollisionShape3D node with self.shape_owner_get_owner(self.shape_find_owner(local_shape_index)).

Enumerations

enum SpaceOverride:

  • SPACE_OVERRIDE_DISABLED = 0 --- This area does not affect gravity/damping.

  • SPACE_OVERRIDE_COMBINE = 1 --- This area adds its gravity/damping values to whatever has been calculated so far (in priority order).

  • SPACE_OVERRIDE_COMBINE_REPLACE = 2 --- This area adds its gravity/damping values to whatever has been calculated so far (in priority order), ignoring any lower priority areas.

  • SPACE_OVERRIDE_REPLACE = 3 --- This area replaces any gravity/damping, even the defaults, ignoring any lower priority areas.

  • SPACE_OVERRIDE_REPLACE_COMBINE = 4 --- This area replaces any gravity/damping calculated so far (in priority order), but keeps calculating the rest of the areas.

Property Descriptions

Default

0.1

Setter

set_angular_damp(value)

Getter

get_angular_damp()

The rate at which objects stop spinning in this area. Represents the angular velocity lost per second.

See ProjectSettings.physics/3d/default_angular_damp for more details about damping.


Default

0

Setter

set_angular_damp_space_override_mode(value)

Getter

get_angular_damp_space_override_mode()

Override mode for angular damping calculations within this area. See SpaceOverride for possible values.


Default

&"Master"

Setter

set_audio_bus_name(value)

Getter

get_audio_bus_name()

The name of the area's audio bus.


  • bool audio_bus_override

Default

false

Setter

set_audio_bus_override(value)

Getter

is_overriding_audio_bus()

If true, the area's audio bus overrides the default audio bus.


Default

9.8

Setter

set_gravity(value)

Getter

get_gravity()

The area's gravity intensity (in meters per second squared). This value multiplies the gravity direction. This is useful to alter the force of gravity without altering its direction.


Default

Vector3(0, -1, 0)

Setter

set_gravity_direction(value)

Getter

get_gravity_direction()

The area's gravity vector (not normalized).


  • bool gravity_point

Default

false

Setter

set_gravity_is_point(value)

Getter

is_gravity_a_point()

If true, gravity is calculated from a point (set via gravity_point_center). See also gravity_space_override.


Default

Vector3(0, -1, 0)

Setter

set_gravity_point_center(value)

Getter

get_gravity_point_center()

If gravity is a point (see gravity_point), this will be the point of attraction.


  • float gravity_point_distance_scale

Default

0.0

Setter

set_gravity_point_distance_scale(value)

Getter

get_gravity_point_distance_scale()

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


Default

0

Setter

set_gravity_space_override_mode(value)

Getter

get_gravity_space_override_mode()

Override mode for gravity calculations within this area. See SpaceOverride for possible values.


Default

0.1

Setter

set_linear_damp(value)

Getter

get_linear_damp()

The rate at which objects stop moving in this area. Represents the linear velocity lost per second.

See ProjectSettings.physics/3d/default_linear_damp for more details about damping.


Default

0

Setter

set_linear_damp_space_override_mode(value)

Getter

get_linear_damp_space_override_mode()

Override mode for linear damping calculations within this area. See SpaceOverride for possible values.


Default

true

Setter

set_monitorable(value)

Getter

is_monitorable()

If true, other monitoring areas can detect this area.


Default

true

Setter

set_monitoring(value)

Getter

is_monitoring()

If true, the area detects bodies or areas entering and exiting it.


Default

0.0

Setter

set_priority(value)

Getter

get_priority()

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


  • float reverb_bus_amount

Default

0.0

Setter

set_reverb_amount(value)

Getter

get_reverb_amount()

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


  • bool reverb_bus_enable

Default

false

Setter

set_use_reverb_bus(value)

Getter

is_using_reverb_bus()

If true, the area applies reverb to its associated audio.


Default

&"Master"

Setter

set_reverb_bus(value)

Getter

get_reverb_bus()

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


  • float reverb_bus_uniformity

Default

0.0

Setter

set_reverb_uniformity(value)

Getter

get_reverb_uniformity()

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


  • float wind_attenuation_factor

Default

0.0

Setter

set_wind_attenuation_factor(value)

Getter

get_wind_attenuation_factor()

The exponential rate at which wind force decreases with distance from its origin.


  • float wind_force_magnitude

Default

0.0

Setter

set_wind_force_magnitude(value)

Getter

get_wind_force_magnitude()

The magnitude of area-specific wind force.


Default

NodePath("")

Setter

set_wind_source_path(value)

Getter

get_wind_source_path()

The Node3D which is used to specify the the direction and origin of an area-specific wind force. The direction is opposite to the z-axis of the Node3D's local transform, and its origin is the origin of the Node3D's local transform.

Method Descriptions

  • Area3D[] get_overlapping_areas ( ) const

Returns a list of intersecting Area3Ds. The overlapping area's CollisionObject3D.collision_layer must be part of this area's CollisionObject3D.collision_mask in order to be detected.

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.


  • Node3D[] get_overlapping_bodies ( ) const

Returns a list of intersecting PhysicsBody3Ds. The overlapping body's CollisionObject3D.collision_layer must be part of this area's CollisionObject3D.collision_mask in order to be detected.

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.


  • bool overlaps_area ( Node area ) const

Returns true if the given Area3D intersects or overlaps this Area3D, false otherwise.

Note: 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.


  • bool overlaps_body ( Node body ) const

Returns true if the given physics body intersects or overlaps this Area3D, false otherwise.

Note: 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 body argument can either be a PhysicsBody3D or a GridMap instance. While GridMaps are not physics body themselves, they register their tiles with collision shapes as a virtual physics body.