godot-docs/classes/class_capsuleshape.rst

:github_url: hide

.. 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.

Properties
----------

+---------------------------+---------------------------------------------------+-----+
| :ref:`float<class_float>` | :ref:`height<class_CapsuleShape_property_height>` | 1.0 |
+---------------------------+---------------------------------------------------+-----+
| :ref:`float<class_float>` | :ref:`radius<class_CapsuleShape_property_radius>` | 1.0 |
+---------------------------+---------------------------------------------------+-----+

Description
-----------

Capsule shape for collisions.

Property Descriptions
---------------------

.. _class_CapsuleShape_property_height:

- :ref:`float<class_float>` **height**

+-----------+-------------------+
| *Default* | 1.0               |
+-----------+-------------------+
| *Setter*  | set_height(value) |
+-----------+-------------------+
| *Getter*  | get_height()      |
+-----------+-------------------+

The capsule's height.

.. _class_CapsuleShape_property_radius:

- :ref:`float<class_float>` **radius**

+-----------+-------------------+
| *Default* | 1.0               |
+-----------+-------------------+
| *Setter*  | set_radius(value) |
+-----------+-------------------+
| *Getter*  | get_radius()      |
+-----------+-------------------+

The capsule's radius.