class_cylindershape.rst 2.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/makerst.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. Properties
  14. ----------
  15. +---------------------------+----------------------------------------------------+---------+
  16. | :ref:`float<class_float>` | :ref:`height<class_CylinderShape_property_height>` | ``2.0`` |
  17. +---------------------------+----------------------------------------------------+---------+
  18. | :ref:`float<class_float>` | :ref:`radius<class_CylinderShape_property_radius>` | ``1.0`` |
  19. +---------------------------+----------------------------------------------------+---------+
  20. Property Descriptions
  21. ---------------------
  22. .. _class_CylinderShape_property_height:
  23. - :ref:`float<class_float>` **height**
  24. +-----------+-------------------+
  25. | *Default* | ``2.0`` |
  26. +-----------+-------------------+
  27. | *Setter* | set_height(value) |
  28. +-----------+-------------------+
  29. | *Getter* | get_height() |
  30. +-----------+-------------------+
  31. The cylinder's height.
  32. ----
  33. .. _class_CylinderShape_property_radius:
  34. - :ref:`float<class_float>` **radius**
  35. +-----------+-------------------+
  36. | *Default* | ``1.0`` |
  37. +-----------+-------------------+
  38. | *Setter* | set_radius(value) |
  39. +-----------+-------------------+
  40. | *Getter* | get_radius() |
  41. +-----------+-------------------+
  42. The cylinder's radius.
  43. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  44. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  45. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`