class_capsuleshape2d.rst 2.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
  3. .. _class_CapsuleShape2D:
  4. CapsuleShape2D
  5. ==============
  6. **Inherits:** :ref:`Shape2D<class_shape2d>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
  7. **Category:** Core
  8. Brief Description
  9. -----------------
  10. Capsule 2D shape resource for physics.
  11. Member Functions
  12. ----------------
  13. +----------------------------+---------------------------------------------------------------------------------------------------+
  14. | :ref:`float<class_float>` | :ref:`get_height<class_CapsuleShape2D_get_height>` **(** **)** const |
  15. +----------------------------+---------------------------------------------------------------------------------------------------+
  16. | :ref:`float<class_float>` | :ref:`get_radius<class_CapsuleShape2D_get_radius>` **(** **)** const |
  17. +----------------------------+---------------------------------------------------------------------------------------------------+
  18. | void | :ref:`set_height<class_CapsuleShape2D_set_height>` **(** :ref:`float<class_float>` height **)** |
  19. +----------------------------+---------------------------------------------------------------------------------------------------+
  20. | void | :ref:`set_radius<class_CapsuleShape2D_set_radius>` **(** :ref:`float<class_float>` radius **)** |
  21. +----------------------------+---------------------------------------------------------------------------------------------------+
  22. Description
  23. -----------
  24. Capsule 2D shape resource for physics. A capsule (or sometimes called "pill") is like a line grown in all directions. It has a radius and a height, and is often useful for modeling biped characters.
  25. Member Function Description
  26. ---------------------------
  27. .. _class_CapsuleShape2D_get_height:
  28. - :ref:`float<class_float>` **get_height** **(** **)** const
  29. Return the height of the :ref:`CapsuleShape2D<class_capsuleshape2d>`.
  30. .. _class_CapsuleShape2D_get_radius:
  31. - :ref:`float<class_float>` **get_radius** **(** **)** const
  32. Return the radius of the :ref:`CapsuleShape2D<class_capsuleshape2d>`.
  33. .. _class_CapsuleShape2D_set_height:
  34. - void **set_height** **(** :ref:`float<class_float>` height **)**
  35. Set the height of the :ref:`CapsuleShape2D<class_capsuleshape2d>`.
  36. .. _class_CapsuleShape2D_set_radius:
  37. - void **set_radius** **(** :ref:`float<class_float>` radius **)**
  38. Set the radius of the :ref:`CapsuleShape2D<class_capsuleshape2d>`.