summaryrefslogtreecommitdiff
path: root/doc/classes/RayShape2D.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/RayShape2D.xml')
-rw-r--r--doc/classes/RayShape2D.xml38
1 files changed, 38 insertions, 0 deletions
diff --git a/doc/classes/RayShape2D.xml b/doc/classes/RayShape2D.xml
new file mode 100644
index 0000000000..4f6313a1d2
--- /dev/null
+++ b/doc/classes/RayShape2D.xml
@@ -0,0 +1,38 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="RayShape2D" inherits="Shape2D" category="Core" version="3.0.alpha.custom_build">
+ <brief_description>
+ Ray shape for 2D collisions.
+ </brief_description>
+ <description>
+ Ray shape for 2D collisions. 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>
+ Return the length of the ray.
+ </description>
+ </method>
+ <method name="set_length">
+ <return type="void">
+ </return>
+ <argument index="0" name="length" type="float">
+ </argument>
+ <description>
+ Set the length of the ray.
+ </description>
+ </method>
+ </methods>
+ <members>
+ <member name="length" type="float" setter="set_length" getter="get_length">
+ The ray's length.
+ </member>
+ </members>
+ <constants>
+ </constants>
+</class>