Skip to content

Latest commit

 

History

History
98 lines (60 loc) · 3.61 KB

class_cylindershape3d.rst

File metadata and controls

98 lines (60 loc) · 3.61 KB
github_url:hide

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

.. rst-class:: classref-reftable-group

Properties

: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

.. rst-class:: classref-property

:ref:`float<class_float>` height = 2.0

.. rst-class:: classref-property-setget

The cylinder's height.

.. rst-class:: classref-item-separator


.. rst-class:: classref-property

:ref:`float<class_float>` radius = 0.5

.. rst-class:: classref-property-setget

The cylinder's radius.