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
@ -12,34 +12,28 @@
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="get_overlapping_areas" qualifiers="const">
|
||||
<return type="Area3D[]">
|
||||
</return>
|
||||
<return type="Area3D[]" />
|
||||
<description>
|
||||
Returns a list of intersecting [Area3D]s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_overlapping_bodies" qualifiers="const">
|
||||
<return type="Node3D[]">
|
||||
</return>
|
||||
<return type="Node3D[]" />
|
||||
<description>
|
||||
Returns a list of intersecting [PhysicsBody3D]s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead.
|
||||
</description>
|
||||
</method>
|
||||
<method name="overlaps_area" qualifiers="const">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<argument index="0" name="area" type="Node">
|
||||
</argument>
|
||||
<return type="bool" />
|
||||
<argument index="0" name="area" type="Node" />
|
||||
<description>
|
||||
If [code]true[/code], the given area overlaps the Area3D.
|
||||
[b]Note:[/b] The result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead.
|
||||
</description>
|
||||
</method>
|
||||
<method name="overlaps_body" qualifiers="const">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<argument index="0" name="body" type="Node">
|
||||
</argument>
|
||||
<return type="bool" />
|
||||
<argument index="0" name="body" type="Node" />
|
||||
<description>
|
||||
If [code]true[/code], the given physics body overlaps the Area3D.
|
||||
[b]Note:[/b] The result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead.
|
||||
@ -101,30 +95,24 @@
|
||||
</members>
|
||||
<signals>
|
||||
<signal name="area_entered">
|
||||
<argument index="0" name="area" type="Area3D">
|
||||
</argument>
|
||||
<argument index="0" name="area" type="Area3D" />
|
||||
<description>
|
||||
Emitted when another Area3D enters this Area3D. Requires [member monitoring] to be set to [code]true[/code].
|
||||
[code]area[/code] the other Area3D.
|
||||
</description>
|
||||
</signal>
|
||||
<signal name="area_exited">
|
||||
<argument index="0" name="area" type="Area3D">
|
||||
</argument>
|
||||
<argument index="0" name="area" type="Area3D" />
|
||||
<description>
|
||||
Emitted when another Area3D exits this Area3D. Requires [member monitoring] to be set to [code]true[/code].
|
||||
[code]area[/code] the other Area3D.
|
||||
</description>
|
||||
</signal>
|
||||
<signal name="area_shape_entered">
|
||||
<argument index="0" name="area_rid" type="RID">
|
||||
</argument>
|
||||
<argument index="1" name="area" type="Area3D">
|
||||
</argument>
|
||||
<argument index="2" name="area_shape" type="int">
|
||||
</argument>
|
||||
<argument index="3" name="local_shape" type="int">
|
||||
</argument>
|
||||
<argument index="0" name="area_rid" type="RID" />
|
||||
<argument index="1" name="area" type="Area3D" />
|
||||
<argument index="2" name="area_shape" type="int" />
|
||||
<argument index="3" name="local_shape" type="int" />
|
||||
<description>
|
||||
Emitted when one of another Area3D's [Shape3D]s enters one of this Area3D's [Shape3D]s. Requires [member monitoring] to be set to [code]true[/code].
|
||||
[code]area_id[/code] the [RID] of the other Area3D's [CollisionObject3D] used by the [PhysicsServer3D].
|
||||
@ -134,14 +122,10 @@
|
||||
</description>
|
||||
</signal>
|
||||
<signal name="area_shape_exited">
|
||||
<argument index="0" name="area_rid" type="RID">
|
||||
</argument>
|
||||
<argument index="1" name="area" type="Area3D">
|
||||
</argument>
|
||||
<argument index="2" name="area_shape" type="int">
|
||||
</argument>
|
||||
<argument index="3" name="local_shape" type="int">
|
||||
</argument>
|
||||
<argument index="0" name="area_rid" type="RID" />
|
||||
<argument index="1" name="area" type="Area3D" />
|
||||
<argument index="2" name="area_shape" type="int" />
|
||||
<argument index="3" name="local_shape" type="int" />
|
||||
<description>
|
||||
Emitted when one of another Area3D's [Shape3D]s enters one of this Area3D's [Shape3D]s. Requires [member monitoring] to be set to [code]true[/code].
|
||||
[code]area_id[/code] the [RID] of the other Area3D's [CollisionObject3D] used by the [PhysicsServer3D].
|
||||
@ -151,30 +135,24 @@
|
||||
</description>
|
||||
</signal>
|
||||
<signal name="body_entered">
|
||||
<argument index="0" name="body" type="Node3D">
|
||||
</argument>
|
||||
<argument index="0" name="body" type="Node3D" />
|
||||
<description>
|
||||
Emitted when a [PhysicsBody3D] or [GridMap] enters this Area3D. Requires [member monitoring] to be set to [code]true[/code]. [GridMap]s are detected if the [MeshLibrary] has Collision [Shape3D]s.
|
||||
[code]body[/code] the [Node], if it exists in the tree, of the other [PhysicsBody3D] or [GridMap].
|
||||
</description>
|
||||
</signal>
|
||||
<signal name="body_exited">
|
||||
<argument index="0" name="body" type="Node3D">
|
||||
</argument>
|
||||
<argument index="0" name="body" type="Node3D" />
|
||||
<description>
|
||||
Emitted when a [PhysicsBody3D] or [GridMap] exits this Area3D. Requires [member monitoring] to be set to [code]true[/code]. [GridMap]s are detected if the [MeshLibrary] has Collision [Shape3D]s.
|
||||
[code]body[/code] the [Node], if it exists in the tree, of the other [PhysicsBody3D] or [GridMap].
|
||||
</description>
|
||||
</signal>
|
||||
<signal name="body_shape_entered">
|
||||
<argument index="0" name="body_rid" type="RID">
|
||||
</argument>
|
||||
<argument index="1" name="body" type="Node3D">
|
||||
</argument>
|
||||
<argument index="2" name="body_shape" type="int">
|
||||
</argument>
|
||||
<argument index="3" name="local_shape" type="int">
|
||||
</argument>
|
||||
<argument index="0" name="body_rid" type="RID" />
|
||||
<argument index="1" name="body" type="Node3D" />
|
||||
<argument index="2" name="body_shape" type="int" />
|
||||
<argument index="3" name="local_shape" type="int" />
|
||||
<description>
|
||||
Emitted when one of a [PhysicsBody3D] or [GridMap]'s [Shape3D]s enters one of this Area3D's [Shape3D]s. Requires [member monitoring] to be set to [code]true[/code]. [GridMap]s are detected if the [MeshLibrary] has Collision [Shape3D]s.
|
||||
[code]body_id[/code] the [RID] of the [PhysicsBody3D] or [MeshLibrary]'s [CollisionObject3D] used by the [PhysicsServer3D].
|
||||
@ -184,14 +162,10 @@
|
||||
</description>
|
||||
</signal>
|
||||
<signal name="body_shape_exited">
|
||||
<argument index="0" name="body_rid" type="RID">
|
||||
</argument>
|
||||
<argument index="1" name="body" type="Node3D">
|
||||
</argument>
|
||||
<argument index="2" name="body_shape" type="int">
|
||||
</argument>
|
||||
<argument index="3" name="local_shape" type="int">
|
||||
</argument>
|
||||
<argument index="0" name="body_rid" type="RID" />
|
||||
<argument index="1" name="body" type="Node3D" />
|
||||
<argument index="2" name="body_shape" type="int" />
|
||||
<argument index="3" name="local_shape" type="int" />
|
||||
<description>
|
||||
Emitted when one of a [PhysicsBody3D] or [GridMap]'s [Shape3D]s enters one of this Area3D's [Shape3D]s. Requires [member monitoring] to be set to [code]true[/code]. [GridMap]s are detected if the [MeshLibrary] has Collision [Shape3D]s.
|
||||
[code]body_id[/code] the [RID] of the [PhysicsBody3D] or [MeshLibrary]'s [CollisionObject3D] used by the [PhysicsServer3D].
|
||||
|
||||
Reference in New Issue
Block a user