class_circleshape2d.rst 1.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the CircleShape2D.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_CircleShape2D:
  5. CircleShape2D
  6. =============
  7. **Inherits:** :ref:`Shape2D<class_Shape2D>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Circular shape for 2D collisions.
  12. Properties
  13. ----------
  14. +---------------------------+-------------------------------------------+
  15. | :ref:`float<class_float>` | :ref:`radius<class_CircleShape2D_radius>` |
  16. +---------------------------+-------------------------------------------+
  17. Description
  18. -----------
  19. 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.
  20. Property Descriptions
  21. ---------------------
  22. .. _class_CircleShape2D_radius:
  23. - :ref:`float<class_float>` **radius**
  24. +----------+-------------------+
  25. | *Setter* | set_radius(value) |
  26. +----------+-------------------+
  27. | *Getter* | get_radius() |
  28. +----------+-------------------+
  29. The circle's radius.