class_circleshape2d.rst 1.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748
  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_CircleShape2D:
  4. CircleShape2D
  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. Circular Shape for 2D Physics.
  11. Member Functions
  12. ----------------
  13. +----------------------------+--------------------------------------------------------------------------------------------------+
  14. | :ref:`float<class_float>` | :ref:`get_radius<class_CircleShape2D_get_radius>` **(** **)** const |
  15. +----------------------------+--------------------------------------------------------------------------------------------------+
  16. | void | :ref:`set_radius<class_CircleShape2D_set_radius>` **(** :ref:`float<class_float>` radius **)** |
  17. +----------------------------+--------------------------------------------------------------------------------------------------+
  18. Description
  19. -----------
  20. Circular Shape for 2D Physics. This shape is useful for modeling balls or small characters and its collision detection with everything else is very fast.
  21. Member Function Description
  22. ---------------------------
  23. .. _class_CircleShape2D_get_radius:
  24. - :ref:`float<class_float>` **get_radius** **(** **)** const
  25. Return the radius of the circle shape.
  26. .. _class_CircleShape2D_set_radius:
  27. - void **set_radius** **(** :ref:`float<class_float>` radius **)**
  28. Set the radius of the circle shape.