class_sphereshape.rst 1.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/make_rst.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. Tutorials
  14. ---------
  15. - `3D Physics Tests Demo <https://godotengine.org/asset-library/asset/675>`__
  16. Properties
  17. ----------
  18. +---------------------------+--------------------------------------------------+---------+
  19. | :ref:`float<class_float>` | :ref:`radius<class_SphereShape_property_radius>` | ``1.0`` |
  20. +---------------------------+--------------------------------------------------+---------+
  21. Property Descriptions
  22. ---------------------
  23. .. _class_SphereShape_property_radius:
  24. - :ref:`float<class_float>` **radius**
  25. +-----------+-------------------+
  26. | *Default* | ``1.0`` |
  27. +-----------+-------------------+
  28. | *Setter* | set_radius(value) |
  29. +-----------+-------------------+
  30. | *Getter* | get_radius() |
  31. +-----------+-------------------+
  32. The sphere's radius. The shape's diameter is double the radius.
  33. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  34. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  35. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`