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
@ -14,34 +14,28 @@
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="get_overlapping_areas" qualifiers="const">
|
||||
<return type="Area2D[]">
|
||||
</return>
|
||||
<return type="Area2D[]" />
|
||||
<description>
|
||||
Returns a list of intersecting [Area2D]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="Node2D[]">
|
||||
</return>
|
||||
<return type="Node2D[]" />
|
||||
<description>
|
||||
Returns a list of intersecting [PhysicsBody2D]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 Area2D.
|
||||
[b]Note:[/b] The result of this test is not immediate after moving objects. For performance, the 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 Area2D.
|
||||
[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.
|
||||
@ -91,30 +85,24 @@
|
||||
</members>
|
||||
<signals>
|
||||
<signal name="area_entered">
|
||||
<argument index="0" name="area" type="Area2D">
|
||||
</argument>
|
||||
<argument index="0" name="area" type="Area2D" />
|
||||
<description>
|
||||
Emitted when another Area2D enters this Area2D. Requires [member monitoring] to be set to [code]true[/code].
|
||||
[code]area[/code] the other Area2D.
|
||||
</description>
|
||||
</signal>
|
||||
<signal name="area_exited">
|
||||
<argument index="0" name="area" type="Area2D">
|
||||
</argument>
|
||||
<argument index="0" name="area" type="Area2D" />
|
||||
<description>
|
||||
Emitted when another Area2D exits this Area2D. Requires [member monitoring] to be set to [code]true[/code].
|
||||
[code]area[/code] the other Area2D.
|
||||
</description>
|
||||
</signal>
|
||||
<signal name="area_shape_entered">
|
||||
<argument index="0" name="area_rid" type="RID">
|
||||
</argument>
|
||||
<argument index="1" name="area" type="Area2D">
|
||||
</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="Area2D" />
|
||||
<argument index="2" name="area_shape" type="int" />
|
||||
<argument index="3" name="local_shape" type="int" />
|
||||
<description>
|
||||
Emitted when one of another Area2D's [Shape2D]s enters one of this Area2D's [Shape2D]s. Requires [member monitoring] to be set to [code]true[/code].
|
||||
[code]area_id[/code] the [RID] of the other Area2D's [CollisionObject2D] used by the [PhysicsServer2D].
|
||||
@ -124,14 +112,10 @@
|
||||
</description>
|
||||
</signal>
|
||||
<signal name="area_shape_exited">
|
||||
<argument index="0" name="area_rid" type="RID">
|
||||
</argument>
|
||||
<argument index="1" name="area" type="Area2D">
|
||||
</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="Area2D" />
|
||||
<argument index="2" name="area_shape" type="int" />
|
||||
<argument index="3" name="local_shape" type="int" />
|
||||
<description>
|
||||
Emitted when one of another Area2D's [Shape2D]s exits one of this Area2D's [Shape2D]s. Requires [member monitoring] to be set to [code]true[/code].
|
||||
[code]area_id[/code] the [RID] of the other Area2D's [CollisionObject2D] used by the [PhysicsServer2D].
|
||||
@ -141,30 +125,24 @@
|
||||
</description>
|
||||
</signal>
|
||||
<signal name="body_entered">
|
||||
<argument index="0" name="body" type="Node2D">
|
||||
</argument>
|
||||
<argument index="0" name="body" type="Node2D" />
|
||||
<description>
|
||||
Emitted when a [PhysicsBody2D] or [TileMap] enters this Area2D. Requires [member monitoring] to be set to [code]true[/code]. [TileMap]s are detected if the [TileSet] has Collision [Shape2D]s.
|
||||
[code]body[/code] the [Node], if it exists in the tree, of the other [PhysicsBody2D] or [TileMap].
|
||||
</description>
|
||||
</signal>
|
||||
<signal name="body_exited">
|
||||
<argument index="0" name="body" type="Node2D">
|
||||
</argument>
|
||||
<argument index="0" name="body" type="Node2D" />
|
||||
<description>
|
||||
Emitted when a [PhysicsBody2D] or [TileMap] exits this Area2D. Requires [member monitoring] to be set to [code]true[/code]. [TileMap]s are detected if the [TileSet] has Collision [Shape2D]s.
|
||||
[code]body[/code] the [Node], if it exists in the tree, of the other [PhysicsBody2D] or [TileMap].
|
||||
</description>
|
||||
</signal>
|
||||
<signal name="body_shape_entered">
|
||||
<argument index="0" name="body_rid" type="RID">
|
||||
</argument>
|
||||
<argument index="1" name="body" type="Node2D">
|
||||
</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="Node2D" />
|
||||
<argument index="2" name="body_shape" type="int" />
|
||||
<argument index="3" name="local_shape" type="int" />
|
||||
<description>
|
||||
Emitted when one of a [PhysicsBody2D] or [TileMap]'s [Shape2D]s enters one of this Area2D's [Shape2D]s. Requires [member monitoring] to be set to [code]true[/code]. [TileMap]s are detected if the [TileSet] has Collision [Shape2D]s.
|
||||
[code]body_id[/code] the [RID] of the [PhysicsBody2D] or [TileSet]'s [CollisionObject2D] used by the [PhysicsServer2D].
|
||||
@ -174,14 +152,10 @@
|
||||
</description>
|
||||
</signal>
|
||||
<signal name="body_shape_exited">
|
||||
<argument index="0" name="body_rid" type="RID">
|
||||
</argument>
|
||||
<argument index="1" name="body" type="Node2D">
|
||||
</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="Node2D" />
|
||||
<argument index="2" name="body_shape" type="int" />
|
||||
<argument index="3" name="local_shape" type="int" />
|
||||
<description>
|
||||
Emitted when one of a [PhysicsBody2D] or [TileMap]'s [Shape2D]s exits one of this Area2D's [Shape2D]s. Requires [member monitoring] to be set to [code]true[/code]. [TileMap]s are detected if the [TileSet] has Collision [Shape2D]s.
|
||||
[code]body_id[/code] the [RID] of the [PhysicsBody2D] or [TileSet]'s [CollisionObject2D] used by the [PhysicsServer2D].
|
||||
|
||||
Reference in New Issue
Block a user