Files
godot-docs/classes/class_capsuleshape.rst
2017-09-23 11:01:36 +02:00

71 lines
2.4 KiB
ReStructuredText

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the CapsuleShape.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _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 for collisions.
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 **)** |
+----------------------------+-------------------------------------------------------------------------------------------------+
Member Variables
----------------
- :ref:`float<class_float>` **height** - The capsule's height.
- :ref:`float<class_float>` **radius** - The capsule's radius.
Description
-----------
Capsule shape for collisions.
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.