: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` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` A node that provides a :ref:`Shape2D` to a :ref:`CollisionObject2D` parent. .. rst-class:: classref-introduction-group Description ----------- A node that provides a :ref:`Shape2D` to a :ref:`CollisionObject2D` parent and allows to edit it. This can give a detection shape to an :ref:`Area2D` or turn a :ref:`PhysicsBody2D` into a solid object. .. rst-class:: classref-introduction-group Tutorials --------- - :doc:`Physics introduction <../tutorials/physics/physics_introduction>` - `2D Dodge The Creeps Demo `__ - `2D Pong Demo `__ - `2D Kinematic Character Demo `__ .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-------------------------------+-------------------------------------------------------------------------------------------+-----------------------+ | :ref:`Color` | :ref:`debug_color` | ``Color(0, 0, 0, 0)`` | +-------------------------------+-------------------------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`disabled` | ``false`` | +-------------------------------+-------------------------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`one_way_collision` | ``false`` | +-------------------------------+-------------------------------------------------------------------------------------------+-----------------------+ | :ref:`float` | :ref:`one_way_collision_margin` | ``1.0`` | +-------------------------------+-------------------------------------------------------------------------------------------+-----------------------+ | :ref:`Shape2D` | :ref:`shape` | | +-------------------------------+-------------------------------------------------------------------------------------------+-----------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_CollisionShape2D_property_debug_color: .. rst-class:: classref-property :ref:`Color` **debug_color** = ``Color(0, 0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_debug_color**\ (\ value\: :ref:`Color`\ ) - :ref:`Color` **get_debug_color**\ (\ ) 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 :ref:`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. .. rst-class:: classref-item-separator ---- .. _class_CollisionShape2D_property_disabled: .. rst-class:: classref-property :ref:`bool` **disabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_disabled**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_disabled**\ (\ ) A disabled collision shape has no effect in the world. This property should be changed with :ref:`Object.set_deferred()`. .. rst-class:: classref-item-separator ---- .. _class_CollisionShape2D_property_one_way_collision: .. rst-class:: classref-property :ref:`bool` **one_way_collision** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_one_way_collision**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **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` node. .. rst-class:: classref-item-separator ---- .. _class_CollisionShape2D_property_one_way_collision_margin: .. rst-class:: classref-property :ref:`float` **one_way_collision_margin** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_one_way_collision_margin**\ (\ value\: :ref:`float`\ ) - :ref:`float` **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. .. rst-class:: classref-item-separator ---- .. _class_CollisionShape2D_property_shape: .. rst-class:: classref-property :ref:`Shape2D` **shape** :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_shape**\ (\ value\: :ref:`Shape2D`\ ) - :ref:`Shape2D` **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.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` .. |void| replace:: :abbr:`void (No return value.)`