Merge pull request #85839 from romlok/clarify-get-closest-collision-u…

…nsafe-fraction Clarify Shapecast safe/unsafe fraction difference in class reference
godotengine · Apr 8, 2024 · 3d54575 · 3d54575
2 parents 00d4c63 + 4359dc4
commit 3d54575
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/doc/classes/ShapeCast2D.xml b/doc/classes/ShapeCast2D.xml
@@ -48,6 +48,7 @@
 			<return type="float" />
 			<description>
 				The fraction from the [ShapeCast2D]'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">

diff --git 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">