class_circleshape2d.rst 1.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/make_rst.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. Circular shape for 2D collisions.
  10. Description
  11. -----------
  12. 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.
  13. Properties
  14. ----------
  15. +---------------------------+----------------------------------------------------+----------+
  16. | :ref:`float<class_float>` | :ref:`radius<class_CircleShape2D_property_radius>` | ``10.0`` |
  17. +---------------------------+----------------------------------------------------+----------+
  18. Property Descriptions
  19. ---------------------
  20. .. _class_CircleShape2D_property_radius:
  21. - :ref:`float<class_float>` **radius**
  22. +-----------+-------------------+
  23. | *Default* | ``10.0`` |
  24. +-----------+-------------------+
  25. | *Setter* | set_radius(value) |
  26. +-----------+-------------------+
  27. | *Getter* | get_radius() |
  28. +-----------+-------------------+
  29. The circle's radius.
  30. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  31. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  32. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`