class_circleshape2d.rst 1.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849
  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 CircleShape2D.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_CircleShape2D:
  6. CircleShape2D
  7. =============
  8. **Inherits:** :ref:`Shape2D<class_Shape2D>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. **Category:** Core
  10. Brief Description
  11. -----------------
  12. Circular shape for 2D collisions.
  13. Properties
  14. ----------
  15. +---------------------------+----------------------------------------------------+------+
  16. | :ref:`float<class_float>` | :ref:`radius<class_CircleShape2D_property_radius>` | 10.0 |
  17. +---------------------------+----------------------------------------------------+------+
  18. Description
  19. -----------
  20. Circular shape for 2D collisions. This shape is useful for modeling balls or small characters and its collision detection with everything else is very fast.
  21. Property Descriptions
  22. ---------------------
  23. .. _class_CircleShape2D_property_radius:
  24. - :ref:`float<class_float>` **radius**
  25. +-----------+-------------------+
  26. | *Default* | 10.0 |
  27. +-----------+-------------------+
  28. | *Setter* | set_radius(value) |
  29. +-----------+-------------------+
  30. | *Getter* | get_radius() |
  31. +-----------+-------------------+
  32. The circle's radius.