class_cylindershape.rst 2.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the CylinderShape.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_CylinderShape:
  6. CylinderShape
  7. =============
  8. **Inherits:** :ref:`Shape<class_Shape>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. Cylinder shape for collisions.
  10. Description
  11. -----------
  12. Cylinder shape for collisions.
  13. Tutorials
  14. ---------
  15. - `Third Person Shooter Demo <https://godotengine.org/asset-library/asset/678>`__
  16. - `3D Physics Tests Demo <https://godotengine.org/asset-library/asset/675>`__
  17. - `3D Voxel Demo <https://godotengine.org/asset-library/asset/676>`__
  18. Properties
  19. ----------
  20. +---------------------------+----------------------------------------------------+---------+
  21. | :ref:`float<class_float>` | :ref:`height<class_CylinderShape_property_height>` | ``2.0`` |
  22. +---------------------------+----------------------------------------------------+---------+
  23. | :ref:`float<class_float>` | :ref:`radius<class_CylinderShape_property_radius>` | ``1.0`` |
  24. +---------------------------+----------------------------------------------------+---------+
  25. Property Descriptions
  26. ---------------------
  27. .. _class_CylinderShape_property_height:
  28. - :ref:`float<class_float>` **height**
  29. +-----------+-------------------+
  30. | *Default* | ``2.0`` |
  31. +-----------+-------------------+
  32. | *Setter* | set_height(value) |
  33. +-----------+-------------------+
  34. | *Getter* | get_height() |
  35. +-----------+-------------------+
  36. The cylinder's height.
  37. ----
  38. .. _class_CylinderShape_property_radius:
  39. - :ref:`float<class_float>` **radius**
  40. +-----------+-------------------+
  41. | *Default* | ``1.0`` |
  42. +-----------+-------------------+
  43. | *Setter* | set_radius(value) |
  44. +-----------+-------------------+
  45. | *Getter* | get_radius() |
  46. +-----------+-------------------+
  47. The cylinder's radius.
  48. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  49. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  50. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`