diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2020-09-10 19:19:59 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-09-10 19:19:59 +0200 |
| commit | 0819657c3ba9de3328a18b52de1cf3c0b13f2d13 (patch) | |
| tree | 48e0e3a91defb995549dad6977c4baaf91e3cdf9 /doc/classes/RayCast2D.xml | |
| parent | 43930aaa28c1e7c0e89af78d4a075a215d545ca6 (diff) | |
| parent | a706c22db7a00e28bdcaef57ae973728bdcc2a86 (diff) | |
Merge pull request #41954 from Calinou/raycast-rename-cast-to
Rename RayCast's `cast_to` property to `target_position`
Diffstat (limited to 'doc/classes/RayCast2D.xml')
| -rw-r--r-- | doc/classes/RayCast2D.xml | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/classes/RayCast2D.xml b/doc/classes/RayCast2D.xml index db4b9a0383..5fc5b09833 100644 --- a/doc/classes/RayCast2D.xml +++ b/doc/classes/RayCast2D.xml @@ -4,8 +4,8 @@ Query the closest object intersecting a ray. </brief_description> <description> - A RayCast represents a line from its origin to its destination position, [code]cast_to[/code]. It is used to query the 2D space in order to find the closest object along the path of the ray. - RayCast2D can ignore some objects by adding them to the exception list via [code]add_exception[/code], by setting proper filtering with collision layers, or by filtering object types with type masks. + A RayCast represents a line from its origin to its destination position, [member target_position]. It is used to query the 2D space in order to find the closest object along the path of the ray. + RayCast2D can ignore some objects by adding them to the exception list via [method add_exception], by setting proper filtering with collision layers, or by filtering object types with type masks. RayCast2D can be configured to report collisions with [Area2D]s ([member collide_with_areas]) and/or [PhysicsBody2D]s ([member collide_with_bodies]). Only enabled raycasts will be able to query the space and report collisions. RayCast2D calculates intersection every physics frame (see [Node]), and the result is cached so it can be used later until the next frame. If multiple queries are required between physics frames (or during the same frame) use [method force_raycast_update] after adjusting the raycast. @@ -123,7 +123,7 @@ </method> </methods> <members> - <member name="cast_to" type="Vector2" setter="set_cast_to" getter="get_cast_to" default="Vector2( 0, 50 )"> + <member name="target_position" type="Vector2" setter="set_target_position" getter="get_target_position" default="Vector2( 0, 50 )"> The ray's destination point, relative to the RayCast's [code]position[/code]. </member> <member name="collide_with_areas" type="bool" setter="set_collide_with_areas" getter="is_collide_with_areas_enabled" default="false"> |