94 lines
3 KiB
Text
94 lines
3 KiB
Text
|
:github_url: hide
|
||
|
|
||
|
.. DO NOT EDIT THIS FILE!!!
|
||
|
.. Generated automatically from Godot engine sources.
|
||
|
.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py.
|
||
|
.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/CylinderShape.xml.
|
||
|
|
||
|
.. _class_CylinderShape:
|
||
|
|
||
|
CylinderShape
|
||
|
=============
|
||
|
|
||
|
**Inherits:** :ref:`Shape<class_Shape>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
|
||
|
|
||
|
Cylinder shape for collisions.
|
||
|
|
||
|
.. rst-class:: classref-introduction-group
|
||
|
|
||
|
Description
|
||
|
-----------
|
||
|
|
||
|
Cylinder shape for collisions.
|
||
|
|
||
|
\ **Note:** When using GodotPhysics instead of the default Bullet physics engine, there are several known bugs with cylinder collision shapes. Using :ref:`CapsuleShape<class_CapsuleShape>` or :ref:`BoxShape<class_BoxShape>` instead is recommended.
|
||
|
|
||
|
.. 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_CylinderShape_property_height>` | ``2.0`` |
|
||
|
+---------------------------+----------------------------------------------------+---------+
|
||
|
| :ref:`float<class_float>` | :ref:`radius<class_CylinderShape_property_radius>` | ``1.0`` |
|
||
|
+---------------------------+----------------------------------------------------+---------+
|
||
|
|
||
|
.. rst-class:: classref-section-separator
|
||
|
|
||
|
----
|
||
|
|
||
|
.. rst-class:: classref-descriptions-group
|
||
|
|
||
|
Property Descriptions
|
||
|
---------------------
|
||
|
|
||
|
.. _class_CylinderShape_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_CylinderShape_property_radius:
|
||
|
|
||
|
.. rst-class:: classref-property
|
||
|
|
||
|
:ref:`float<class_float>` **radius** = ``1.0``
|
||
|
|
||
|
.. 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.)`
|
||
|
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
|