diff options
| author | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2022-02-01 22:19:58 +0100 |
|---|---|---|
| committer | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2022-02-01 22:20:29 +0100 |
| commit | 2ea08134c3e3f73e506442fc0ac3897f5943c909 (patch) | |
| tree | 92d435657d0d10496e55e917301df2f12cd2cd5a /doc | |
| parent | ea12094f19b028c1dcf6d402b8cbb3296b2065a8 (diff) | |
Clarify Area2D/Area3D `overlaps_area()`/`overlaps_body()` documentation
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/Area2D.xml | 6 | ||||
| -rw-r--r-- | doc/classes/Area3D.xml | 6 |
2 files changed, 6 insertions, 6 deletions
diff --git a/doc/classes/Area2D.xml b/doc/classes/Area2D.xml index 0f7e6799be..5280b7445d 100644 --- a/doc/classes/Area2D.xml +++ b/doc/classes/Area2D.xml @@ -31,7 +31,7 @@ <return type="bool" /> <argument index="0" name="area" type="Node" /> <description> - If [code]true[/code], the given area overlaps the Area2D. + 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. </description> </method> @@ -39,9 +39,9 @@ <return type="bool" /> <argument index="0" name="body" type="Node" /> <description> - If [code]true[/code], the given physics body overlaps the Area2D. + 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. - The [code]body[/code] argument can either be a [PhysicsBody2D] or a [TileMap] instance (while TileMaps are not physics bodies themselves, they register their tiles with collision shapes as a virtual physics body). + The [code]body[/code] argument can either be a [PhysicsBody2D] or a [TileMap] instance. While TileMaps are not physics bodies themselves, they register their tiles with collision shapes as a virtual physics body. </description> </method> </methods> diff --git a/doc/classes/Area3D.xml b/doc/classes/Area3D.xml index 450ed44307..4f456cb56d 100644 --- a/doc/classes/Area3D.xml +++ b/doc/classes/Area3D.xml @@ -29,7 +29,7 @@ <return type="bool" /> <argument index="0" name="area" type="Node" /> <description> - If [code]true[/code], the given area overlaps the Area3D. + Returns [code]true[/code] if the given [Area3D] intersects or overlaps this [Area3D], [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. </description> </method> @@ -37,9 +37,9 @@ <return type="bool" /> <argument index="0" name="body" type="Node" /> <description> - If [code]true[/code], the given physics body overlaps the Area3D. + Returns [code]true[/code] if the given physics body intersects or overlaps this [Area3D], [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. - The [code]body[/code] argument can either be a [PhysicsBody3D] or a [GridMap] instance (while GridMaps are not physics body themselves, they register their tiles with collision shapes as a virtual physics body). + The [code]body[/code] argument can either be a [PhysicsBody3D] or a [GridMap] instance. While GridMaps are not physics body themselves, they register their tiles with collision shapes as a virtual physics body. </description> </method> </methods> |