| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899 |
- :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/CylinderShape3D.xml.
- .. _class_CylinderShape3D:
- CylinderShape3D
- ===============
- **Inherits:** :ref:`Shape3D<class_Shape3D>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
- A 3D cylinder shape used for physics collision.
- .. rst-class:: classref-introduction-group
- Description
- -----------
- A 3D cylinder shape, intended for use in physics. Usually used to provide a shape for a :ref:`CollisionShape3D<class_CollisionShape3D>`.
- \ **Note:** There are several known bugs with cylinder collision shapes. Using :ref:`CapsuleShape3D<class_CapsuleShape3D>` or :ref:`BoxShape3D<class_BoxShape3D>` instead is recommended.
- \ **Performance:** **CylinderShape3D** is fast to check collisions against, but it is slower than :ref:`CapsuleShape3D<class_CapsuleShape3D>`, :ref:`BoxShape3D<class_BoxShape3D>`, and :ref:`SphereShape3D<class_SphereShape3D>`.
- .. rst-class:: classref-introduction-group
- Tutorials
- ---------
- - `Third Person Shooter Demo <https://godotengine.org/asset-library/asset/678>`__
- - `3D Physics Tests Demo <https://godotengine.org/asset-library/asset/675>`__
- - `3D Voxel Demo <https://godotengine.org/asset-library/asset/676>`__
- .. rst-class:: classref-reftable-group
- Properties
- ----------
- .. table::
- :widths: auto
- +---------------------------+------------------------------------------------------+---------+
- | :ref:`float<class_float>` | :ref:`height<class_CylinderShape3D_property_height>` | ``2.0`` |
- +---------------------------+------------------------------------------------------+---------+
- | :ref:`float<class_float>` | :ref:`radius<class_CylinderShape3D_property_radius>` | ``0.5`` |
- +---------------------------+------------------------------------------------------+---------+
- .. rst-class:: classref-section-separator
- ----
- .. rst-class:: classref-descriptions-group
- Property Descriptions
- ---------------------
- .. _class_CylinderShape3D_property_height:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **height** = ``2.0``
- .. rst-class:: classref-property-setget
- - void **set_height** **(** :ref:`float<class_float>` value **)**
- - :ref:`float<class_float>` **get_height** **(** **)**
- The cylinder's height.
- .. rst-class:: classref-item-separator
- ----
- .. _class_CylinderShape3D_property_radius:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **radius** = ``0.5``
- .. rst-class:: classref-property-setget
- - void **set_radius** **(** :ref:`float<class_float>` value **)**
- - :ref:`float<class_float>` **get_radius** **(** **)**
- The cylinder's radius.
- .. |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.)`
|
