Browse Source

Clarified behavior of RayCast objects when get_collision_point() is used inside a collision shape

(cherry picked from commit 6dfec4f70dfe77560de046fe99d6514e7831755a)
CardboardCarl 1 year ago
parent
commit
b3018d81c5
2 changed files with 2 additions and 2 deletions
  1. 1 1
      doc/classes/RayCast2D.xml
  2. 1 1
      doc/classes/RayCast3D.xml

+ 1 - 1
doc/classes/RayCast2D.xml

@@ -74,7 +74,7 @@
 		<method name="get_collision_point" qualifiers="const">
 			<return type="Vector2" />
 			<description>
-				Returns the collision point at which the ray intersects the closest object.
+				Returns the collision point at which the ray intersects the closest object. If [member hit_from_inside] is [code]true[/code] and the ray starts inside of a collision shape, this function will return the origin point of the ray.
 				[b]Note:[/b] This point is in the [b]global[/b] coordinate system.
 			</description>
 		</method>

+ 1 - 1
doc/classes/RayCast3D.xml

@@ -75,7 +75,7 @@
 		<method name="get_collision_point" qualifiers="const">
 			<return type="Vector3" />
 			<description>
-				Returns the collision point at which the ray intersects the closest object.
+				Returns the collision point at which the ray intersects the closest object. If [member hit_from_inside] is [code]true[/code] and the ray starts inside of a collision shape, this function will return the origin point of the ray.
 				[b]Note:[/b] This point is in the [b]global[/b] coordinate system.
 			</description>
 		</method>