virtualx-engine/doc/classes/RayShape.xml
2017-11-24 09:16:52 +01:00

36 lines
1,004 B
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="RayShape" inherits="Shape" category="Core" version="3.0-beta">
<brief_description>
Ray shape for 3D collisions.
</brief_description>
<description>
Ray shape for 3D collisions, which can be set into a [PhysicsBody] or [Area]. A ray is not really a collision body, instead it tries to separate itself from whatever is touching its far endpoint. It's often useful for characters.
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
<method name="get_length" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="set_length">
<return type="void">
</return>
<argument index="0" name="length" type="float">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="length" type="float" setter="set_length" getter="get_length">
The ray's length.
</member>
</members>
<constants>
</constants>
</class>