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

Added general notes on RayCast[2D] updating behaviour and force_raycast_update()

Browse source 
(cherry picked from commit 8d57640d37)
This commit is contained in:
Karol Walasek 2016-10-03 11:35:40 +02:00 committed by Rémi Verschelde
parent 0af331d1c0
commit 9f9d1eed7b
1 changed files with 14 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
doc/base/classes.xml
View file

@ -30921,6 +30921,8 @@
RayCast can ignore some objects by adding them to the exception list via [code]add_exception[/code], setting proper filtering with layers, or by filtering object types with type masks.
Only enabled raycasts will be able to query the space and report collisions!
RayCast calculates intersection every fixed frame (see [Node]), and the result is cached so it can be used later until the next frame. If multiple queries are required between fixed frames (or during the same frame) use [method force_raycast_update] after adjusting the raycast.
</description>
<methods>
<method name="add_exception">
@ -30941,6 +30943,11 @@
Removes all collision exception for this ray.
</description>
</method>
<method name="force_raycast_update">
<description>
Updates the collision information in case if this object's properties changed during the current frame (for example position, rotation or the cast_point). Note, [code]set_enabled[/code] is not required for this to work.
</description>
</method>
<method name="get_cast_to" qualifiers="const">
<return type="Vector3">
</return>
@ -31059,6 +31066,8 @@
RayCast2D can ignore some objects by adding them to the exception list via [code]add_exception[/code], setting proper filtering with layers, or by filtering object types with type masks.
Only enabled raycasts will be able to query the space and report collisions!
RayCast2D calculates intersection every fixed frame (see [Node]), and the result is cached so it can be used later until the next frame. If multiple queries are required between fixed frames (or during the same frame) use [method force_raycast_update] after adjusting the raycast.
</description>
<methods>
<method name="add_exception">
@ -31079,6 +31088,11 @@
Removes all collision exception for this ray.
</description>
</method>
<method name="force_raycast_update">
<description>
Updates the collision information in case if this object's properties changed during the current frame (for example position, rotation or the cast_point). Note, [code]set_enabled[/code] is not required for this to work.
</description>
</method>
<method name="get_cast_to" qualifiers="const">
<return type="Vector2">
</return>