doc: Use self-closing tags for return and argument
For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
This commit is contained in:
Rémi Verschelde
@ -11,10 +11,8 @@
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="cast_motion">
|
||||
<return type="Array">
|
||||
</return>
|
||||
<argument index="0" name="shape" type="PhysicsShapeQueryParameters2D">
|
||||
</argument>
|
||||
<return type="Array" />
|
||||
<argument index="0" name="shape" 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,21 +20,16 @@
|
||||
</description>
|
||||
</method>
|
||||
<method name="collide_shape">
|
||||
<return type="Array">
|
||||
</return>
|
||||
<argument index="0" name="shape" type="PhysicsShapeQueryParameters2D">
|
||||
</argument>
|
||||
<argument index="1" name="max_results" type="int" default="32">
|
||||
</argument>
|
||||
<return type="Array" />
|
||||
<argument index="0" name="shape" type="PhysicsShapeQueryParameters2D" />
|
||||
<argument 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.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_rest_info">
|
||||
<return type="Dictionary">
|
||||
</return>
|
||||
<argument index="0" name="shape" type="PhysicsShapeQueryParameters2D">
|
||||
</argument>
|
||||
<return type="Dictionary" />
|
||||
<argument index="0" name="shape" 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:
|
||||
@ -50,20 +43,13 @@
|
||||
</description>
|
||||
</method>
|
||||
<method name="intersect_point">
|
||||
<return type="Array">
|
||||
</return>
|
||||
<argument index="0" name="point" type="Vector2">
|
||||
</argument>
|
||||
<argument index="1" name="max_results" type="int" default="32">
|
||||
</argument>
|
||||
<argument index="2" name="exclude" type="Array" default="[]">
|
||||
</argument>
|
||||
<argument index="3" name="collision_layer" type="int" default="2147483647">
|
||||
</argument>
|
||||
<argument index="4" name="collide_with_bodies" type="bool" default="true">
|
||||
</argument>
|
||||
<argument index="5" name="collide_with_areas" type="bool" default="false">
|
||||
</argument>
|
||||
<return type="Array" />
|
||||
<argument index="0" name="point" type="Vector2" />
|
||||
<argument index="1" name="max_results" type="int" default="32" />
|
||||
<argument index="2" name="exclude" type="Array" default="[]" />
|
||||
<argument index="3" name="collision_layer" type="int" default="2147483647" />
|
||||
<argument index="4" name="collide_with_bodies" type="bool" default="true" />
|
||||
<argument index="5" name="collide_with_areas" type="bool" default="false" />
|
||||
<description>
|
||||
Checks whether a point is inside any solid shape. The shapes the point is inside of are returned in an array containing dictionaries with the following fields:
|
||||
[code]collider[/code]: The colliding object.
|
||||
@ -76,40 +62,25 @@
|
||||
</description>
|
||||
</method>
|
||||
<method name="intersect_point_on_canvas">
|
||||
<return type="Array">
|
||||
</return>
|
||||
<argument index="0" name="point" type="Vector2">
|
||||
</argument>
|
||||
<argument index="1" name="canvas_instance_id" type="int">
|
||||
</argument>
|
||||
<argument index="2" name="max_results" type="int" default="32">
|
||||
</argument>
|
||||
<argument index="3" name="exclude" type="Array" default="[]">
|
||||
</argument>
|
||||
<argument index="4" name="collision_layer" type="int" default="2147483647">
|
||||
</argument>
|
||||
<argument index="5" name="collide_with_bodies" type="bool" default="true">
|
||||
</argument>
|
||||
<argument index="6" name="collide_with_areas" type="bool" default="false">
|
||||
</argument>
|
||||
<return type="Array" />
|
||||
<argument index="0" name="point" type="Vector2" />
|
||||
<argument index="1" name="canvas_instance_id" type="int" />
|
||||
<argument index="2" name="max_results" type="int" default="32" />
|
||||
<argument index="3" name="exclude" type="Array" default="[]" />
|
||||
<argument index="4" name="collision_layer" type="int" default="2147483647" />
|
||||
<argument index="5" name="collide_with_bodies" type="bool" default="true" />
|
||||
<argument index="6" name="collide_with_areas" type="bool" default="false" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="intersect_ray">
|
||||
<return type="Dictionary">
|
||||
</return>
|
||||
<argument index="0" name="from" type="Vector2">
|
||||
</argument>
|
||||
<argument index="1" name="to" type="Vector2">
|
||||
</argument>
|
||||
<argument index="2" name="exclude" type="Array" default="[]">
|
||||
</argument>
|
||||
<argument index="3" name="collision_layer" type="int" default="2147483647">
|
||||
</argument>
|
||||
<argument index="4" name="collide_with_bodies" type="bool" default="true">
|
||||
</argument>
|
||||
<argument index="5" name="collide_with_areas" type="bool" default="false">
|
||||
</argument>
|
||||
<return type="Dictionary" />
|
||||
<argument index="0" name="from" type="Vector2" />
|
||||
<argument index="1" name="to" type="Vector2" />
|
||||
<argument index="2" name="exclude" type="Array" default="[]" />
|
||||
<argument index="3" name="collision_layer" type="int" default="2147483647" />
|
||||
<argument index="4" name="collide_with_bodies" type="bool" default="true" />
|
||||
<argument index="5" name="collide_with_areas" type="bool" default="false" />
|
||||
<description>
|
||||
Intersects a ray in a given space. The returned object is a dictionary with the following fields:
|
||||
[code]collider[/code]: The colliding object.
|
||||
@ -124,12 +95,9 @@
|
||||
</description>
|
||||
</method>
|
||||
<method name="intersect_shape">
|
||||
<return type="Array">
|
||||
</return>
|
||||
<argument index="0" name="shape" type="PhysicsShapeQueryParameters2D">
|
||||
</argument>
|
||||
<argument index="1" name="max_results" type="int" default="32">
|
||||
</argument>
|
||||
<return type="Array" />
|
||||
<argument index="0" name="shape" type="PhysicsShapeQueryParameters2D" />
|
||||
<argument index="1" name="max_results" type="int" default="32" />
|
||||
<description>
|
||||
Checks the intersections of a shape, given through a [PhysicsShapeQueryParameters2D] object, against the space.
|
||||
[b]Note:[/b] This method does not take into account the [code]motion[/code] property of the object. The intersected shapes are returned in an array containing dictionaries with the following fields:
|
||||
|
||||
Reference in New Issue
Block a user