class_capsuleshape2d.rst 2.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/CapsuleShape2D.xml.
  6. .. _class_CapsuleShape2D:
  7. CapsuleShape2D
  8. ==============
  9. **Inherits:** :ref:`Shape2D<class_Shape2D>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  10. Capsule shape for 2D collisions.
  11. .. rst-class:: classref-introduction-group
  12. Description
  13. -----------
  14. Capsule shape for 2D collisions.
  15. .. rst-class:: classref-reftable-group
  16. Properties
  17. ----------
  18. .. table::
  19. :widths: auto
  20. +---------------------------+-----------------------------------------------------+----------+
  21. | :ref:`float<class_float>` | :ref:`height<class_CapsuleShape2D_property_height>` | ``20.0`` |
  22. +---------------------------+-----------------------------------------------------+----------+
  23. | :ref:`float<class_float>` | :ref:`radius<class_CapsuleShape2D_property_radius>` | ``10.0`` |
  24. +---------------------------+-----------------------------------------------------+----------+
  25. .. rst-class:: classref-section-separator
  26. ----
  27. .. rst-class:: classref-descriptions-group
  28. Property Descriptions
  29. ---------------------
  30. .. _class_CapsuleShape2D_property_height:
  31. .. rst-class:: classref-property
  32. :ref:`float<class_float>` **height** = ``20.0``
  33. .. rst-class:: classref-property-setget
  34. - void **set_height** **(** :ref:`float<class_float>` value **)**
  35. - :ref:`float<class_float>` **get_height** **(** **)**
  36. The capsule's height.
  37. .. rst-class:: classref-item-separator
  38. ----
  39. .. _class_CapsuleShape2D_property_radius:
  40. .. rst-class:: classref-property
  41. :ref:`float<class_float>` **radius** = ``10.0``
  42. .. rst-class:: classref-property-setget
  43. - void **set_radius** **(** :ref:`float<class_float>` value **)**
  44. - :ref:`float<class_float>` **get_radius** **(** **)**
  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.)`
  49. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`