Files
godot-docs/classes/class_capsuleshape.rst
Rémi Verschelde 1b5e8c18fd classref: Order everything alphabetically
And sync with current 2.0.x sources.
2016-06-25 02:10:54 +02: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
----------------
+----------------------------+-------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_height<class_CapsuleShape_get_height>` **(** **)** const |
+----------------------------+-------------------------------------------------------------------------------------------------+
| :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 **)** |
+----------------------------+-------------------------------------------------------------------------------------------------+
| void | :ref:`set_radius<class_CapsuleShape_set_radius>` **(** :ref:`float<class_float>` radius **)** |
+----------------------------+-------------------------------------------------------------------------------------------------+
Description
-----------
Capsule shape resource, which can be set into a :ref:`PhysicsBody<class_physicsbody>` or area.
Member Function Description
---------------------------
.. _class_CapsuleShape_get_height:
- :ref:`float<class_float>` **get_height** **(** **)** const
Return the capsule height.
.. _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_set_radius:
- void **set_radius** **(** :ref:`float<class_float>` radius **)**
Set the capsule radius.