Forráskód Böngészése

Clarify Shapecast safe/unsafe fraction difference

Mel Collins 1 éve
szülő
commit
4359dc4ecc
2 módosított fájl, 2 hozzáadás és 0 törlés
  1. 1 0
      doc/classes/ShapeCast2D.xml
  2. 1 0
      doc/classes/ShapeCast3D.xml

+ 1 - 0
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">

+ 1 - 0
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">