Class ShapeCast2D

A 2D shape that sweeps a region of space to detect CollisionObject2Ds.

Inheritance

Node2D

CanvasItem

Node

Object

ShapeCast2D

Remarks

Shape casting allows to detect collision objects by sweeping its shape along the cast direction determined by target_position. This is similar to RayCast2D, but it allows for sweeping a region of space, rather than just a straight line. ShapeCast2D can detect multiple collision objects. It is useful for things like wide laser beams or snapping a simple shape to a floor.

Immediate collision overlaps can be done with the target_position set to Vector2(0, 0) and by calling force_shapecast_update within the same physics frame. This helps to overcome some limitations of Area2D when used as an instantaneous detection area, as collision information isn't immediately available to it.

Note: Shape casting is more computationally expensive than ray casting.

Properties

collide_with_areas

If true, collisions with Area2Ds will be reported.

var collide_with_areas : bool = false

Property Value

bool

Remarks

• void set_collide_with_areas(bool value)
• bool is_collide_with_areas_enabled

collide_with_bodies

If true, collisions with PhysicsBody2Ds will be reported.

var collide_with_bodies : bool = true

Property Value

bool

Remarks

• void set_collide_with_bodies(bool value)
• bool is_collide_with_bodies_enabled

collision_mask

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.

var collision_mask : int = 1

Property Value

int

Remarks

• void set_collision_mask(int value)
• int get_collision_mask

collision_result

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

var collision_result : Array = []

Property Value

Array

Remarks

• Array get_collision_result

enabled

If true, collisions will be reported.

var enabled : bool = true

Property Value

bool

Remarks

• void set_enabled(bool value)
• bool is_enabled

exclude_parent

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

var exclude_parent : bool = true

Property Value

bool

Remarks

• void set_exclude_parent_body(bool value)
• bool get_exclude_parent_body

margin

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

var margin : float = 0.0

Property Value

float

Remarks

• void set_margin(float value)
• float get_margin

max_results

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

var max_results : int = 32

Property Value

int

Remarks

• void set_max_results(int value)
• int get_max_results

shape

The shape to be used for collision queries.

var shape : Shape2D

Property Value

Shape2D

Remarks

• void set_shape(Shape2D value)
• Shape2D get_shape

target_position

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

var target_position : Vector2 = Vector2(0, 50)

Property Value

Vector2

Remarks

• void set_target_position(Vector2 value)
• Vector2 get_target_position

Methods

add_exception(CollisionObject2D)

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

void add_exception(CollisionObject2D node)

Parameters

node CollisionObject2D

add_exception_rid(RID)

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

void add_exception_rid(RID rid)

Parameters

rid RID

clear_exceptions

Removes all collision exceptions for this shape.

void clear_exceptions

force_shapecast_update

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 enabled to true is not required for this to work.

void force_shapecast_update

get_closest_collision_safe_fraction

Qualifiers: const

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

float get_closest_collision_safe_fraction

get_closest_collision_unsafe_fraction

Qualifiers: const

Returns the fraction from this cast's origin to its target_position 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 get_closest_collision_safe_fraction, however shape casting is calculated in discrete steps, so the precise point of collision can occur between two calculated positions.

float get_closest_collision_unsafe_fraction

get_collider(int)

Qualifiers: const

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

Object get_collider(int index)

Parameters

index int

get_collider_rid(int)

Qualifiers: const

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

RID get_collider_rid(int index)

Parameters

index int

get_collider_shape(int)

Qualifiers: const

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. is_colliding returns false).

int get_collider_shape(int index)

Parameters

index int

get_collision_count

Qualifiers: const

The number of collisions detected at the point of impact. Use this to iterate over multiple collisions as provided by ShapeCast2D.get_collider, ShapeCast2D.get_collider_shape, ShapeCast2D.get_collision_point, and ShapeCast2D.get_collision_normal methods.

int get_collision_count

get_collision_mask_value(int)

Qualifiers: const

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

bool get_collision_mask_value(int layer_number)

Parameters

layer_number int

get_collision_normal(int)

Qualifiers: const

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

Vector2 get_collision_normal(int index)

Parameters

index int

get_collision_point(int)

Qualifiers: const

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.

Vector2 get_collision_point(int index)

Parameters

index int

is_colliding

Qualifiers: const

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

bool is_colliding

remove_exception(CollisionObject2D)

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

void remove_exception(CollisionObject2D node)

Parameters

node CollisionObject2D

remove_exception_rid(RID)

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

void remove_exception_rid(RID rid)

Parameters

rid RID

set_collision_mask_value(int, bool)

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

void set_collision_mask_value(int layer_number, bool value)

Parameters

layer_number int

value bool