ShapeCast2D

public bool CollideWithAreas { get; set; }

If true, collisions with Area2Ds will be reported.

public bool CollideWithBodies { get; set; }

If true, collisions with PhysicsBody2Ds will be reported.

public uint CollisionMask { get; set; }

The shape's collision mask. Only objects in at least one collision layer enabled in the mask will be detected. See Collision layers and masks in the documentation for more information.

public Reckfell.Collections.Array CollisionResult { get; }

Returns the complete collision information from the collision sweep. The data returned is the same as in the PhysicsDirectSpaceState2D.GetRestInfo method.

public bool Enabled { get; set; }

If true, collisions will be reported.

public bool ExcludeParent { get; set; }

If true, the parent node will be excluded from collision detection.

public float Margin { get; set; }

The collision margin for the shape. A larger margin helps detecting collisions more consistently, at the cost of precision.

public int MaxResults { get; set; }

The number of intersections can be limited with this parameter, to reduce the processing time.

public Shape2D Shape { get; set; }

The shape to be used for collision queries.

public Vector2 TargetPosition { get; set; }

The shape's destination point, relative to this node's Entity2D.Position.

public void AddException(CollisionObject2D node);

Adds a collision exception so the shape does not report collisions with the specified node.

public void AddExceptionRid(Rid rid);

Adds a collision exception so the shape does not report collisions with the specified Rid.

public void ClearExceptions();

Removes all collision exceptions for this shape.

public void ForceShapecastUpdate();

Updates the collision information for the shape immediately, without waiting for the next _physics_process call. Use this method, for example, when the shape or its parent has changed state. Note: Setting ShapeCast2D.Enabled to true is not required for this to work.

public float GetClosestCollisionSafeFraction();

Returns the fraction from this cast's origin to its ShapeCast2D.TargetPosition of how far the shape can move without triggering a collision, as a value between 0.0 and 1.0.

public float GetClosestCollisionUnsafeFraction();

Returns the fraction from this cast's origin to its ShapeCast2D.TargetPosition of how far the shape must move to trigger a collision, as a value between 0.0 and 1.0. In ideal conditions this would be the same as ShapeCast2D.GetClosestCollisionSafeFraction, however shape casting is calculated in discrete steps, so the precise point of collision can occur between two calculated positions.

public ReckfellObject GetCollider(int index);

Returns the collided ReckfellObject of one of the multiple collisions at index, or null if no object is intersecting the shape (i.e. ShapeCast2D.IsColliding returns false).

public Rid GetColliderRid(int index);

Returns the Rid of the collided object of one of the multiple collisions at index.

public int GetColliderShape(int index);

Returns the shape ID of the colliding shape of one of the multiple collisions at index, or 0 if no object is intersecting the shape (i.e. ShapeCast2D.IsColliding returns false).

public int GetCollisionCount();

The number of collisions detected at the point of impact. Use this to iterate over multiple collisions as provided by ShapeCast2D.GetCollider, ShapeCast2D.GetColliderShape, ShapeCast2D.GetCollisionPoint, and ShapeCast2D.GetCollisionNormal methods.

public bool GetCollisionMaskValue(int layerNumber);

Returns whether or not the specified layer of the ShapeCast2D.CollisionMask is enabled, given a layer_number between 1 and 32.

public Vector2 GetCollisionNormal(int index);

Returns the normal of one of the multiple collisions at index of the intersecting object.

public Vector2 GetCollisionPoint(int index);

Returns the collision point of one of the multiple collisions at index where the shape intersects the colliding object. Note: This point is in the global coordinate system.

public bool IsColliding();

Returns whether any object is intersecting with the shape's vector (considering the vector length).

public void RemoveException(CollisionObject2D node);

Removes a collision exception so the shape does report collisions with the specified node.

public void RemoveExceptionRid(Rid rid);

Removes a collision exception so the shape does report collisions with the specified Rid.

public void SetCollisionMaskValue(int layerNumber, bool value);

Based on value, enables or disables the specified layer in the ShapeCast2D.CollisionMask, given a layer_number between 1 and 32.