class_sphereshape.rst 1.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849
  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. Member Functions
  13. ----------------
  14. +----------------------------+------------------------------------------------------------------------------------------------+
  15. | :ref:`float<class_float>` | :ref:`get_radius<class_SphereShape_get_radius>` **(** **)** const |
  16. +----------------------------+------------------------------------------------------------------------------------------------+
  17. | void | :ref:`set_radius<class_SphereShape_set_radius>` **(** :ref:`float<class_float>` radius **)** |
  18. +----------------------------+------------------------------------------------------------------------------------------------+
  19. Member Variables
  20. ----------------
  21. - :ref:`float<class_float>` **radius** - The sphere's radius. The shape's diameter is double the radius.
  22. Description
  23. -----------
  24. 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.
  25. Member Function Description
  26. ---------------------------
  27. .. _class_SphereShape_get_radius:
  28. - :ref:`float<class_float>` **get_radius** **(** **)** const
  29. .. _class_SphereShape_set_radius:
  30. - void **set_radius** **(** :ref:`float<class_float>` radius **)**