summaryrefslogtreecommitdiffstats
path: root/doc/classes/ShapeCast2D.xml
diff options
context:
space:
mode:
authorAndrii Doroshenko (Xrayez) <xrayez@gmail.com>2021-11-12 21:30:35 +0200
committerAndrii Doroshenko (Xrayez) <xrayez@gmail.com>2021-11-12 21:30:35 +0200
commit6a673509106bfe7e9c7978d392d8cde3c1b65dc8 (patch)
tree94a92c809e5d5e16af1f4989050a720eb0479cd3 /doc/classes/ShapeCast2D.xml
parentf979d5977ac77bdc47c1d7865a221a46991e30ab (diff)
downloadredot-engine-6a673509106bfe7e9c7978d392d8cde3c1b65dc8.tar.gz
Remove `get_closest_*` methods from `ShapeCast2D`
The physics API cannot provide needed functionality to ensure the correct behavior, which might lead to confusion (see `rest_info()`). However `get_closest_collision_safe/unsafe_fraction()` methods are not removed, because they return correct result from `cast_motion()`.
Diffstat (limited to 'doc/classes/ShapeCast2D.xml')
-rw-r--r--doc/classes/ShapeCast2D.xml25
1 files changed, 0 insertions, 25 deletions
diff --git a/doc/classes/ShapeCast2D.xml b/doc/classes/ShapeCast2D.xml
index e202d058b1..74ebafe069 100644
--- a/doc/classes/ShapeCast2D.xml
+++ b/doc/classes/ShapeCast2D.xml
@@ -39,31 +39,6 @@
[b]Note:[/b] [code]enabled == true[/code] is not required for this to work.
</description>
</method>
- <method name="get_closest_collider" qualifiers="const">
- <return type="Object" />
- <description>
- Returns the first object that the shape intersects, or [code]null[/code] if no object is intersecting the shape (i.e. [method is_colliding] returns [code]false[/code]).
- </description>
- </method>
- <method name="get_closest_collider_shape" qualifiers="const">
- <return type="int" />
- <description>
- Returns the shape ID of the first object that the shape intersects, or [code]0[/code] if no object is intersecting the shape (i.e. [method is_colliding] returns [code]false[/code]).
- </description>
- </method>
- <method name="get_closest_collision_normal" qualifiers="const">
- <return type="Vector2" />
- <description>
- Returns the normal of the closest intersecting object's shape at the collision point.
- </description>
- </method>
- <method name="get_closest_collision_point" qualifiers="const">
- <return type="Vector2" />
- <description>
- Returns the collision point at which the shape intersects the closest object.
- [b]Note:[/b] this point is in the [b]global[/b] coordinate system.
- </description>
- </method>
<method name="get_closest_collision_safe_fraction" qualifiers="const">
<return type="float" />
<description>