CollisionShape2D

CollisionShape2D

Inherits: Node2D < CanvasItem < Node < Object

Node that represents collision shape data in 2D space.

Description

Editor facility for creating and editing collision shapes in 2D space. You can use this node to represent all sorts of collision shapes, for example, add this to an Area2D to give it a detection shape, or add it to a PhysicsBody2D to create a solid object. IMPORTANT: this is an Editor-only helper to create shapes, use CollisionObject2D.shape_owner_get_shape to get the actual shape.

Tutorials

Properties

bool	disabled	`false`
bool	one_way_collision	`false`
float	one_way_collision_margin	`1.0`
Shape2D	shape

Property Descriptions

bool disabled

Default	`false`
Setter	set_disabled(value)
Getter	is_disabled()

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

bool one_way_collision

Default	`false`
Setter	set_one_way_collision(value)
Getter	is_one_way_collision_enabled()

Sets whether this collision shape should only detect collision on one side (top or bottom).

float one_way_collision_margin

Default	`1.0`
Setter	set_one_way_collision_margin(value)
Getter	get_one_way_collision_margin()

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

Setter	set_shape(value)
Getter	get_shape()

The actual shape owned by this collision shape.