From 7b12ae39f280e9168e314cba08107cce6b99c4ff Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Pedro=20J=2E=20Est=C3=A9banez?= <pedrojrulez@gmail.com>
Date: Sat, 21 Oct 2017 22:17:26 +0200
Subject: Rename RayCasts collision_layer to collision_mask

The point is that `RayCast`s are checked against objects' `collision_layer`(s), but they themselves are considered no to _belong_ to any layer. Therefore, the correct name for their property is `collision_mask`, rather than `collision_layer`.

Only renaming is needed since the behavior was already the right one, only that it wasn't matching what users would expect from the name and description of the property.

Fixes #7589, where it's also discussed.
---
 doc/classes/RayCast.xml   | 14 +++++++-------
 doc/classes/RayCast2D.xml | 12 ++++++------
 2 files changed, 13 insertions(+), 13 deletions(-)

(limited to 'doc/classes')

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].
-- 
cgit v1.2.3