class_sphereshape.rst 1.3 KB

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