diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2024-03-14 22:34:25 +0100 |
|---|---|---|
| committer | Rémi Verschelde <rverschelde@gmail.com> | 2024-03-14 22:34:25 +0100 |
| commit | cfe7bd09af8cb4daf9519b93a5c53fa84d5d82f8 (patch) | |
| tree | 0f0db789131e13e2d6f960cfa800df22b3baabb0 | |
| parent | 5cf38f8f9931c1520d3cef6fc2c608210b70f44a (diff) | |
| parent | 8effd6b513b85f0757799d23176b28b72f5cedf3 (diff) | |
| download | redot-engine-cfe7bd09af8cb4daf9519b93a5c53fa84d5d82f8.tar.gz | |
Merge pull request #87414 from rburing/doc_warning_check_ray_collides
RayCast2D and RayCast3D: warn to check `is_colliding` before `get_collision_point` and `get_collision_normal`
| -rw-r--r-- | doc/classes/RayCast2D.xml | 5 | ||||
| -rw-r--r-- | doc/classes/RayCast3D.xml | 5 |
2 files changed, 6 insertions, 4 deletions
diff --git a/doc/classes/RayCast2D.xml b/doc/classes/RayCast2D.xml index a101fd24de..31daaab417 100644 --- a/doc/classes/RayCast2D.xml +++ b/doc/classes/RayCast2D.xml @@ -69,13 +69,14 @@ <return type="Vector2" /> <description> Returns the normal of the intersecting object's shape at the collision point, or [code]Vector2(0, 0)[/code] if the ray starts inside the shape and [member hit_from_inside] is [code]true[/code]. + [b]Note:[/b] Check that [method is_colliding] returns [code]true[/code] before calling this method to ensure the returned normal is valid and up-to-date. </description> </method> <method name="get_collision_point" qualifiers="const"> <return type="Vector2" /> <description> - 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. + Returns the collision point at which the ray intersects the closest object, in the global coordinate system. 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] Check that [method is_colliding] returns [code]true[/code] before calling this method to ensure the returned point is valid and up-to-date. </description> </method> <method name="is_colliding" qualifiers="const"> diff --git a/doc/classes/RayCast3D.xml b/doc/classes/RayCast3D.xml index 641c5ec653..f9f94e5cfc 100644 --- a/doc/classes/RayCast3D.xml +++ b/doc/classes/RayCast3D.xml @@ -76,13 +76,14 @@ <return type="Vector3" /> <description> Returns the normal of the intersecting object's shape at the collision point, or [code]Vector3(0, 0, 0)[/code] if the ray starts inside the shape and [member hit_from_inside] is [code]true[/code]. + [b]Note:[/b] Check that [method is_colliding] returns [code]true[/code] before calling this method to ensure the returned normal is valid and up-to-date. </description> </method> <method name="get_collision_point" qualifiers="const"> <return type="Vector3" /> <description> - 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. + Returns the collision point at which the ray intersects the closest object, in the global coordinate system. 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] Check that [method is_colliding] returns [code]true[/code] before calling this method to ensure the returned point is valid and up-to-date. </description> </method> <method name="is_colliding" qualifiers="const"> |