| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103 |
- :github_url: hide
- .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the CollisionShape3D.xml source instead.
- .. The source is found in doc/classes or modules/<name>/doc_classes.
- .. _class_CollisionShape3D:
- CollisionShape3D
- ================
- **Inherits:** :ref:`Node3D<class_Node3D>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
- Node that represents collision shape data in 3D space.
- 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:`Area3D<class_Area3D>` to give it a detection shape, or add it to a :ref:`PhysicsBody3D<class_PhysicsBody3D>` to create a solid object. **IMPORTANT**: this is an Editor-only helper to create shapes, use :ref:`CollisionObject3D.shape_owner_get_shape<class_CollisionObject3D_method_shape_owner_get_shape>` to get the actual shape.
- Tutorials
- ---------
- - :doc:`Physics introduction <../tutorials/physics/physics_introduction>`
- - `3D Kinematic Character Demo <https://godotengine.org/asset-library/asset/126>`__
- - `3D Platformer Demo <https://godotengine.org/asset-library/asset/125>`__
- - `Third Person Shooter Demo <https://godotengine.org/asset-library/asset/678>`__
- Properties
- ----------
- +-------------------------------+-----------------------------------------------------------+-----------+
- | :ref:`bool<class_bool>` | :ref:`disabled<class_CollisionShape3D_property_disabled>` | ``false`` |
- +-------------------------------+-----------------------------------------------------------+-----------+
- | :ref:`Shape3D<class_Shape3D>` | :ref:`shape<class_CollisionShape3D_property_shape>` | |
- +-------------------------------+-----------------------------------------------------------+-----------+
- Methods
- -------
- +------+------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`make_convex_from_siblings<class_CollisionShape3D_method_make_convex_from_siblings>` **(** **)** |
- +------+------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`resource_changed<class_CollisionShape3D_method_resource_changed>` **(** :ref:`Resource<class_Resource>` resource **)** |
- +------+------------------------------------------------------------------------------------------------------------------------------+
- Property Descriptions
- ---------------------
- .. _class_CollisionShape3D_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.
- ----
- .. _class_CollisionShape3D_property_shape:
- - :ref:`Shape3D<class_Shape3D>` **shape**
- +----------+------------------+
- | *Setter* | set_shape(value) |
- +----------+------------------+
- | *Getter* | get_shape() |
- +----------+------------------+
- The actual shape owned by this collision shape.
- Method Descriptions
- -------------------
- .. _class_CollisionShape3D_method_make_convex_from_siblings:
- - void **make_convex_from_siblings** **(** **)**
- Sets the collision shape's shape to the addition of all its convexed :ref:`MeshInstance3D<class_MeshInstance3D>` siblings geometry.
- ----
- .. _class_CollisionShape3D_method_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.
- .. |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.)`
|
