Skip to content

Commit cf746fd

Browse files
committed
Merge pull request #105051 from Mickeon/documentation-no-differences-PhysicsDirectSpaceState
Fix differences between PhysicsDirectSpaceState2D/3D docs
2 parents ed13d79 + 16df264 commit cf746fd

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

doc/classes/PhysicsDirectSpaceState2D.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,14 +33,14 @@
3333
<return type="Dictionary" />
3434
<param index="0" name="parameters" type="PhysicsShapeQueryParameters2D" />
3535
<description>
36-
Checks the intersections of a shape, given through a [PhysicsShapeQueryParameters2D] object, against the space. If it collides with more than one shape, the nearest one is selected. If the shape did not intersect anything, then an empty dictionary is returned instead.
37-
[b]Note:[/b] This method does not take into account the [code]motion[/code] property of the object. The returned object is a dictionary containing the following fields:
36+
Checks the intersections of a shape, given through a [PhysicsShapeQueryParameters2D] object, against the space. If it collides with more than one shape, the nearest one is selected. The returned object is a dictionary containing the following fields:
3837
[code]collider_id[/code]: The colliding object's ID.
3938
[code]linear_velocity[/code]: The colliding object's velocity [Vector2]. If the object is an [Area2D], the result is [code](0, 0)[/code].
4039
[code]normal[/code]: The collision normal of the query shape at the intersection point, pointing away from the intersecting object.
4140
[code]point[/code]: The intersection point.
4241
[code]rid[/code]: The intersecting object's [RID].
4342
[code]shape[/code]: The shape index of the colliding shape.
43+
If the shape did not intersect anything, then an empty dictionary is returned instead.
4444
</description>
4545
</method>
4646
<method name="intersect_point">

doc/classes/PhysicsDirectSpaceState3D.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
<return type="PackedFloat32Array" />
1616
<param index="0" name="parameters" type="PhysicsShapeQueryParameters3D" />
1717
<description>
18-
Checks how far a [Shape3D] can move without colliding. All the parameters for the query, including the shape, are supplied through a [PhysicsShapeQueryParameters3D] object.
18+
Checks how far a [Shape3D] can move without colliding. All the parameters for the query, including the shape and the motion, are supplied through a [PhysicsShapeQueryParameters3D] object.
1919
Returns an array with the safe and unsafe proportions (between 0 and 1) of the motion. The safe proportion is the maximum fraction of the motion that can be made without a collision. The unsafe proportion is the minimum fraction of the distance that must be moved for a collision. If no collision is detected a result of [code][1.0, 1.0][/code] will be returned.
2020
[b]Note:[/b] Any [Shape3D]s that the shape is already colliding with e.g. inside of, will be ignored. Use [method collide_shape] to determine the [Shape3D]s that the shape is already colliding with.
2121
</description>

0 commit comments

Comments
 (0)