asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update doc/classes/RayCast3D.xml

Browse source 
Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>
This commit is contained in:
Loff3 2024-10-17 10:54:52 +02:00 committed by GitHub
parent 7a1f2e55ec
commit b1dfc29d16
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 1 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
doc/classes/RayCast3D.xml
View file

@ -8,7 +8,7 @@
[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].
[b]Note:[/b] [RayCast3D] needs at least one physics frame to compute collision data. Therefore, collision data may not be available during the [method Node._ready] function. Calling method force_raycast_update] in [method Node._ready] may not resolve this issue. Instead, perform collision checks in [method Node._physics_process] which runs after the physics engine updates all physics bodies, or use [method Object.call_deferred] to delay the execution of your code.
[b]Note:[/b] [RayCast3D] needs at least one physics frame to compute collision data. Therefore, collision data may not be available during the [method Node._ready] function. Calling [method force_raycast_update] in [method Node._ready] may not resolve this issue. Instead, perform collision checks in [method Node._physics_process] which runs after the physics engine updates all physics bodies, or use [method Object.call_deferred] to delay the execution of your code.
</description>
<tutorials>
<link title="Ray-casting">$DOCS_URL/tutorials/physics/ray-casting.html</link>