Description

Abstract base class for all 2D shapes, intended for use in physics.

Performance: Primitive shapes, especiallyCircleShape2D, are fast to check collisions against.ConvexPolygonShape2D is slower, andConcavePolygonShape2D is the slowest.

Tutorials

• Physics introduction

Properties

Methods

Property Descriptions

floatcustom_solver_bias =0.0🔗

• voidset_custom_solver_bias(value:float)

• floatget_custom_solver_bias()

The shape's custom solver bias. Defines how much bodies react to enforce contact separation when this shape is involved.

When set to0, the default value fromProjectSettings.physics/2d/solver/default_contact_bias is used.

Method Descriptions

boolcollide(local_xform:Transform2D, with_shape:Shape2D, shape_xform:Transform2D)🔗

Returnstrue if this shape is colliding with another.

This method needs the transformation matrix for this shape (local_xform), the shape to check collisions with (with_shape), and the transformation matrix of that shape (shape_xform).

PackedVector2Arraycollide_and_get_contacts(local_xform:Transform2D, with_shape:Shape2D, shape_xform:Transform2D)🔗

Returns a list of contact point pairs where this shape touches another.

If there are no collisions, the returned list is empty. Otherwise, the returned list contains contact points arranged in pairs, with entries alternating between points on the boundary of this shape and points on the boundary ofwith_shape.

A collision pair A, B can be used to calculate the collision normal with(B-A).normalized(), and the collision depth with(B-A).length(). This information is typically used to separate shapes, particularly in collision solvers.

This method needs the transformation matrix for this shape (local_xform), the shape to check collisions with (with_shape), and the transformation matrix of that shape (shape_xform).

boolcollide_with_motion(local_xform:Transform2D, local_motion:Vector2, with_shape:Shape2D, shape_xform:Transform2D, shape_motion:Vector2)🔗

Returns whether this shape would collide with another, if a given movement was applied.

This method needs the transformation matrix for this shape (local_xform), the movement to test on this shape (local_motion), the shape to check collisions with (with_shape), the transformation matrix of that shape (shape_xform), and the movement to test onto the other object (shape_motion).

PackedVector2Arraycollide_with_motion_and_get_contacts(local_xform:Transform2D, local_motion:Vector2, with_shape:Shape2D, shape_xform:Transform2D, shape_motion:Vector2)🔗

Returns a list of contact point pairs where this shape would touch another, if a given movement was applied.

If there would be no collisions, the returned list is empty. Otherwise, the returned list contains contact points arranged in pairs, with entries alternating between points on the boundary of this shape and points on the boundary ofwith_shape.

A collision pair A, B can be used to calculate the collision normal with(B-A).normalized(), and the collision depth with(B-A).length(). This information is typically used to separate shapes, particularly in collision solvers.

This method needs the transformation matrix for this shape (local_xform), the movement to test on this shape (local_motion), the shape to check collisions with (with_shape), the transformation matrix of that shape (shape_xform), and the movement to test onto the other object (shape_motion).

voiddraw(canvas_item:RID, color:Color)🔗

Draws a solid shape onto aCanvasItem with theRenderingServer API filled with the specifiedcolor. The exact drawing method is specific for each shape and cannot be configured.

Rect2get_rect()const🔗

Returns aRect2 representing the shapes boundary.