class_capsuleshape.rst 2.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970
  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 CapsuleShape.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_CapsuleShape:
  6. CapsuleShape
  7. ============
  8. **Inherits:** :ref:`Shape<class_Shape>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. Capsule shape for collisions.
  10. Description
  11. -----------
  12. Capsule shape for collisions.
  13. Tutorials
  14. ---------
  15. - `3D Physics Tests Demo <https://godotengine.org/asset-library/asset/675>`_
  16. Properties
  17. ----------
  18. +---------------------------+---------------------------------------------------+---------+
  19. | :ref:`float<class_float>` | :ref:`height<class_CapsuleShape_property_height>` | ``1.0`` |
  20. +---------------------------+---------------------------------------------------+---------+
  21. | :ref:`float<class_float>` | :ref:`radius<class_CapsuleShape_property_radius>` | ``1.0`` |
  22. +---------------------------+---------------------------------------------------+---------+
  23. Property Descriptions
  24. ---------------------
  25. .. _class_CapsuleShape_property_height:
  26. - :ref:`float<class_float>` **height**
  27. +-----------+-------------------+
  28. | *Default* | ``1.0`` |
  29. +-----------+-------------------+
  30. | *Setter* | set_height(value) |
  31. +-----------+-------------------+
  32. | *Getter* | get_height() |
  33. +-----------+-------------------+
  34. The capsule's height.
  35. ----
  36. .. _class_CapsuleShape_property_radius:
  37. - :ref:`float<class_float>` **radius**
  38. +-----------+-------------------+
  39. | *Default* | ``1.0`` |
  40. +-----------+-------------------+
  41. | *Setter* | set_radius(value) |
  42. +-----------+-------------------+
  43. | *Getter* | get_radius() |
  44. +-----------+-------------------+
  45. The capsule's radius.
  46. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  47. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  48. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`