summaryrefslogtreecommitdiff
path: root/doc/classes/RayShape3D.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/RayShape3D.xml')
-rw-r--r--doc/classes/RayShape3D.xml23
1 files changed, 23 insertions, 0 deletions
diff --git a/doc/classes/RayShape3D.xml b/doc/classes/RayShape3D.xml
new file mode 100644
index 0000000000..9839044c30
--- /dev/null
+++ b/doc/classes/RayShape3D.xml
@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="RayShape3D" inherits="Shape3D" version="4.0">
+ <brief_description>
+ Ray shape for 3D collisions.
+ </brief_description>
+ <description>
+ Ray shape for 3D collisions, which can be set into a [PhysicsBody3D] or [Area3D]. 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>
+ <methods>
+ </methods>
+ <members>
+ <member name="length" type="float" setter="set_length" getter="get_length" default="1.0">
+ The ray's length.
+ </member>
+ <member name="slips_on_slope" type="bool" setter="set_slips_on_slope" getter="get_slips_on_slope" default="false">
+ If [code]true[/code], allow the shape to return the correct normal.
+ </member>
+ </members>
+ <constants>
+ </constants>
+</class>