godot-docs/classes/class_collisionshape2d.rst

:github_url: hide

.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CollisionShape2D.xml.

.. _class_CollisionShape2D:

CollisionShape2D
================

**Inherits:** :ref:`Node2D<class_Node2D>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_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 :ref:`Area2D<class_Area2D>` to give it a detection shape, or add it to a :ref:`PhysicsBody2D<class_PhysicsBody2D>` to create a solid object. **IMPORTANT**: this is an Editor-only helper to create shapes, use :ref:`CollisionObject2D.shape_owner_get_shape<class_CollisionObject2D_method_shape_owner_get_shape>` to get the actual shape.

Tutorials
---------

- :doc:`Physics introduction <../tutorials/physics/physics_introduction>`

- `2D Dodge The Creeps Demo <https://godotengine.org/asset-library/asset/515>`__

- `2D Pong Demo <https://godotengine.org/asset-library/asset/121>`__

- `2D Kinematic Character Demo <https://godotengine.org/asset-library/asset/113>`__

Properties
----------

+-------------------------------+-------------------------------------------------------------------------------------------+-----------+
| :ref:`bool<class_bool>`       | :ref:`disabled<class_CollisionShape2D_property_disabled>`                                 | ``false`` |
+-------------------------------+-------------------------------------------------------------------------------------------+-----------+
| :ref:`bool<class_bool>`       | :ref:`one_way_collision<class_CollisionShape2D_property_one_way_collision>`               | ``false`` |
+-------------------------------+-------------------------------------------------------------------------------------------+-----------+
| :ref:`float<class_float>`     | :ref:`one_way_collision_margin<class_CollisionShape2D_property_one_way_collision_margin>` | ``1.0``   |
+-------------------------------+-------------------------------------------------------------------------------------------+-----------+
| :ref:`Shape2D<class_Shape2D>` | :ref:`shape<class_CollisionShape2D_property_shape>`                                       |           |
+-------------------------------+-------------------------------------------------------------------------------------------+-----------+

Property Descriptions
---------------------

.. _class_CollisionShape2D_property_disabled:

- :ref:`bool<class_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 :ref:`Object.set_deferred<class_Object_method_set_deferred>`.

----

.. _class_CollisionShape2D_property_one_way_collision:

- :ref:`bool<class_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).

\ **Note:** This property has no effect if this ``CollisionShape2D`` is a child of an :ref:`Area2D<class_Area2D>` node.

----

.. _class_CollisionShape2D_property_one_way_collision_margin:

- :ref:`float<class_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.

----

.. _class_CollisionShape2D_property_shape:

- :ref:`Shape2D<class_Shape2D>` **shape**

+----------+------------------+
| *Setter* | set_shape(value) |
+----------+------------------+
| *Getter* | get_shape()      |
+----------+------------------+

The actual shape owned by this collision shape.

.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`