class_sphereshape.rst 1.7 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. Sphere shape for 3D collisions.
  10. Description
  11. -----------
  12. 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.
  13. Properties
  14. ----------
  15. +---------------------------+--------------------------------------------------+---------+
  16. | :ref:`float<class_float>` | :ref:`radius<class_SphereShape_property_radius>` | ``1.0`` |
  17. +---------------------------+--------------------------------------------------+---------+
  18. Property Descriptions
  19. ---------------------
  20. .. _class_SphereShape_property_radius:
  21. - :ref:`float<class_float>` **radius**
  22. +-----------+-------------------+
  23. | *Default* | ``1.0`` |
  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.
  30. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  31. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  32. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`