diff options
Diffstat (limited to 'doc/classes/PhysicsDirectSpaceState2D.xml')
| -rw-r--r-- | doc/classes/PhysicsDirectSpaceState2D.xml | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/doc/classes/PhysicsDirectSpaceState2D.xml b/doc/classes/PhysicsDirectSpaceState2D.xml index 0b95243fe6..e5a9e5dacf 100644 --- a/doc/classes/PhysicsDirectSpaceState2D.xml +++ b/doc/classes/PhysicsDirectSpaceState2D.xml @@ -13,7 +13,7 @@ <methods> <method name="cast_motion"> <return type="Array" /> - <argument index="0" name="parameters" type="PhysicsShapeQueryParameters2D" /> + <param index="0" name="parameters" type="PhysicsShapeQueryParameters2D" /> <description> Checks how far a [Shape2D] can move without colliding. All the parameters for the query, including the shape and the motion, are supplied through a [PhysicsShapeQueryParameters2D] object. 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. @@ -22,8 +22,8 @@ </method> <method name="collide_shape"> <return type="Array" /> - <argument index="0" name="parameters" type="PhysicsShapeQueryParameters2D" /> - <argument index="1" name="max_results" type="int" default="32" /> + <param index="0" name="parameters" type="PhysicsShapeQueryParameters2D" /> + <param index="1" name="max_results" type="int" default="32" /> <description> Checks the intersections of a shape, given through a [PhysicsShapeQueryParameters2D] object, against the space. The resulting array contains a list of points where the shape intersects another. Like with [method intersect_shape], the number of returned results can be limited to save processing time. Returned points are a list of pairs of contact points. For each pair the first one is in the shape passed in [PhysicsShapeQueryParameters2D] object, second one is in the collided shape from the physics space. @@ -31,7 +31,7 @@ </method> <method name="get_rest_info"> <return type="Dictionary" /> - <argument index="0" name="parameters" type="PhysicsShapeQueryParameters2D" /> + <param index="0" name="parameters" type="PhysicsShapeQueryParameters2D" /> <description> 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. [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: @@ -45,8 +45,8 @@ </method> <method name="intersect_point"> <return type="Array" /> - <argument index="0" name="parameters" type="PhysicsPointQueryParameters2D" /> - <argument index="1" name="max_results" type="int" default="32" /> + <param index="0" name="parameters" type="PhysicsPointQueryParameters2D" /> + <param index="1" name="max_results" type="int" default="32" /> <description> Checks whether a point is inside any solid shape. Position and other parameters are defined through [PhysicsPointQueryParameters2D]. The shapes the point is inside of are returned in an array containing dictionaries with the following fields: [code]collider[/code]: The colliding object. @@ -59,7 +59,7 @@ </method> <method name="intersect_ray"> <return type="Dictionary" /> - <argument index="0" name="parameters" type="PhysicsRayQueryParameters2D" /> + <param index="0" name="parameters" type="PhysicsRayQueryParameters2D" /> <description> Intersects a ray in a given space. Ray position and other parameters are defined through [PhysicsRayQueryParameters2D]. The returned object is a dictionary with the following fields: [code]collider[/code]: The colliding object. @@ -73,8 +73,8 @@ </method> <method name="intersect_shape"> <return type="Array" /> - <argument index="0" name="parameters" type="PhysicsShapeQueryParameters2D" /> - <argument index="1" name="max_results" type="int" default="32" /> + <param index="0" name="parameters" type="PhysicsShapeQueryParameters2D" /> + <param index="1" name="max_results" type="int" default="32" /> <description> Checks the intersections of a shape, given through a [PhysicsShapeQueryParameters2D] object, against the space. The intersected shapes are returned in an array containing dictionaries with the following fields: [code]collider[/code]: The colliding object. |