Class reference

CollisionShape2D

Inherits Node2D

A node that provides a Shape2D to a CollisionObject2D parent.

Description

A node that provides a Shape2D to a CollisionObject2D parent and allows to edit it. This can give a detection shape to an Area2D or turn a PhysicsBody2D into a solid object.

Properties

Color debug_color = Color(0, 0, 0, 0)

The collision shape color that is displayed in the editor, or in the running project if Debug > Visible Collision Shapes is checked at the top of the editor. Note: The default value is ProjectSettings.debug/shapes/collision/shape_color. The Color(0, 0, 0, 0) value documented here is a placeholder, and not the actual default debug color.

bool disabled = false

A disabled collision shape has no effect in the world. This property should be changed with Object.set_deferred().

bool one_way_collision = false

Sets whether this collision shape should only detect collision on one side (top or bottom). Note: This property has no effect if this CollisionShape2D is a child of an Area2D node.

float one_way_collision_margin = 1.0

The margin used for one-way collision (in pixels). Higher values will make the shape thicker, and work better for colliders that enter the shape at a high velocity.

Shape2D shape

The actual shape owned by this collision shape.

Tutorials

Source revision 4f5b14abade2
Connection interrupted. Reload×

Rejoining the server...

Rejoin failed... trying again in seconds.

Failed to rejoin.
Please retry or reload the page.

The session has been paused by the server.

Failed to resume the session.
Please retry or reload the page.