class_cylindershape.rst 3.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/CylinderShape.xml.
  6. .. _class_CylinderShape:
  7. CylinderShape
  8. =============
  9. **Inherits:** :ref:`Shape<class_Shape>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  10. Cylinder shape for collisions.
  11. .. rst-class:: classref-introduction-group
  12. Description
  13. -----------
  14. Cylinder shape for collisions.
  15. \ **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.
  16. .. rst-class:: classref-introduction-group
  17. Tutorials
  18. ---------
  19. - `Third Person Shooter Demo <https://godotengine.org/asset-library/asset/678>`__
  20. - `3D Physics Tests Demo <https://godotengine.org/asset-library/asset/675>`__
  21. - `3D Voxel Demo <https://godotengine.org/asset-library/asset/676>`__
  22. .. rst-class:: classref-reftable-group
  23. Properties
  24. ----------
  25. .. table::
  26. :widths: auto
  27. +---------------------------+----------------------------------------------------+---------+
  28. | :ref:`float<class_float>` | :ref:`height<class_CylinderShape_property_height>` | ``2.0`` |
  29. +---------------------------+----------------------------------------------------+---------+
  30. | :ref:`float<class_float>` | :ref:`radius<class_CylinderShape_property_radius>` | ``1.0`` |
  31. +---------------------------+----------------------------------------------------+---------+
  32. .. rst-class:: classref-section-separator
  33. ----
  34. .. rst-class:: classref-descriptions-group
  35. Property Descriptions
  36. ---------------------
  37. .. _class_CylinderShape_property_height:
  38. .. rst-class:: classref-property
  39. :ref:`float<class_float>` **height** = ``2.0``
  40. .. rst-class:: classref-property-setget
  41. - void **set_height** **(** :ref:`float<class_float>` value **)**
  42. - :ref:`float<class_float>` **get_height** **(** **)**
  43. The cylinder's height.
  44. .. rst-class:: classref-item-separator
  45. ----
  46. .. _class_CylinderShape_property_radius:
  47. .. rst-class:: classref-property
  48. :ref:`float<class_float>` **radius** = ``1.0``
  49. .. rst-class:: classref-property-setget
  50. - void **set_radius** **(** :ref:`float<class_float>` value **)**
  51. - :ref:`float<class_float>` **get_radius** **(** **)**
  52. The cylinder's radius.
  53. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  54. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  55. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  56. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`