Files
godot-docs/classes/class_capsuleshape3d.rst
2022-02-22 10:06:27 +01:00

74 lines
2.5 KiB
ReStructuredText

:github_url: hide
.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the CapsuleShape3D.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_CapsuleShape3D:
CapsuleShape3D
==============
**Inherits:** :ref:`Shape3D<class_Shape3D>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
Capsule shape for collisions.
Description
-----------
Capsule shape for collisions.
Tutorials
---------
- `3D Physics Tests Demo <https://godotengine.org/asset-library/asset/675>`__
Properties
----------
+---------------------------+-----------------------------------------------------+---------+
| :ref:`float<class_float>` | :ref:`height<class_CapsuleShape3D_property_height>` | ``2.0`` |
+---------------------------+-----------------------------------------------------+---------+
| :ref:`float<class_float>` | :ref:`radius<class_CapsuleShape3D_property_radius>` | ``0.5`` |
+---------------------------+-----------------------------------------------------+---------+
Property Descriptions
---------------------
.. _class_CapsuleShape3D_property_height:
- :ref:`float<class_float>` **height**
+-----------+-------------------+
| *Default* | ``2.0`` |
+-----------+-------------------+
| *Setter* | set_height(value) |
+-----------+-------------------+
| *Getter* | get_height() |
+-----------+-------------------+
The capsule's height.
----
.. _class_CapsuleShape3D_property_radius:
- :ref:`float<class_float>` **radius**
+-----------+-------------------+
| *Default* | ``0.5`` |
+-----------+-------------------+
| *Setter* | set_radius(value) |
+-----------+-------------------+
| *Getter* | get_radius() |
+-----------+-------------------+
The capsule's radius.
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`