virtualx-engine/doc/classes/CapsuleShape2D.xml

56 lines
1.5 KiB
XML
Raw Normal View History

<?xml version="1.0" encoding="UTF-8" ?>
<class name="CapsuleShape2D" inherits="Shape2D" category="Core" version="3.0.alpha.custom_build">
<brief_description>
Capsule 2D shape resource for physics.
</brief_description>
<description>
Capsule 2D shape resource for physics. A capsule (or sometimes called "pill") is like a line grown in all directions. It has a radius and a height, and is often useful for modeling biped characters.
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
<method name="get_height" qualifiers="const">
<return type="float">
</return>
<description>
Return the height of the [CapsuleShape2D].
</description>
</method>
<method name="get_radius" qualifiers="const">
<return type="float">
</return>
<description>
Return the radius of the [CapsuleShape2D].
</description>
</method>
<method name="set_height">
<return type="void">
</return>
<argument index="0" name="height" type="float">
</argument>
<description>
Set the height of the [CapsuleShape2D].
</description>
</method>
<method name="set_radius">
<return type="void">
</return>
<argument index="0" name="radius" type="float">
</argument>
<description>
Set the radius of the [CapsuleShape2D].
</description>
</method>
</methods>
<members>
<member name="height" type="float" setter="set_height" getter="get_height" brief="">
</member>
<member name="radius" type="float" setter="set_radius" getter="get_radius" brief="">
</member>
</members>
<constants>
</constants>
</class>