noahbackus/godot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 2 Wiki Activity

doc: Use self-closing tags for return and argument

Browse Source 
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
2021-07-30 15:28:05 +02:00
parent a1c19b9a1e
commit 7adf4cc9b5
408 changed files with 14025 additions and 28050 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/classes/PhysicsDirectSpaceState3D.xml
+18 -36
View File
@@ -11,12 +11,9 @@
</tutorials>
<methods>
<method name="cast_motion">
<return type="Array">
</return>
<argument index="0" name="shape" type="PhysicsShapeQueryParameters3D">
</argument>
<argument index="1" name="motion" type="Vector3">
</argument>
<return type="Array" />
<argument index="0" name="shape" type="PhysicsShapeQueryParameters3D" />
<argument index="1" name="motion" type="Vector3" />
<description>
Checks how far a [Shape3D] can move without colliding. All the parameters for the query, including the shape, are supplied through a [PhysicsShapeQueryParameters3D] 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.
@@ -24,21 +21,16 @@
</description>
</method>
<method name="collide_shape">
<return type="Array">
</return>
<argument index="0" name="shape" type="PhysicsShapeQueryParameters3D">
</argument>
<argument index="1" name="max_results" type="int" default="32">
</argument>
<return type="Array" />
<argument index="0" name="shape" type="PhysicsShapeQueryParameters3D" />
<argument index="1" name="max_results" type="int" default="32" />
<description>
Checks the intersections of a shape, given through a [PhysicsShapeQueryParameters3D] 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="PhysicsShapeQueryParameters3D">
</argument>
<return type="Dictionary" />
<argument index="0" name="shape" type="PhysicsShapeQueryParameters3D" />
<description>
Checks the intersections of a shape, given through a [PhysicsShapeQueryParameters3D] 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:
[code]collider_id[/code]: The colliding object's ID.
@@ -51,20 +43,13 @@
</description>
</method>
<method name="intersect_ray">
<return type="Dictionary">
</return>
<argument index="0" name="from" type="Vector3">
</argument>
<argument index="1" name="to" type="Vector3">
</argument>
<argument index="2" name="exclude" type="Array" default="[]">
</argument>
<argument index="3" name="collision_mask" 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="Vector3" />
<argument index="1" name="to" type="Vector3" />
<argument index="2" name="exclude" type="Array" default="[]" />
<argument index="3" name="collision_mask" 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.
@@ -78,12 +63,9 @@
</description>
</method>
<method name="intersect_shape">
<return type="Array">
</return>
<argument index="0" name="shape" type="PhysicsShapeQueryParameters3D">
</argument>
<argument index="1" name="max_results" type="int" default="32">
</argument>
<return type="Array" />
<argument index="0" name="shape" type="PhysicsShapeQueryParameters3D" />
<argument index="1" name="max_results" type="int" default="32" />
<description>
Checks the intersections of a shape, given through a [PhysicsShapeQueryParameters3D] object, against the space. The intersected shapes are returned in an array containing dictionaries with the following fields:
[code]collider[/code]: The colliding object.