Files
godot-docs/classes/class_sphereshape.rst
Rémi Verschelde 782dd64a19 classref: Use code markup for default values/overrides
Sync with godotengine/godot#35357.
Fixes #3071.
2020-01-20 12:41:39 +01:00

45 lines
1.4 KiB
ReStructuredText

:github_url: hide
.. 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>`
Sphere shape for 3D collisions.
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.
Properties
----------
+---------------------------+--------------------------------------------------+---------+
| :ref:`float<class_float>` | :ref:`radius<class_SphereShape_property_radius>` | ``1.0`` |
+---------------------------+--------------------------------------------------+---------+
Property Descriptions
---------------------
.. _class_SphereShape_property_radius:
- :ref:`float<class_float>` **radius**
+-----------+-------------------+
| *Default* | ``1.0`` |
+-----------+-------------------+
| *Setter* | set_radius(value) |
+-----------+-------------------+
| *Getter* | get_radius() |
+-----------+-------------------+
The sphere's radius. The shape's diameter is double the radius.