summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorYuri Sizov <yuris@humnom.net>2024-01-22 20:38:33 +0100
committerYuri Sizov <yuris@humnom.net>2024-01-22 20:38:33 +0100
commit52bac73a89495f61f33d2c55a6798173fa381d7f (patch)
tree26cbc357a356370d9bad49c15ec06d6b2556a8a3
parentfeb1157276d448b321a2bc89f7efe8872127de66 (diff)
parent6dfec4f70dfe77560de046fe99d6514e7831755a (diff)
downloadredot-engine-52bac73a89495f61f33d2c55a6798173fa381d7f.tar.gz
Merge pull request #84085 from CardboardCarl/master
Clarified behavior of RayCast objects when `get_collision_point()` is used inside a collision shape
-rw-r--r--doc/classes/RayCast2D.xml2
-rw-r--r--doc/classes/RayCast3D.xml2
2 files changed, 2 insertions, 2 deletions
diff --git a/doc/classes/RayCast2D.xml b/doc/classes/RayCast2D.xml
index 6144fd8f0b..22e3ae07ba 100644
--- a/doc/classes/RayCast2D.xml
+++ b/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>
diff --git a/doc/classes/RayCast3D.xml b/doc/classes/RayCast3D.xml
index 7157ec9b5f..406fed107f 100644
--- a/doc/classes/RayCast3D.xml
+++ b/doc/classes/RayCast3D.xml
@@ -81,7 +81,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>