diff options
| author | Karol Walasek | 2016-10-03 11:35:40 +0200 |
|---|---|---|
| committer | Rémi Verschelde | 2016-10-31 00:00:34 +0100 |
| commit | 9f9d1eed7ba8f72226701ce92318904066a35b3a (patch) | |
| tree | f297085ae1c0061846e3629b8f209c6799703f36 /doc/base/classes.xml | |
| parent | 0af331d1c0f4aa9b84bc6cf3ce12ef608644d897 (diff) | |
| download | godot-9f9d1eed7ba8f72226701ce92318904066a35b3a.tar.gz godot-9f9d1eed7ba8f72226701ce92318904066a35b3a.tar.zst godot-9f9d1eed7ba8f72226701ce92318904066a35b3a.zip | |
Added general notes on RayCast[2D] updating behaviour and force_raycast_update()
(cherry picked from commit 8d57640d3745084d5c4abc4e6926298c2f4a3fb4)
Diffstat (limited to 'doc/base/classes.xml')
| -rw-r--r-- | doc/base/classes.xml | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/base/classes.xml b/doc/base/classes.xml index dd4743670..d0da6c199 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -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> |