diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2017-10-21 23:44:46 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-10-21 23:44:46 +0200 |
| commit | 01a5a8b86c400a8e90f07f82411debf75b771633 (patch) | |
| tree | 9140ea4700b76387fa88208614c1bdf84f8e7b26 /doc | |
| parent | e0c14e630625f73fb4d8a0f6b06f4ae27db542cf (diff) | |
| parent | 7b12ae39f280e9168e314cba08107cce6b99c4ff (diff) | |
Merge pull request #12291 from RandomShaper/fix-raycast-naming
Rename RayCasts collision_layer to collision_mask
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/RayCast.xml | 14 | ||||
| -rw-r--r-- | doc/classes/RayCast2D.xml | 12 |
2 files changed, 13 insertions, 13 deletions
diff --git a/doc/classes/RayCast.xml b/doc/classes/RayCast.xml index 3782a98e3e..fc96a183eb 100644 --- a/doc/classes/RayCast.xml +++ b/doc/classes/RayCast.xml @@ -78,11 +78,11 @@ [/codeblock] </description> </method> - <method name="get_collision_layer" qualifiers="const"> + <method name="get_collision_mask" qualifiers="const"> <return type="int"> </return> <description> - Returns the collision layer for this ray. + Returns the collision mask for this ray. </description> </method> <method name="get_collision_normal" qualifiers="const"> @@ -147,13 +147,13 @@ Sets the ray destination point, so that the ray will test from the ray's origin to [code]local_point[/code]. </description> </method> - <method name="set_collision_layer"> + <method name="set_collision_mask"> <return type="void"> </return> - <argument index="0" name="layer" type="int"> + <argument index="0" name="mask" type="int"> </argument> <description> - Set the mask to filter objects. Only objects with at least the same mask element set will be detected. + Set the mask to filter objects. Only objects in at least one collision layer enabled in the mask will be detected. </description> </method> <method name="set_enabled"> @@ -179,8 +179,8 @@ <member name="cast_to" type="Vector3" setter="set_cast_to" getter="get_cast_to"> The ray's destination point, relative to the RayCast's [code]position[/code]. </member> - <member name="collision_layer" type="int" setter="set_collision_layer" getter="get_collision_layer"> - The RayCast's collision layer(s). Only bodies in the same collision layer(s) will be detected. + <member name="collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask"> + The ray's collision mask. Only objects in at least one collision layer enabled in the mask will be detected. </member> <member name="enabled" type="bool" setter="set_enabled" getter="is_enabled"> If [code]true[/code], collisions will be reported. Default value: [code]false[/code]. diff --git a/doc/classes/RayCast2D.xml b/doc/classes/RayCast2D.xml index 74ee0a8911..b6c657783d 100644 --- a/doc/classes/RayCast2D.xml +++ b/doc/classes/RayCast2D.xml @@ -77,11 +77,11 @@ [/codeblock] </description> </method> - <method name="get_collision_layer" qualifiers="const"> + <method name="get_collision_mask" qualifiers="const"> <return type="int"> </return> <description> - Returns the collision layer for this ray. + Returns the collision mask for this ray. </description> </method> <method name="get_collision_normal" qualifiers="const"> @@ -153,13 +153,13 @@ Sets the ray destination point, so that the ray will test from the ray's origin to [code]local_point[/code] </description> </method> - <method name="set_collision_layer"> + <method name="set_collision_mask"> <return type="void"> </return> <argument index="0" name="layer" type="int"> </argument> <description> - Set the mask to filter objects. Only objects with at least the same mask element set will be detected. + Set the mask to filter objects. Only objects in at least one collision layer enabled in the mask will be detected. </description> </method> <method name="set_enabled"> @@ -194,8 +194,8 @@ <member name="cast_to" type="Vector2" setter="set_cast_to" getter="get_cast_to"> The ray's destination point, relative to the RayCast's [code]position[/code]. </member> - <member name="collision_layer" type="int" setter="set_collision_layer" getter="get_collision_layer"> - The RayCast2D's collision layer(s). Only bodies in the same collision layer(s) will be detected. + <member name="collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask"> + The ray's collision mask. Only objects in at least one collision layer enabled in the mask will be detected. </member> <member name="enabled" type="bool" setter="set_enabled" getter="is_enabled"> If [code]true[/code], collisions will be reported. Default value: [code]false[/code]. |