class_capsuleshape2d.rst 2.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the CapsuleShape2D.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_CapsuleShape2D:
  5. CapsuleShape2D
  6. ==============
  7. **Inherits:** :ref:`Shape2D<class_shape2d>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Capsule shape for 2D collisions.
  12. Member Functions
  13. ----------------
  14. +----------------------------+-------------------------------------------------------------------------------------------------+
  15. | :ref:`float<class_float>` | :ref:`get_height<class_CapsuleShape2D_get_height>` **(** **)** const |
  16. +----------------------------+-------------------------------------------------------------------------------------------------+
  17. | :ref:`float<class_float>` | :ref:`get_radius<class_CapsuleShape2D_get_radius>` **(** **)** const |
  18. +----------------------------+-------------------------------------------------------------------------------------------------+
  19. | void | :ref:`set_height<class_CapsuleShape2D_set_height>` **(** :ref:`float<class_float>` height **)** |
  20. +----------------------------+-------------------------------------------------------------------------------------------------+
  21. | void | :ref:`set_radius<class_CapsuleShape2D_set_radius>` **(** :ref:`float<class_float>` radius **)** |
  22. +----------------------------+-------------------------------------------------------------------------------------------------+
  23. Member Variables
  24. ----------------
  25. .. _class_CapsuleShape2D_height:
  26. - :ref:`float<class_float>` **height** - The capsule's height.
  27. .. _class_CapsuleShape2D_radius:
  28. - :ref:`float<class_float>` **radius** - The capsules's radius.
  29. Description
  30. -----------
  31. Capsule shape for 2D collisions.
  32. Member Function Description
  33. ---------------------------
  34. .. _class_CapsuleShape2D_get_height:
  35. - :ref:`float<class_float>` **get_height** **(** **)** const
  36. Return the height of the :ref:`CapsuleShape2D<class_capsuleshape2d>`.
  37. .. _class_CapsuleShape2D_get_radius:
  38. - :ref:`float<class_float>` **get_radius** **(** **)** const
  39. Return the radius of the :ref:`CapsuleShape2D<class_capsuleshape2d>`.
  40. .. _class_CapsuleShape2D_set_height:
  41. - void **set_height** **(** :ref:`float<class_float>` height **)**
  42. Set the height of the :ref:`CapsuleShape2D<class_capsuleshape2d>`.
  43. .. _class_CapsuleShape2D_set_radius:
  44. - void **set_radius** **(** :ref:`float<class_float>` radius **)**
  45. Set the radius of the :ref:`CapsuleShape2D<class_capsuleshape2d>`.