godot-docs/classes/class_collisionshape2d.rst

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the CollisionShape2D.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_CollisionShape2D:

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

**Inherits:** :ref:`Node2D<class_Node2D>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`

**Category:** Core

Brief Description
-----------------

Node that represents collision shape data in 2D space.

Properties
----------

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

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:`../tutorials/physics/physics_introduction`

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

.. _class_CollisionShape2D_property_disabled:

- :ref:`bool<class_bool>` **disabled**

+----------+---------------------+
| *Setter* | set_disabled(value) |
+----------+---------------------+
| *Getter* | is_disabled()       |
+----------+---------------------+

A disabled collision shape has no effect in the world.

.. _class_CollisionShape2D_property_one_way_collision:

- :ref:`bool<class_bool>` **one_way_collision**

+----------+--------------------------------+
| *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).

.. _class_CollisionShape2D_property_one_way_collision_margin:

- :ref:`float<class_float>` **one_way_collision_margin**

+----------+-------------------------------------+
| *Setter* | set_one_way_collision_margin(value) |
+----------+-------------------------------------+
| *Getter* | get_one_way_collision_margin()      |
+----------+-------------------------------------+

.. _class_CollisionShape2D_property_shape:

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

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

The actual shape owned by this collision shape.