From cc3b69cf7b2a7eac1e7bb1966831e340f5a5ca16 Mon Sep 17 00:00:00 2001 From: Hugo Locurcio Date: Mon, 3 Aug 2020 13:58:51 +0200 Subject: [PATCH] Reference the online documentation in collision layer/mask properties See https://github.com/godotengine/godot-docs/pull/3863. (cherry picked from commit c73c327babce096faa083ade0e308a35bd0a6759) --- doc/classes/Area.xml | 4 ++-- doc/classes/Area2D.xml | 4 ++-- doc/classes/ClippedCamera.xml | 2 +- doc/classes/Physics2DShapeQueryParameters.xml | 2 +- doc/classes/PhysicsBody.xml | 4 ++-- doc/classes/PhysicsBody2D.xml | 4 ++-- doc/classes/PhysicsShapeQueryParameters.xml | 2 +- doc/classes/RayCast.xml | 2 +- doc/classes/RayCast2D.xml | 2 +- doc/classes/SoftBody.xml | 4 ++-- doc/classes/SpringArm.xml | 2 +- doc/classes/TileMap.xml | 4 ++-- modules/csg/doc_classes/CSGShape.xml | 4 ++-- modules/gridmap/doc_classes/GridMap.xml | 2 +- 14 files changed, 21 insertions(+), 21 deletions(-) diff --git a/doc/classes/Area.xml b/doc/classes/Area.xml index c7b1d8ca07..b0f8cf91eb 100644 --- a/doc/classes/Area.xml +++ b/doc/classes/Area.xml @@ -96,10 +96,10 @@ If [code]true[/code], the area's audio bus overrides the default audio bus. - The area's physics layer(s). Collidable objects can exist in any of 32 different layers. A contact is detected if object A is in any of the layers that object B scans, or object B is in any layers that object A scans. See also [member collision_mask]. + The area's physics layer(s). Collidable objects can exist in any of 32 different layers. A contact is detected if object A is in any of the layers that object B scans, or object B is in any layers that object A scans. See also [member collision_mask]. See [url=https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information. - The physics layers this area scans to determine collision detection. + The physics layers this area scans to determine collision detection. See [url=https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information. The area's gravity intensity (ranges from -1024 to 1024). This value multiplies the gravity vector. This is useful to alter the force of gravity without altering its direction. diff --git a/doc/classes/Area2D.xml b/doc/classes/Area2D.xml index 7698b4585c..0614c5bee3 100644 --- a/doc/classes/Area2D.xml +++ b/doc/classes/Area2D.xml @@ -97,10 +97,10 @@ If [code]true[/code], the area's audio bus overrides the default audio bus. - The area's physics layer(s). Collidable objects can exist in any of 32 different layers. A contact is detected if object A is in any of the layers that object B scans, or object B is in any layers that object A scans. See also [member collision_mask]. + The area's physics layer(s). Collidable objects can exist in any of 32 different layers. A contact is detected if object A is in any of the layers that object B scans, or object B is in any layers that object A scans. See also [member collision_mask]. See [url=https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information. - The physics layers this area scans to determine collision detection. + The physics layers this area scans to determine collision detection. See [url=https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information. The area's gravity intensity (ranges from -1024 to 1024). This value multiplies the gravity vector. This is useful to alter the force of gravity without altering its direction. diff --git a/doc/classes/ClippedCamera.xml b/doc/classes/ClippedCamera.xml index 7d2454b48a..3d8a9cf758 100644 --- a/doc/classes/ClippedCamera.xml +++ b/doc/classes/ClippedCamera.xml @@ -90,7 +90,7 @@ If [code]true[/code], the camera stops on contact with [PhysicsBody]s. - The camera's collision mask. Only objects in at least one collision layer matching the mask will be detected. + The camera's collision mask. Only objects in at least one collision layer matching the mask will be detected. See [url=https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information. The camera's collision margin. The camera can't get closer than this distance to a colliding object. diff --git a/doc/classes/Physics2DShapeQueryParameters.xml b/doc/classes/Physics2DShapeQueryParameters.xml index 20b931227a..dbf1073fe7 100644 --- a/doc/classes/Physics2DShapeQueryParameters.xml +++ b/doc/classes/Physics2DShapeQueryParameters.xml @@ -27,7 +27,7 @@ If [code]true[/code], the query will take [PhysicsBody2D]s into account. - The physics layer(s) the query will take into account (as a bitmask). + The physics layer(s) the query will take into account (as a bitmask). See [url=https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information. The list of objects or object [RID]s that will be excluded from collisions. diff --git a/doc/classes/PhysicsBody.xml b/doc/classes/PhysicsBody.xml index 8af69452e3..15dab17507 100644 --- a/doc/classes/PhysicsBody.xml +++ b/doc/classes/PhysicsBody.xml @@ -80,10 +80,10 @@ The physics layers this area is in. Collidable objects can exist in any of 32 different layers. These layers work like a tagging system, and are not visual. A collidable can use these layers to select with which objects it can collide, using the [member collision_mask] property. - A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A. + A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A. See [url=https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information. - The physics layers this area scans for collisions. + The physics layers this area scans for collisions. See [url=https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information. diff --git a/doc/classes/PhysicsBody2D.xml b/doc/classes/PhysicsBody2D.xml index dd9460e844..ab0b857fdf 100644 --- a/doc/classes/PhysicsBody2D.xml +++ b/doc/classes/PhysicsBody2D.xml @@ -80,10 +80,10 @@ The physics layers this area is in. Collidable objects can exist in any of 32 different layers. These layers work like a tagging system, and are not visual. A collidable can use these layers to select with which objects it can collide, using the [member collision_mask] property. - A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A. + A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A. See [url=https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information. - The physics layers this area scans for collisions. + The physics layers this area scans for collisions. See [url=https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information. diff --git a/doc/classes/PhysicsShapeQueryParameters.xml b/doc/classes/PhysicsShapeQueryParameters.xml index b3ba195212..80cfe3419c 100644 --- a/doc/classes/PhysicsShapeQueryParameters.xml +++ b/doc/classes/PhysicsShapeQueryParameters.xml @@ -27,7 +27,7 @@ If [code]true[/code], the query will take [PhysicsBody]s into account. - The physics layer(s) the query will take into account (as a bitmask). + The physics layer(s) the query will take into account (as a bitmask). See [url=https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information. The list of objects or object [RID]s that will be excluded from collisions. diff --git a/doc/classes/RayCast.xml b/doc/classes/RayCast.xml index 72a718e3af..997bb93ba9 100644 --- a/doc/classes/RayCast.xml +++ b/doc/classes/RayCast.xml @@ -136,7 +136,7 @@ If [code]true[/code], collision with [PhysicsBody]s will be reported. - The ray's collision mask. Only objects in at least one collision layer enabled in the mask will be detected. + The ray's collision mask. Only objects in at least one collision layer enabled in the mask will be detected. See [url=https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information. If [code]true[/code], collisions will be reported. diff --git a/doc/classes/RayCast2D.xml b/doc/classes/RayCast2D.xml index dd20e25f4e..dfeff6e801 100644 --- a/doc/classes/RayCast2D.xml +++ b/doc/classes/RayCast2D.xml @@ -133,7 +133,7 @@ If [code]true[/code], collision with [PhysicsBody2D]s will be reported. - The ray's collision mask. Only objects in at least one collision layer enabled in the mask will be detected. + The ray's collision mask. Only objects in at least one collision layer enabled in the mask will be detected. See [url=https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information. If [code]true[/code], collisions will be reported. diff --git a/doc/classes/SoftBody.xml b/doc/classes/SoftBody.xml index c9626abbc9..88e61d9029 100644 --- a/doc/classes/SoftBody.xml +++ b/doc/classes/SoftBody.xml @@ -82,10 +82,10 @@ The physics layers this SoftBody is in. Collidable objects can exist in any of 32 different layers. These layers work like a tagging system, and are not visual. A collidable can use these layers to select with which objects it can collide, using the collision_mask property. - A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A. + A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A. See [url=https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information. - The physics layers this SoftBody scans for collisions. + The physics layers this SoftBody scans for collisions. See [url=https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information. diff --git a/doc/classes/SpringArm.xml b/doc/classes/SpringArm.xml index 6fc3cd187b..5051a210b9 100644 --- a/doc/classes/SpringArm.xml +++ b/doc/classes/SpringArm.xml @@ -47,7 +47,7 @@ - The layers against which the collision check shall be done. + The layers against which the collision check shall be done. See [url=https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information. When the collision check is made, a candidate length for the SpringArm is given. diff --git a/doc/classes/TileMap.xml b/doc/classes/TileMap.xml index 74404447c4..328d24733e 100644 --- a/doc/classes/TileMap.xml +++ b/doc/classes/TileMap.xml @@ -287,10 +287,10 @@ Friction value for static body collisions (see [code]collision_use_kinematic[/code]). - The collision layer(s) for all colliders in the TileMap. + The collision layer(s) for all colliders in the TileMap. See [url=https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information. - The collision mask(s) for all colliders in the TileMap. + The collision mask(s) for all colliders in the TileMap. See [url=https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information. If [code]true[/code], TileMap collisions will be handled as a kinematic body. If [code]false[/code], collisions will be handled as static body. diff --git a/modules/csg/doc_classes/CSGShape.xml b/modules/csg/doc_classes/CSGShape.xml index e7048f21a7..cb53bf2fdb 100644 --- a/modules/csg/doc_classes/CSGShape.xml +++ b/modules/csg/doc_classes/CSGShape.xml @@ -71,10 +71,10 @@ The physics layers this area is in. Collidable objects can exist in any of 32 different layers. These layers work like a tagging system, and are not visual. A collidable can use these layers to select with which objects it can collide, using the collision_mask property. - A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A. + A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A. See [url=https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information. - The physics layers this CSG shape scans for collisions. + The physics layers this CSG shape scans for collisions. See [url=https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information. The operation that is performed on this shape. This is ignored for the first CSG child node as the operation is between this node and the previous child of this nodes parent. diff --git a/modules/gridmap/doc_classes/GridMap.xml b/modules/gridmap/doc_classes/GridMap.xml index 1e34ebc2f6..626cf424ff 100644 --- a/modules/gridmap/doc_classes/GridMap.xml +++ b/modules/gridmap/doc_classes/GridMap.xml @@ -221,7 +221,7 @@ GridMaps act as static bodies, meaning they aren't affected by gravity or other forces. They only affect other physics bodies that collide with them. - The physics layers this GridMap detects collisions in. + The physics layers this GridMap detects collisions in. See [url=https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information. The assigned [MeshLibrary].