Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

Area3D

Inherits: CollisionObject3D < Node3D < Node < Object

A region of 3D space that detects other CollisionObject3Ds entering or exiting it.

Description

Area3D is a region of 3D space defined by one or multiple CollisionShape3D or CollisionPolygon3D child nodes. It detects when other CollisionObject3Ds enter or exit it, and it also keeps track of which collision objects haven't exited it yet (i.e. which one are overlapping it).

This node can also locally alter or override physics parameters (gravity, damping) and route audio to custom audio buses.

Warning: Using a ConcavePolygonShape3D inside a CollisionShape3D child of this node (created e.g. by using the Create Trimesh Collision Sibling option in the Mesh menu that appears when selecting a MeshInstance3D node) may give unexpected results, since this collision shape is hollow. If this is not desired, it has to be split into multiple ConvexPolygonShape3Ds or primitive shapes like BoxShape3D, or in some cases it may be replaceable by a CollisionPolygon3D.

Tutorials

• Using Area2D

• 3D Platformer Demo

• GUI in 3D Demo

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_unit_distance	0.0
SpaceOverride	gravity_space_override	0
float	linear_damp	0.1
SpaceOverride	linear_damp_space_override	0
bool	monitorable	true
bool	monitoring	true
int	priority	0
float	reverb_bus_amount	0.0
bool	reverb_bus_enabled	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	has_overlapping_areas ( ) const
bool	has_overlapping_bodies ( ) const
bool	overlaps_area ( Node area ) const
bool	overlaps_body ( Node body ) const