From 4359dc4eccaa4fa9d444f5d86cb06030337e9b75 Mon Sep 17 00:00:00 2001 From: Mel Collins Date: Wed, 6 Dec 2023 13:07:03 +0100 Subject: [PATCH] Clarify Shapecast safe/unsafe fraction difference --- doc/classes/ShapeCast2D.xml | 1 + doc/classes/ShapeCast3D.xml | 1 + 2 files changed, 2 insertions(+) diff --git a/doc/classes/ShapeCast2D.xml b/doc/classes/ShapeCast2D.xml index d71c9ce13a4..576bd62cc33 100644 --- a/doc/classes/ShapeCast2D.xml +++ b/doc/classes/ShapeCast2D.xml @@ -48,6 +48,7 @@ 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. diff --git a/doc/classes/ShapeCast3D.xml b/doc/classes/ShapeCast3D.xml index e189628f4c5..cc7f1835443 100644 --- a/doc/classes/ShapeCast3D.xml +++ b/doc/classes/ShapeCast3D.xml @@ -48,6 +48,7 @@ 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.