Area3D

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/3d/default_angular_damp for more details about damping.

public Area3D.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 meters per second squared). This value multiplies the gravity direction. This is useful to alter the force of gravity without altering its direction.

public Vector3 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 Area3D.GravityPointCenter). See also Area3D.GravitySpaceOverride.

public Vector3 GravityPointCenter { get; set; }

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

public float GravityPointUnitDistance { get; set; }

The distance at which the gravity strength is equal to Area3D.Gravity. For example, on a planet 100 meters in radius with a surface gravity of 4.0 m/s², set the Area3D.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 meters from the center the gravity will be 1.0 m/s² (twice the distance, 1/4th the gravity), at 50 meters it will be 16.0 m/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 Area3D.SpaceOverride GravitySpaceOverride { get; set; }

Override mode for gravity calculations within this area.

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/3d/default_linear_damp for more details about damping.

public Area3D.SpaceOverride LinearDampSpaceOverride { get; set; }

Override mode for linear damping calculations within this area.

public bool Monitorable { get; set; }

If true, other monitoring areas can detect this area.

public bool Monitoring { get; set; }

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

public int Priority { get; set; }

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

public float ReverbBusAmount { get; set; }

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

public bool ReverbBusEnabled { get; set; }

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

public StringName ReverbBusName { get; set; }

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

public float ReverbBusUniformity { get; set; }

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

public float WindAttenuationFactor { get; set; }

The exponential rate at which wind force decreases with distance from its origin. Note: This wind force only applies to SoftBody3D nodes. Other physics bodies are currently not affected by wind.

public float WindForceMagnitude { get; set; }

The magnitude of area-specific wind force. Note: This wind force only applies to SoftBody3D nodes. Other physics bodies are currently not affected by wind.

public EntityPath WindSourcePath { get; set; }

The Entity3D which is used to specify the direction and origin of an area-specific wind force. The direction is opposite to the z-axis of the Entity3D's local transform, and its origin is the origin of the Entity3D's local transform. Note: This wind force only applies to SoftBody3D nodes. Other physics bodies are currently not affected by wind.

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

Returns a list of intersecting Area3Ds. The overlapping area's CollisionObject3D.CollisionLayer must be part of this area's CollisionObject3D.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<Entity3D> GetOverlappingBodies();

Returns detected collision objects as Entity3D; test the required gameplay type with is. The object layer must match the area mask and monitoring must be enabled. The list updates on physics steps, not immediately after creation or movement. When a response depends on changing state during an existing overlap, polling the list can remain necessary after the initial BodyEntered().

public bool HasOverlappingAreas();

Returns true if intersecting any Area3Ds, otherwise returns false. The overlapping area's CollisionObject3D.CollisionLayer must be part of this area's CollisionObject3D.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 PhysicsBody3Ds, SoftBody3Ds, or GridMaps, otherwise returns false. The overlapping body's CollisionObject3D.CollisionLayer must be part of this area's CollisionObject3D.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. Note: Reckfell Physics does not support reporting overlaps with SoftBody3D, so will not consider such bodies.

public bool OverlapsArea(Entity area);

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.

public bool OverlapsBody(Entity body);

Returns true if the given physics body intersects or overlaps this Area3D, false otherwise. body argument can either be a PhysicsBody3D, SoftBody3D, or a GridMap instance. While GridMaps are not physics body themselves, they register their tiles with collision shapes as a virtual physics body. 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. Note: Reckfell Physics does not support reporting overlaps with SoftBody3D, so will return false in such cases.

public event Area3D.AreaEnteredEventHandler AreaEntered;

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

public event Area3D.AreaExitedEventHandler AreaExited;

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

public event Area3D.AreaShapeEnteredEventHandler AreaShapeEntered;

Emitted when a Shape3D of the received area enters a shape of this area. Requires Area3D.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 PhysicsServer3D. Example: Get the CollisionShape3D node from the shape index:

public event Area3D.AreaShapeExitedEventHandler AreaShapeExited;

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

public event Area3D.BodyEnteredEventHandler BodyEntered;

Emitted when the received body enters this area. body can be a PhysicsBody3D, SoftBody3D or GridMap. GridMaps are detected if their MeshLibrary has collision shapes configured. Requires Area3D.Monitoring to be set to true. Note: Reckfell Physics does not support reporting overlaps with SoftBody3D, so will not emit this signal in such cases.

public event Area3D.BodyExitedEventHandler BodyExited;

Emitted when the received body exits this area. body can be a PhysicsBody3D, SoftBody3D or GridMap. GridMaps are detected if their MeshLibrary has collision shapes configured. Requires Area3D.Monitoring to be set to true. Note: Reckfell Physics does not support reporting overlaps with SoftBody3D, so will not emit this signal in such cases.

public event Area3D.BodyShapeEnteredEventHandler BodyShapeEntered;

Emitted when a Shape3D of the received body enters a shape of this area. body can be a PhysicsBody3D, SoftBody3D or GridMap. GridMaps are detected if their MeshLibrary has collision shapes configured. Requires Area3D.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 PhysicsServer3D. Note: Reckfell Physics does not support reporting overlaps with SoftBody3D, so will not emit this signal in such cases. Example: Get the CollisionShape3D node from the shape index:

public event Area3D.BodyShapeExitedEventHandler BodyShapeExited;

Emitted when a Shape3D of the received body exits a shape of this area. body can be a PhysicsBody3D, SoftBody3D or GridMap. GridMaps are detected if their MeshLibrary has collision shapes configured. Requires Area3D.Monitoring to be set to true. See also Area3D.BodyShapeEntered. Note: Reckfell Physics does not support reporting overlaps with SoftBody3D, so will not emit this signal in such cases.