From 6dfec4f70dfe77560de046fe99d6514e7831755a Mon Sep 17 00:00:00 2001
From: CardboardCarl <31835840+CardboardCarl@users.noreply.github.com>
Date: Sun, 21 Jan 2024 01:16:42 -0500
Subject: [PATCH] Clarified behavior of RayCast objects when
get_collision_point() is used inside a collision shape
---
doc/classes/RayCast2D.xml | 2 +-
doc/classes/RayCast3D.xml | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/doc/classes/RayCast2D.xml b/doc/classes/RayCast2D.xml
index 6144fd8f0b3..22e3ae07ba0 100644
--- a/doc/classes/RayCast2D.xml
+++ b/doc/classes/RayCast2D.xml
@@ -74,7 +74,7 @@
- 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.
diff --git a/doc/classes/RayCast3D.xml b/doc/classes/RayCast3D.xml
index 7157ec9b5f5..406fed107f7 100644
--- a/doc/classes/RayCast3D.xml
+++ b/doc/classes/RayCast3D.xml
@@ -81,7 +81,7 @@
- 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.