Files
godot-docs/classes/class_capsuleshape.rst
T
Rémi Verschelde 1204e3ea17 Add a warning header to each classref file
To tell potential contributors that they should NOT edit those files but instead should work on the class.xml source of the main Godot repo
2016-02-17 22:04:18 +01:00

64 lines
2.3 KiB
ReStructuredText

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. _class_CapsuleShape:
CapsuleShape
============
**Inherits:** :ref:`Shape<class_shape>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Capsule shape resource.
Member Functions
----------------
+----------------------------+-------------------------------------------------------------------------------------------------+
| void | :ref:`set_radius<class_CapsuleShape_set_radius>` **(** :ref:`float<class_float>` radius **)** |
+----------------------------+-------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_radius<class_CapsuleShape_get_radius>` **(** **)** const |
+----------------------------+-------------------------------------------------------------------------------------------------+
| void | :ref:`set_height<class_CapsuleShape_set_height>` **(** :ref:`float<class_float>` height **)** |
+----------------------------+-------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_height<class_CapsuleShape_get_height>` **(** **)** const |
+----------------------------+-------------------------------------------------------------------------------------------------+
Description
-----------
Capsule shape resource, which can be set into a :ref:`PhysicsBody<class_physicsbody>` or area.
Member Function Description
---------------------------
.. _class_CapsuleShape_set_radius:
- void **set_radius** **(** :ref:`float<class_float>` radius **)**
Set the capsule radius.
.. _class_CapsuleShape_get_radius:
- :ref:`float<class_float>` **get_radius** **(** **)** const
Return the capsule radius.
.. _class_CapsuleShape_set_height:
- void **set_height** **(** :ref:`float<class_float>` height **)**
Set the capsule height.
.. _class_CapsuleShape_get_height:
- :ref:`float<class_float>` **get_height** **(** **)** const
Return the capsule height.