Clarify expected types in RayCast3D documentation
#101373
Open
+2
−2
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
AThousandShips
changed the title
RayCast3D documentation
AThousandShips
added
bug
documentation
cherrypick:4.2
| @@ -44,7 +44,7 @@ | |||
| <method name="get_collider" qualifiers="const"> | |||
| <return type="Object" /> | |||
| <description> | |||
| Returns the first object that the ray intersects, or [code]null[/code] if no object is intersecting the ray (i.e. [method is_colliding] returns [code]false[/code]). | |||
| Returns the first object that the ray intersects, or [code]null[/code] if no object is intersecting the ray (i.e. [method is_colliding] returns [code]false[/code]). This object is not guaranteed to be a [CollisionObject3D]. For example, if the ray intersects a [CSGShape3D] or a [GridMap], the method will return a [CSGShape3D] instance or [GridMap] instance. To validate and ensure type safety, you should explicitly check the type of the returned object before casting. | |||
There was a problem hiding this comment.
Suggested change
| Returns the first object that the ray intersects, or [code]null[/code] if no object is intersecting the ray (i.e. [method is_colliding] returns [code]false[/code]). This object is not guaranteed to be a [CollisionObject3D]. For example, if the ray intersects a [CSGShape3D] or a [GridMap], the method will return a [CSGShape3D] instance or [GridMap] instance. To validate and ensure type safety, you should explicitly check the type of the returned object before casting. | |
| Returns the first object that the ray intersects, or [code]null[/code] if no object is intersecting the ray (i.e. [method is_colliding] returns [code]false[/code]). | |
| [b]Note:[/b] This object is not guaranteed to be a [CollisionObject3D]. For example, if the ray intersects a [CSGShape3D] or a [GridMap], the method will return a [CSGShape3D] or [GridMap] instance. |
Casting is a kind of type testing, also I don't think an explicit comment is needed, but if it is added it should be more brief
| @@ -1,7 +1,7 @@ | |||
| <?xml version="1.0" encoding="UTF-8" ?> | |||
| <class name="RayCast3D" inherits="Node3D" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> | |||
| <brief_description> | |||
| A ray in 3D space, used to find the first [CollisionObject3D] it intersects. | |||
| A ray in 3D space, used to find the first [Object] or [CollisionObject3D] it intersects. | |||
There was a problem hiding this comment.
Suggested change
| A ray in 3D space, used to find the first [Object] or [CollisionObject3D] it intersects. | |
| A ray in 3D space, used to find the first object it intersects. |
Let's remove any reference to avoid confusion
| @@ -1,7 +1,7 @@ | |||
| <?xml version="1.0" encoding="UTF-8" ?> | |||
| <class name="RayCast3D" inherits="Node3D" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> | |||
| <brief_description> | |||
| A ray in 3D space, used to find the first [CollisionObject3D] it intersects. | |||
| A ray in 3D space, used to find the first [Object] or [CollisionObject3D] it intersects. | |||
| </brief_description> | |||
| <description> | |||
| A raycast represents a ray from its origin to its [member target_position] that finds the closest [CollisionObject3D] along its path, if it intersects any. | |||
There was a problem hiding this comment.
The long description needs to be updated as well
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updating documentation, per #100139 (comment)
rburing
on Dec 7, 2024
Member
Yes, the documentation is wrong (too narrow). In addition to CSG there's also GridMap. Fixes to the documentation are welcome.