Files
godot-docs/classes/class_collisionshape.rst
2017-11-27 08:32:15 +01:00

61 lines
2.4 KiB
ReStructuredText

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the CollisionShape.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_CollisionShape:
CollisionShape
==============
**Inherits:** :ref:`Spatial<class_spatial>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Node that represents collision shape data in 3D space.
Member Functions
----------------
+-------+---------------------------------------------------------------------------------------------------------------------+
| void | :ref:`make_convex_from_brothers<class_CollisionShape_make_convex_from_brothers>` **(** **)** |
+-------+---------------------------------------------------------------------------------------------------------------------+
| void | :ref:`resource_changed<class_CollisionShape_resource_changed>` **(** :ref:`Resource<class_resource>` resource **)** |
+-------+---------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
.. _class_CollisionShape_disabled:
- :ref:`bool<class_bool>` **disabled** - A disabled collision shape has no effect in the world.
.. _class_CollisionShape_shape:
- :ref:`Shape<class_shape>` **shape** - The actual shape owned by this collision shape.
Description
-----------
Editor facility for creating and editing collision shapes in 3D space. You can use this node to represent all sorts of collision shapes, for example, add this to an :ref:`Area<class_area>` to give it a detection shape, or add it to a :ref:`PhysicsBody<class_physicsbody>` to give create solid object. **IMPORTANT**: this is an Editor-only helper to create shapes, use :ref:`get_shape<class_CollisionShape_get_shape>` to get the actual shape.
Member Function Description
---------------------------
.. _class_CollisionShape_make_convex_from_brothers:
- void **make_convex_from_brothers** **(** **)**
Sets the collision shape's shape to the addition of all its convexed :ref:`MeshInstance<class_meshinstance>` siblings geometry.
.. _class_CollisionShape_resource_changed:
- void **resource_changed** **(** :ref:`Resource<class_resource>` resource **)**
If this method exists within a script it will be called whenever the shape resource has been modified.