class_capsuleshape2d.rst 2.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869
  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. Member Variables
  23. ----------------
  24. - :ref:`float<class_float>` **height**
  25. - :ref:`float<class_float>` **radius**
  26. Description
  27. -----------
  28. 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.
  29. Member Function Description
  30. ---------------------------
  31. .. _class_CapsuleShape2D_get_height:
  32. - :ref:`float<class_float>` **get_height** **(** **)** const
  33. Return the height of the :ref:`CapsuleShape2D<class_capsuleshape2d>`.
  34. .. _class_CapsuleShape2D_get_radius:
  35. - :ref:`float<class_float>` **get_radius** **(** **)** const
  36. Return the radius of the :ref:`CapsuleShape2D<class_capsuleshape2d>`.
  37. .. _class_CapsuleShape2D_set_height:
  38. - void **set_height** **(** :ref:`float<class_float>` height **)**
  39. Set the height of the :ref:`CapsuleShape2D<class_capsuleshape2d>`.
  40. .. _class_CapsuleShape2D_set_radius:
  41. - void **set_radius** **(** :ref:`float<class_float>` radius **)**
  42. Set the radius of the :ref:`CapsuleShape2D<class_capsuleshape2d>`.