summaryrefslogtreecommitdiff
path: root/doc/classes/PhysicsServer2D.xml
diff options
context:
space:
mode:
authorPouleyKetchoupp <pouleyketchoup@gmail.com>2021-08-19 11:21:56 -0700
committerPouleyKetchoupp <pouleyketchoup@gmail.com>2021-08-24 17:34:55 -0700
commit3d5dc80348b9b377f6d8a33c7101d54b337396a5 (patch)
tree70705bf5e02804bc2eaffe9315205a128d4a1c9e /doc/classes/PhysicsServer2D.xml
parentaa4791735d2fe92d747a39529aebb410f96cf38f (diff)
Rename RayShape to SeparationRayShape
Makes it clearer that it's used for special cases when picking a collision shape.
Diffstat (limited to 'doc/classes/PhysicsServer2D.xml')
-rw-r--r--doc/classes/PhysicsServer2D.xml9
1 files changed, 5 insertions, 4 deletions
diff --git a/doc/classes/PhysicsServer2D.xml b/doc/classes/PhysicsServer2D.xml
index 758ffb9b14..d0ae665139 100644
--- a/doc/classes/PhysicsServer2D.xml
+++ b/doc/classes/PhysicsServer2D.xml
@@ -717,17 +717,17 @@
Sets a joint parameter. See [enum JointParam] for a list of available parameters.
</description>
</method>
- <method name="ray_shape_create">
+ <method name="rectangle_shape_create">
<return type="RID" />
<description>
</description>
</method>
- <method name="rectangle_shape_create">
+ <method name="segment_shape_create">
<return type="RID" />
<description>
</description>
</method>
- <method name="segment_shape_create">
+ <method name="separation_ray_shape_create">
<return type="RID" />
<description>
</description>
@@ -846,7 +846,8 @@
<constant name="SHAPE_WORLD_MARGIN" value="0" enum="ShapeType">
This is the constant for creating world margin shapes. A world margin shape is an [i]infinite[/i] line with an origin point, and a normal. Thus, it can be used for front/behind checks.
</constant>
- <constant name="SHAPE_RAY" value="1" enum="ShapeType">
+ <constant name="SHAPE_SEPARATION_RAY" value="1" enum="ShapeType">
+ This is the constant for creating separation ray shapes. A separation ray is defined by a length and separates itself from what is touching its far endpoint. Useful for character controllers.
</constant>
<constant name="SHAPE_SEGMENT" value="2" enum="ShapeType">
This is the constant for creating segment shapes. A segment shape is a [i]finite[/i] line from a point A to a point B. It can be checked for intersections.