diff options
| author | Rémi Verschelde <remi@verschelde.fr> | 2016-10-22 12:40:14 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2016-10-22 12:40:14 +0200 |
| commit | afd86ee240301aef499e35767cb3e12a7d36d948 (patch) | |
| tree | 3a0c49bc4b168ee94646d9644ba7ea2cb7cfd83c /doc | |
| parent | c23e8797f1bec30defd1903cfeef0992cb1f1a89 (diff) | |
| parent | 8d57640d3745084d5c4abc4e6926298c2f4a3fb4 (diff) | |
Merge pull request #6090 from WalasPrime/raytrace_force
Added force_raycast_update GDScript method for RayCast[2D]
Diffstat (limited to 'doc')
| -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 4e0ba53f48..5eb021f6c0 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -31871,6 +31871,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"> @@ -31891,6 +31893,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> @@ -32009,6 +32016,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"> @@ -32029,6 +32038,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> |