Files
godot-docs/classes/class_sphereshape.rst
2017-10-11 23:56:28 +02:00

50 lines
1.7 KiB
ReStructuredText

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the SphereShape.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_SphereShape:
SphereShape
===========
**Inherits:** :ref:`Shape<class_shape>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Sphere shape for 3D collisions.
Member Functions
----------------
+----------------------------+------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_radius<class_SphereShape_get_radius>` **(** **)** const |
+----------------------------+------------------------------------------------------------------------------------------------+
| void | :ref:`set_radius<class_SphereShape_set_radius>` **(** :ref:`float<class_float>` radius **)** |
+----------------------------+------------------------------------------------------------------------------------------------+
Member Variables
----------------
- :ref:`float<class_float>` **radius** - The sphere's radius. The shape's diameter is double the radius.
Description
-----------
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.
Member Function Description
---------------------------
.. _class_SphereShape_get_radius:
- :ref:`float<class_float>` **get_radius** **(** **)** const
.. _class_SphereShape_set_radius:
- void **set_radius** **(** :ref:`float<class_float>` radius **)**