Files
engine/doc/classes/SeparationRayShape3D.xml
T

22 lines
1.3 KiB
XML
Raw Normal View History

2021-08-17 10:15:11 -07:00
<?xml version="1.0" encoding="UTF-8" ?>
2022-02-14 14:18:53 +01:00
<class name="SeparationRayShape3D" inherits="Shape3D" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
2021-08-17 10:15:11 -07:00
<brief_description>
Separation ray shape resource for 3D physics.
2021-08-17 10:15:11 -07:00
</brief_description>
<description>
3D separation ray shape to be added as a [i]direct[/i] child of a [PhysicsBody3D] or [Area3D] using a [CollisionShape3D] node. 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.
[b]Performance:[/b] Being a primitive collision shape, [SeparationRayShape3D] is fast to check collisions against.
2021-08-17 10:15:11 -07:00
</description>
<tutorials>
</tutorials>
<members>
2021-08-19 11:21:56 -07:00
<member name="length" type="float" setter="set_length" getter="get_length" default="1.0">
2021-08-17 10:15:11 -07:00
The ray's length.
</member>
2021-08-19 11:02:40 -07:00
<member name="slide_on_slope" type="bool" setter="set_slide_on_slope" getter="get_slide_on_slope" default="false">
If [code]false[/code] (default), the shape always separates and returns a normal along its own direction.
If [code]true[/code], the shape can return the correct normal and separate in any direction, allowing sliding motion on slopes.
2021-08-17 10:15:11 -07:00
</member>
</members>
</class>