Area2D

public float AngularDamp { get; set; }

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.

public Area2D.SpaceOverride AngularDampSpaceOverride { get; set; }

Override mode for angular damping calculations within this area.

public StringName AudioBusName { get; set; }

The name of the area's audio bus.

public bool AudioBusOverride { get; set; }

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

public float Gravity { get; set; }

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.

public Vector2 GravityDirection { get; set; }

The area's gravity vector (not normalized).

public bool GravityPoint { get; set; }

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

public Vector2 GravityPointCenter { get; set; }

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

public float GravityPointUnitDistance { get; set; }

The distance at which the gravity strength is equal to Area2D.Gravity. For example, on a planet 100 pixels in radius with a surface gravity of 4.0 px/s², set the Area2D.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, 4× 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.

public Area2D.SpaceOverride GravitySpaceOverride { get; set; }

Controls combining area gravity with other fields/the world. Gravity = 0 while Disabled does not enable zero gravity; choose an appropriate replacement mode.

public float LinearDamp { get; set; }

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.

public Area2D.SpaceOverride LinearDampSpaceOverride { get; set; }

Override mode for linear damping calculations within this area.

public bool Monitorable { get; set; }

Allows other monitoring areas to detect this Area2D. It does not enable this area's own Monitoring. Defer changes in locked physics callbacks.

public bool Monitoring { get; set; }

Enables this area to detect bodies and areas. Distinct from Monitorable. Change through SetDeferred inside enter/exit handlers because direct changes are blocked during notification.

public int Priority { get; set; }

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

public Reckfell.Collections.Array<Area2D> GetOverlappingAreas();

Returns a list of intersecting Area2Ds. The overlapping area's CollisionObject2D.CollisionLayer must be part of this area's CollisionObject2D.CollisionMask 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.

public Reckfell.Collections.Array<Entity2D> GetOverlappingBodies();

Returns detected bodies from physics-updated state. Immediately after moving or adding a shape, the list may still be old. Requires Monitoring=true; use BodyEntered for entry reactions.

public bool HasOverlappingAreas();

Returns true if intersecting any Area2Ds, otherwise returns false. The overlapping area's CollisionObject2D.CollisionLayer must be part of this area's CollisionObject2D.CollisionMask in order to be detected. For performance reasons (collisions are all processed at the same time) the list of overlapping areas is modified once during the physics step, not immediately after objects are moved. Consider using signals instead.

public bool HasOverlappingBodies();

Returns true if intersecting any PhysicsBody2Ds or TileMaps, otherwise returns false. The overlapping body's CollisionObject2D.CollisionLayer must be part of this area's CollisionObject2D.CollisionMask in order to be detected. For performance reasons (collisions are all processed at the same time) the list of overlapping bodies is modified once during the physics step, not immediately after objects are moved. Consider using signals instead.

public bool OverlapsArea(Entity area);

Returns true if the given Area2D intersects or overlaps this Area2D, false otherwise. Note: The result of this test is not immediate after moving objects. For performance, the list of overlaps is updated once per frame and before the physics step. Consider using signals instead.

public bool OverlapsBody(Entity body);

Returns true if the given physics body intersects or overlaps this Area2D, 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 PhysicsBody2D or a TileMap instance. While TileMaps are not physics bodies themselves, they register their tiles with collision shapes as a virtual physics body.

public event Area2D.AreaEnteredEventHandler AreaEntered;

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

public event Area2D.AreaExitedEventHandler AreaExited;

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

public event Area2D.AreaShapeEnteredEventHandler AreaShapeEntered;

Emitted when a Shape2D of the received area enters a shape of this area. Requires Area2D.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:

public event Area2D.AreaShapeExitedEventHandler AreaShapeExited;

Emitted when a Shape2D of the received area exits a shape of this area. Requires Area2D.Monitoring to be set to true. See also Area2D.AreaShapeEntered.

public event Area2D.BodyEnteredEventHandler BodyEntered;

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 Area2D.Monitoring to be set to true.

public event Area2D.BodyExitedEventHandler BodyExited;

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 Area2D.Monitoring to be set to true.

public event Area2D.BodyShapeEnteredEventHandler BodyShapeEntered;

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

public event Area2D.BodyShapeExitedEventHandler BodyShapeExited;

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 Area2D.Monitoring to be set to true. See also Area2D.BodyShapeEntered.