Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify expected types in RayCast3D documentation #101373

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
+3 −2
Open

Clarify expected types in RayCast3D documentation #101373

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c229fe8
Update RayCast3D.xml per Issue #100139
jburt137 Jan 9, 2025
babf4e7
Clarify expected types in `RayCast3D` docs, long description
jburt137 Jan 10, 2025
443f317
Update doc/classes/RayCast3D.xml
jburt137 Jan 10, 2025
665043b
Update doc/classes/RayCast3D.xml
jburt137 Jan 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions doc/classes/RayCast3D.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
<?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 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.
A raycast represents a ray from its origin to its [member target_position] that finds the closest object along its path, if it intersects any.
jburt137 marked this conversation as resolved.
Show resolved Hide resolved
[RayCast3D] can ignore some objects by adding them to an exception list, by making its detection reporting ignore [Area3D]s ([member collide_with_areas]) or [PhysicsBody3D]s ([member collide_with_bodies]), or by configuring physics layers.
[RayCast3D] calculates intersection every physics frame, and it holds the result until the next physics frame. For an immediate raycast, or if you want to configure a [RayCast3D] multiple times within the same physics frame, use [method force_raycast_update].
To sweep over a region of 3D space, you can approximate the region with multiple [RayCast3D]s or use [ShapeCast3D].
Expand Down Expand Up @@ -45,6 +45,7 @@
<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]).
[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.
</description>
</method>
<method name="get_collider_rid" qualifiers="const">
Expand Down