Home Explore Help
Sign In
Godot
/
godot-docs
mirror of https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: 75b51ec2f4
Branches Tags
godot-docs
/
classes
/
class_circleshape2d.rst

class_circleshape2d.rst 2.0 KB
History Raw

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950 
  1. :github_url: hide
    2. 

  2. 

  3. .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
    4. 

  4. .. DO NOT EDIT THIS FILE, but the CircleShape2D.xml source instead.
    5. 

  5. .. The source is found in doc/classes or modules/<name>/doc_classes.
    6. 

  6. 

  7. .. _class_CircleShape2D:
    8. 

  8. 

  9. CircleShape2D
    10. 

  10. =============
    11. 

  11. 

  12. **Inherits:** :ref:`Shape2D<class_Shape2D>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
    13. 

  13. 

  14. Circular shape for 2D collisions.
    15. 

  15. 

  16. Description
    17. 

  17. -----------
    18. 

  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. 

  20. 

  21. Properties
    22. 

  22. ----------
    23. 

  23. 

  24. +---------------------------+----------------------------------------------------+----------+
    25. 

  25. | :ref:`float<class_float>` | :ref:`radius<class_CircleShape2D_property_radius>` | ``10.0`` |
    26. 

  26. +---------------------------+----------------------------------------------------+----------+
    27. 

  27. 

  28. Property Descriptions
    29. 

  29. ---------------------
    30. 

  30. 

  31. .. _class_CircleShape2D_property_radius:
    32. 

  32. 

  33. - :ref:`float<class_float>` **radius**
    34. 

  34. 

  35. +-----------+-------------------+
    36. 

  36. | *Default* | ``10.0``          |
    37. 

  37. +-----------+-------------------+
    38. 

  38. | *Setter*  | set_radius(value) |
    39. 

  39. +-----------+-------------------+
    40. 

  40. | *Getter*  | get_radius()      |
    41. 

  41. +-----------+-------------------+
    42. 

  42. 

  43. The circle's radius.
    44. 

  44. 

  45. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
    46. 

  46. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
    47. 

  47. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
    48. 

  48. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
    49. 

  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.)`
    50. 

  50. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
    51.