summaryrefslogtreecommitdiffstats
path: root/doc/classes/ShapeCast3D.xml
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2024-04-08 11:19:04 +0200
committerRémi Verschelde <rverschelde@gmail.com>2024-04-08 11:19:04 +0200
commit3d5457533078eff3c7c922d7387b5e4ada8c5234 (patch)
treea80e95df3326190421e20a833bef59df6cb82a6f /doc/classes/ShapeCast3D.xml
parent00d4c63b7efa5316b060972180406f21889df809 (diff)
parent4359dc4eccaa4fa9d444f5d86cb06030337e9b75 (diff)
downloadredot-engine-3d5457533078eff3c7c922d7387b5e4ada8c5234.tar.gz
Merge pull request #85839 from romlok/clarify-get-closest-collision-unsafe-fraction
Clarify Shapecast safe/unsafe fraction difference in class reference
Diffstat (limited to 'doc/classes/ShapeCast3D.xml')
-rw-r--r--doc/classes/ShapeCast3D.xml1
1 files changed, 1 insertions, 0 deletions
diff --git a/doc/classes/ShapeCast3D.xml b/doc/classes/ShapeCast3D.xml
index ff057e8c70..2c6efe2ebe 100644
--- a/doc/classes/ShapeCast3D.xml
+++ b/doc/classes/ShapeCast3D.xml
@@ -48,6 +48,7 @@
<return type="float" />
<description>
The fraction from the [ShapeCast3D]'s origin to its [member target_position] (between 0 and 1) of how far the shape must move to trigger a collision.
+ In ideal conditions this would be the same as [method get_closest_collision_safe_fraction], however shape casting is calculated in discrete steps, so the precise point of collision can occur between two calculated positions.
</description>
</method>
<method name="get_collider" qualifiers="const">