Area

General-purpose area node for detection and 3D physics influence.

3D area that detects nodes overlapping, entering, or exiting. Can also alter or override local physics parameters (gravity, damping).

Tutorials

• https://godotengine.org/asset-library/asset/125

Methods

• area_entered ( Area area )

Emitted when another area enters.

• area_exited ( area )

Emitted when another area exits.

• area_shape_entered ( int area_id, area, int area_shape, self_shape )

Emitted when another area enters, reporting which areas overlapped. shape_owner_get_owner(shape_find_owner(shape)) returns the parent object of the owner of the shape.

• area_shape_exited ( int area_id, area, int area_shape, self_shape )

Emitted when another area exits, reporting which areas were overlapping.

• body_entered ( Node body )

Emitted when a physics body enters.

The argument can either be a or a GridMap instance (while GridMaps are not physics body themselves, they register their tiles with collision shapes as a virtual physics body).

Emitted when a physics body exits.

The body argument can either be a or a GridMap instance (while GridMaps are not physics body themselves, they register their tiles with collision shapes as a virtual physics body).

• body_shape_entered ( body_id, Node body, body_shape, int area_shape )

Emitted when a physics body enters, reporting which shapes overlapped.

The body argument can either be a or a GridMap instance (while GridMaps are not physics body themselves, they register their tiles with collision shapes as a virtual physics body).

• body_shape_exited ( body_id, Node body, body_shape, int area_shape )

Emitted when a physics body exits, reporting which shapes were overlapping.

The body argument can either be a or a GridMap instance (while GridMaps are not physics body themselves, they register their tiles with collision shapes as a virtual physics body).

Enumerations

• 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 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 order), but keeps calculating the rest of the areas.

• float angular_damp

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

See for more details about damping.

• String audio_bus_name

The name of the area’s audio bus.

• audio_bus_override

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

• int collision_layer

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 . See Collision layers and masks in the documentation for more information.

• collision_mask

The physics layers this area scans to determine collision detection. See Collision layers and masks in the documentation for more information.

• gravity

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.

• float gravity_distance_scale

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

• gravity_point

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

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

• 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.

• monitorable

If true, other monitoring areas can detect this area.

• bool monitoring

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

• priority

• float reverb_bus_amount

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

• reverb_bus_enable

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

• String reverb_bus_name

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

• reverb_bus_uniformity

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

• SpaceOverride space_override

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

Method Descriptions

• bool get_collision_layer_bit ( bit ) const

Returns an individual bit on the layer mask.

• bool get_collision_mask_bit ( bit ) const

Returns an individual bit on the collision mask.

• Array get_overlapping_areas ( ) const

Returns a list of intersecting Areas. 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.

• get_overlapping_bodies ( ) const

Returns a list of intersecting PhysicsBodys. 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.

• overlaps_area ( Node area ) const

If true, the given area overlaps the Area.

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.

• overlaps_body ( Node body ) const

If true, the given physics body overlaps the Area.

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 or a GridMap instance (while GridMaps are not physics body themselves, they register their tiles with collision shapes as a virtual physics body).

• void set_collision_mask_bit ( bit, bool value )

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