summaryrefslogtreecommitdiff
path: root/doc/classes/RayShape2D.xml
blob: c9779a430764a5a172260b08772555bac54c9f1c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
<?xml version="1.0" encoding="UTF-8" ?>
<class name="RayShape2D" inherits="Shape2D" category="Core" version="3.0-alpha">
	<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>