class_sphereshape.rst 1.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the SphereShape.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_SphereShape:
  5. SphereShape
  6. ===========
  7. **Inherits:** :ref:`Shape<class_Shape>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Sphere shape for 3D collisions.
  12. Properties
  13. ----------
  14. +---------------------------+--------------------------------------------------+
  15. | :ref:`float<class_float>` | :ref:`radius<class_SphereShape_property_radius>` |
  16. +---------------------------+--------------------------------------------------+
  17. Description
  18. -----------
  19. Sphere shape for 3D collisions, which can be set into a :ref:`PhysicsBody<class_PhysicsBody>` or :ref:`Area<class_Area>`. This shape is useful for modeling sphere-like 3D objects.
  20. Property Descriptions
  21. ---------------------
  22. .. _class_SphereShape_property_radius:
  23. - :ref:`float<class_float>` **radius**
  24. +----------+-------------------+
  25. | *Setter* | set_radius(value) |
  26. +----------+-------------------+
  27. | *Getter* | get_radius() |
  28. +----------+-------------------+
  29. The sphere's radius. The shape's diameter is double the radius.