Inheritance #

Area2D #

is_instantiable, Node2D, Node, core, not_builtin_classes

A region of 2D space that detects other CollisionObject2Ds entering or exiting it.

Area2D is a region of 2D space defined by one or multiple CollisionShape2D or CollisionPolygon2D child nodes. It detects when other CollisionObject2Ds 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.

Note: Areas and bodies created with PhysicsServer2D might not interact as expected with Area2Ds, and might not emit signals or track objects correctly.

Members #

var angular_damp: float = 1.0#

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

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

var angular_damp_space_override = SPACE_OVERRIDE_DISABLED#

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

var audio_bus_name: StringName = &"Master"#

The name of the area's audio bus.

var audio_bus_override: bool = false#

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

var gravity: float = 980.0#

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

var gravity_direction: Vector2 = Vector2(0, 1)#

The area's gravity vector (not normalized).

var gravity_point: bool = false#

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

var gravity_point_center: Vector2 = Vector2(0, 1)#

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

var gravity_point_unit_distance: float = 0.0#

The distance at which the gravity strength is equal to gravity. For example, on a planet 100 pixels in radius with a surface gravity of 4.0 px/s², set the gravity to 4.0 and the unit distance to 100.0. The gravity will have falloff according to the inverse square law, so in the example, at 200 pixels from the center the gravity will be 1.0 px/s² (twice the distance, 1/4th the gravity), at 50 pixels it will be 16.0 px/s² (half the distance, 4x the gravity), and so on.

The above is true only when the unit distance is a positive number. When this is set to 0.0, the gravity will be constant regardless of distance.

var gravity_space_override = SPACE_OVERRIDE_DISABLED#

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

var linear_damp: float = 0.1#

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

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

var linear_damp_space_override = SPACE_OVERRIDE_DISABLED#

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

var monitorable: bool = true#

If true, other monitoring areas can detect this area.

var monitoring: bool = true#

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

var priority: int = 0#

The area's priority. Higher priority areas are processed first. The World2D's physics is always processed last, after all areas.

Methods #

Annotations #

Constants #

const SPACE_OVERRIDE_DISABLED = 0 enum SpaceOverride#

This area does not affect gravity/damping.

const SPACE_OVERRIDE_COMBINE = 1 enum SpaceOverride#

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

const SPACE_OVERRIDE_COMBINE_REPLACE = 2 enum SpaceOverride#

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

const SPACE_OVERRIDE_REPLACE = 3 enum SpaceOverride#

This area replaces any gravity/damping, even the defaults, ignoring any lower priority areas.

const SPACE_OVERRIDE_REPLACE_COMBINE = 4 enum SpaceOverride#

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

Constructors #

Enums #

SpaceOverride#

Operators #

Signals #

signal area_entered(area: Area2D)#

Emitted when the received area enters this area. Requires monitoring to be set to true.

signal area_exited(area: Area2D)#

Emitted when the received area exits this area. Requires monitoring to be set to true.

signal area_shape_entered(local_shape_index: int)#

Emitted when a Shape2D of the received area enters a shape of this area. Requires monitoring to be set to true.

local_shape_index and area_shape_index contain indices of the interacting shapes from this area and the other area, respectively. area_rid contains the RID of the other area. These values can be used with the PhysicsServer2D.

Example: Get the CollisionShape2D node from the shape index:

var other_shape_owner = area.shape_find_owner(area_shape_index)
var other_shape_node = area.shape_owner_get_owner(other_shape_owner)

var local_shape_owner = shape_find_owner(local_shape_index)
var local_shape_node = shape_owner_get_owner(local_shape_owner)

signal area_shape_exited(local_shape_index: int)#

Emitted when a Shape2D of the received area exits a shape of this area. Requires monitoring to be set to true.

See also area_shape_entered.

signal body_entered(body: Node2D)#

Emitted when the received body enters this area. body can be a PhysicsBody2D or a TileMap. TileMaps are detected if their TileSet has collision shapes configured. Requires monitoring to be set to true.

signal body_exited(body: Node2D)#

Emitted when the received body exits this area. body can be a PhysicsBody2D or a TileMap. TileMaps are detected if their TileSet has collision shapes configured. Requires monitoring to be set to true.

signal body_shape_entered(local_shape_index: int)#

Emitted when a Shape2D of the received body enters a shape of this area. body can be a PhysicsBody2D or a TileMap. TileMaps are detected if their TileSet has collision shapes configured. Requires monitoring to be set to true.

local_shape_index and body_shape_index contain indices of the interacting shapes from this area and the interacting body, respectively. body_rid contains the RID of the body. These values can be used with the PhysicsServer2D.

Example: Get the CollisionShape2D node from the shape index:

var body_shape_owner = body.shape_find_owner(body_shape_index)
var body_shape_node = body.shape_owner_get_owner(body_shape_owner)

var local_shape_owner = shape_find_owner(local_shape_index)
var local_shape_node = shape_owner_get_owner(local_shape_owner)

signal body_shape_exited(local_shape_index: int)#

Emitted when a Shape2D of the received body exits a shape of this area. body can be a PhysicsBody2D or a TileMap. TileMaps are detected if their TileSet has collision shapes configured. Requires monitoring to be set to true.

See also body_shape_entered.

Theme Items #

Tutorials #