summaryrefslogtreecommitdiff
path: root/doc/classes/Area2D.xml
diff options
context:
space:
mode:
authorRĂ©mi Verschelde <remi@verschelde.fr>2022-08-08 22:50:35 +0200
committerGitHub <noreply@github.com>2022-08-08 22:50:35 +0200
commit682dbe5d00aa7730659771b16704eba83f166a7b (patch)
tree8555e07c3bfb3b2892d530bc93fbf47d14519e35 /doc/classes/Area2D.xml
parentd9d5990c517b63f41881de05cb4644c36e0c77e0 (diff)
parentc5d7115038de5f83cb83e08748615a84fc26bee2 (diff)
Merge pull request #64008 from YuriSizov/doctool-add-param-reference-syntax
Diffstat (limited to 'doc/classes/Area2D.xml')
-rw-r--r--doc/classes/Area2D.xml44
1 files changed, 22 insertions, 22 deletions
diff --git a/doc/classes/Area2D.xml b/doc/classes/Area2D.xml
index 1eb74768f5..034140ff52 100644
--- a/doc/classes/Area2D.xml
+++ b/doc/classes/Area2D.xml
@@ -29,7 +29,7 @@
</method>
<method name="overlaps_area" qualifiers="const">
<return type="bool" />
- <argument index="0" name="area" type="Node" />
+ <param index="0" name="area" type="Node" />
<description>
Returns [code]true[/code] if the given [Area2D] intersects or overlaps this [Area2D], [code]false[/code] otherwise.
[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.
@@ -37,7 +37,7 @@
</method>
<method name="overlaps_body" qualifiers="const">
<return type="bool" />
- <argument index="0" name="body" type="Node" />
+ <param index="0" name="body" type="Node" />
<description>
Returns [code]true[/code] if the given physics body intersects or overlaps this [Area2D], [code]false[/code] otherwise.
[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.
@@ -96,24 +96,24 @@
</members>
<signals>
<signal name="area_entered">
- <argument index="0" name="area" type="Area2D" />
+ <param 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" />
+ <param 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 index="1" name="area" type="Area2D" />
- <argument index="2" name="area_shape_index" type="int" />
- <argument index="3" name="local_shape_index" type="int" />
+ <param index="0" name="area_rid" type="RID" />
+ <param index="1" name="area" type="Area2D" />
+ <param index="2" name="area_shape_index" type="int" />
+ <param index="3" name="local_shape_index" 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_rid[/code] the [RID] of the other Area2D's [CollisionObject2D] used by the [PhysicsServer2D].
@@ -123,10 +123,10 @@
</description>
</signal>
<signal name="area_shape_exited">
- <argument index="0" name="area_rid" type="RID" />
- <argument index="1" name="area" type="Area2D" />
- <argument index="2" name="area_shape_index" type="int" />
- <argument index="3" name="local_shape_index" type="int" />
+ <param index="0" name="area_rid" type="RID" />
+ <param index="1" name="area" type="Area2D" />
+ <param index="2" name="area_shape_index" type="int" />
+ <param index="3" name="local_shape_index" 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_rid[/code] the [RID] of the other Area2D's [CollisionObject2D] used by the [PhysicsServer2D].
@@ -136,24 +136,24 @@
</description>
</signal>
<signal name="body_entered">
- <argument index="0" name="body" type="Node2D" />
+ <param 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" />
+ <param 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 index="1" name="body" type="Node2D" />
- <argument index="2" name="body_shape_index" type="int" />
- <argument index="3" name="local_shape_index" type="int" />
+ <param index="0" name="body_rid" type="RID" />
+ <param index="1" name="body" type="Node2D" />
+ <param index="2" name="body_shape_index" type="int" />
+ <param index="3" name="local_shape_index" 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_rid[/code] the [RID] of the [PhysicsBody2D] or [TileSet]'s [CollisionObject2D] used by the [PhysicsServer2D].
@@ -163,10 +163,10 @@
</description>
</signal>
<signal name="body_shape_exited">
- <argument index="0" name="body_rid" type="RID" />
- <argument index="1" name="body" type="Node2D" />
- <argument index="2" name="body_shape_index" type="int" />
- <argument index="3" name="local_shape_index" type="int" />
+ <param index="0" name="body_rid" type="RID" />
+ <param index="1" name="body" type="Node2D" />
+ <param index="2" name="body_shape_index" type="int" />
+ <param index="3" name="local_shape_index" 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_rid[/code] the [RID] of the [PhysicsBody2D] or [TileSet]'s [CollisionObject2D] used by the [PhysicsServer2D].