: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/CollisionShape3D.xml. .. _class_CollisionShape3D: CollisionShape3D ================ **Inherits:** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` A node that provides a :ref:`Shape3D` to a :ref:`CollisionObject3D` parent. .. rst-class:: classref-introduction-group Description ----------- A node that provides a :ref:`Shape3D` to a :ref:`CollisionObject3D` parent and allows to edit it. This can give a detection shape to an :ref:`Area3D` or turn a :ref:`PhysicsBody3D` into a solid object. \ **Warning:** A non-uniformly scaled **CollisionShape3D** will likely not behave as expected. Make sure to keep its scale the same on all axes and adjust its :ref:`shape` resource instead. .. rst-class:: classref-introduction-group Tutorials --------- - :doc:`Physics introduction <../tutorials/physics/physics_introduction>` - `3D Kinematic Character Demo `__ - `3D Platformer Demo `__ - `Third Person Shooter (TPS) Demo `__ .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-------------------------------+-----------------------------------------------------------------+-----------------------+ | :ref:`Color` | :ref:`debug_color` | ``Color(0, 0, 0, 0)`` | +-------------------------------+-----------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`debug_fill` | ``true`` | +-------------------------------+-----------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`disabled` | ``false`` | +-------------------------------+-----------------------------------------------------------------+-----------------------+ | :ref:`Shape3D` | :ref:`shape` | | +-------------------------------+-----------------------------------------------------------------+-----------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +--------+---------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`make_convex_from_siblings`\ (\ ) | +--------+---------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`resource_changed`\ (\ resource\: :ref:`Resource`\ ) | +--------+---------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_CollisionShape3D_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_CollisionShape3D_property_debug_fill: .. rst-class:: classref-property :ref:`bool` **debug_fill** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_enable_debug_fill**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **get_enable_debug_fill**\ (\ ) If ``true``, when the shape is displayed, it will show a solid fill color in addition to its wireframe. .. rst-class:: classref-item-separator ---- .. _class_CollisionShape3D_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_CollisionShape3D_property_shape: .. rst-class:: classref-property :ref:`Shape3D` **shape** :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_shape**\ (\ value\: :ref:`Shape3D`\ ) - :ref:`Shape3D` **get_shape**\ (\ ) The actual shape owned by this collision shape. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_CollisionShape3D_method_make_convex_from_siblings: .. rst-class:: classref-method |void| **make_convex_from_siblings**\ (\ ) :ref:`🔗` Sets the collision shape's shape to the addition of all its convexed :ref:`MeshInstance3D` siblings geometry. .. rst-class:: classref-item-separator ---- .. _class_CollisionShape3D_method_resource_changed: .. rst-class:: classref-method |void| **resource_changed**\ (\ resource\: :ref:`Resource`\ ) :ref:`🔗` **Deprecated:** Use :ref:`Resource.changed` instead. This method does nothing. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |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.)`