virtualx-engine/doc/classes/CircleShape2D.xml
2017-09-16 21:55:23 -07:00

38 lines
1 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="CircleShape2D" inherits="Shape2D" category="Core" version="3.0.alpha.custom_build">
<brief_description>
Circular shape for 2D collisions.
</brief_description>
<description>
Circular shape for 2D collisions. This shape is useful for modeling balls or small characters and its collision detection with everything else is very fast.
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
<method name="get_radius" qualifiers="const">
<return type="float">
</return>
<description>
Return the radius of the circle shape.
</description>
</method>
<method name="set_radius">
<return type="void">
</return>
<argument index="0" name="radius" type="float">
</argument>
<description>
Set the radius of the circle shape.
</description>
</method>
</methods>
<members>
<member name="radius" type="float" setter="set_radius" getter="get_radius">
The circle's radius.
</member>
</members>
<constants>
</constants>
</class>