diff --git a/doc/classes/CollisionShape2D.xml b/doc/classes/CollisionShape2D.xml index 5fd8826a987..4166ee31d3e 100644 --- a/doc/classes/CollisionShape2D.xml +++ b/doc/classes/CollisionShape2D.xml @@ -19,6 +19,7 @@ Sets whether this collision shape should only detect collision on one side (top or bottom). + The margin used for one-way collision (in pixels). The actual shape owned by this collision shape. diff --git a/doc/classes/Physics2DShapeQueryParameters.xml b/doc/classes/Physics2DShapeQueryParameters.xml index 7d46dd28767..7ea00cbddcc 100644 --- a/doc/classes/Physics2DShapeQueryParameters.xml +++ b/doc/classes/Physics2DShapeQueryParameters.xml @@ -4,7 +4,7 @@ Parameters to be sent to a 2D shape physics query. - This class contains the shape and other parameters for intersection/collision queries. + This class contains the shape and other parameters for 2D intersection/collision queries. See also [Physics2DShapeQueryResult]. @@ -21,14 +21,16 @@ + If [code]true[/code], the query will take [Area2D]s into account. + If [code]true[/code], the query will take [PhysicsBody2D]s into account. - The physics layer the query should be made on. + The physics layer(s) the query will take into account (as a bitmask). - The list of objects or object [RID]s, that will be excluded from collisions. + The list of objects or object [RID]s that will be excluded from collisions. The collision margin for the shape. @@ -37,10 +39,10 @@ The motion of the shape being queried for. - The [RID] of the queried shape. See also [method set_shape]. + The queried shape's [RID]. See also [method set_shape]. - the transform matrix of the queried shape. + The queried shape's transform matrix. diff --git a/doc/classes/Physics2DShapeQueryResult.xml b/doc/classes/Physics2DShapeQueryResult.xml index dd38b488f59..06f943cb6d2 100644 --- a/doc/classes/Physics2DShapeQueryResult.xml +++ b/doc/classes/Physics2DShapeQueryResult.xml @@ -1,8 +1,10 @@ + Result of a 2D shape query in [Physics2DServer]. + The result of a 2D shape query in [Physics2DServer]. See also [Physics2DShapeQueryParameters]. @@ -11,6 +13,7 @@ + Returns the number of objects that intersected with the shape. @@ -19,6 +22,7 @@ + Returns the [Object] that intersected with the shape at index [code]idx[/code]. @@ -27,6 +31,7 @@ + Returns the instance ID of the [Object] that intersected with the shape at index [code]idx[/code]. @@ -35,6 +40,7 @@ + Returns the child index of the object's [Shape] that intersected with the shape at index [code]idx[/code]. @@ -43,6 +49,7 @@ + Returns the [RID] of the object that intersected with the shape at index [code]idx[/code]. diff --git a/doc/classes/PhysicsShapeQueryParameters.xml b/doc/classes/PhysicsShapeQueryParameters.xml index 7d7307592e3..d56247fcaf4 100644 --- a/doc/classes/PhysicsShapeQueryParameters.xml +++ b/doc/classes/PhysicsShapeQueryParameters.xml @@ -1,8 +1,10 @@ + Parameters to be sent to a 3D shape physics query. + This class contains the shape and other parameters for 3D intersection/collision queries. See also [PhysicsShapeQueryResult]. @@ -13,23 +15,31 @@ + Sets the [Shape] that will be used for collision/intersection queries. + If [code]true[/code], the query will take [Area]s into account. + 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 list of objects or object [RID]s that will be excluded from collisions. + The collision margin for the shape. + The queried shape's [RID]. See also [method set_shape]. + The queried shape's transform matrix. diff --git a/doc/classes/PhysicsShapeQueryResult.xml b/doc/classes/PhysicsShapeQueryResult.xml index 92a4393979d..1f151ebb1a8 100644 --- a/doc/classes/PhysicsShapeQueryResult.xml +++ b/doc/classes/PhysicsShapeQueryResult.xml @@ -1,9 +1,10 @@ - Result of a shape query in Physics2DServer. + Result of a 3D shape query in [PhysicsServer]. + The result of a 3D shape query in [PhysicsServer]. See also [PhysicsShapeQueryParameters]. @@ -12,6 +13,7 @@ + Returns the number of objects that intersected with the shape. @@ -20,6 +22,7 @@ + Returns the [Object] that intersected with the shape at index [code]idx[/code]. @@ -28,6 +31,7 @@ + Returns the instance ID of the [Object] that intersected with the shape at index [code]idx[/code]. @@ -36,6 +40,7 @@ + Returns the child index of the object's [Shape] that intersected with the shape at index [code]idx[/code]. @@ -44,6 +49,7 @@ + Returns the [RID] of the object that intersected with the shape at index [code]idx[/code]. diff --git a/doc/classes/PlaneShape.xml b/doc/classes/PlaneShape.xml index b94bb8e6134..ee841a3cff3 100644 --- a/doc/classes/PlaneShape.xml +++ b/doc/classes/PlaneShape.xml @@ -1,8 +1,10 @@ + Infinite plane shape for 3D collisions. + An infinite plane shape for 3D collisions. Note that the [Plane]'s normal matters; anything "below" the plane will collide with it. If the [PlaneShape] is used in a [PhysicsBody], it will cause colliding objects placed "below" it to teleport "above" the plane. @@ -10,6 +12,7 @@ + The [Plane] used by the [PlaneShape] for collision. diff --git a/doc/classes/Shape.xml b/doc/classes/Shape.xml index ce5947bc061..123353b59aa 100644 --- a/doc/classes/Shape.xml +++ b/doc/classes/Shape.xml @@ -13,6 +13,7 @@ + The collision margin for the shape. diff --git a/doc/classes/Shape2D.xml b/doc/classes/Shape2D.xml index 2c3120f04d0..70d55344ca5 100644 --- a/doc/classes/Shape2D.xml +++ b/doc/classes/Shape2D.xml @@ -77,6 +77,7 @@ + The shape's custom solver bias.