diff options
| author | Camille Mohr-Daurat <pouleyKetchoup@gmail.com> | 2021-08-27 08:49:49 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-08-27 08:49:49 -0700 |
| commit | ca4f20529c0b6588464f88fc0b0680a8df0fc77f (patch) | |
| tree | 6c2c536eb0544f8073547a7774ab7d8d1ac63055 /doc/classes/SeparationRayShape2D.xml | |
| parent | fec7516010cd2d371800bb3a7d0ff06ebc2c941f (diff) | |
| parent | 3d5dc80348b9b377f6d8a33c7101d54b337396a5 (diff) | |
Merge pull request #51896 from nekomatata/restore-ray-shape
Refactor RayShape and rename to SeparationRayShape
Diffstat (limited to 'doc/classes/SeparationRayShape2D.xml')
| -rw-r--r-- | doc/classes/SeparationRayShape2D.xml | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/doc/classes/SeparationRayShape2D.xml b/doc/classes/SeparationRayShape2D.xml new file mode 100644 index 0000000000..fb90606577 --- /dev/null +++ b/doc/classes/SeparationRayShape2D.xml @@ -0,0 +1,24 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="SeparationRayShape2D" inherits="Shape2D" version="4.0"> + <brief_description> + Separation ray shape for 2D collisions. + </brief_description> + <description> + Separation 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> + <methods> + </methods> + <members> + <member name="length" type="float" setter="set_length" getter="get_length" default="20.0"> + The ray's length. + </member> + <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. + </member> + </members> + <constants> + </constants> +</class> |