浏览代码

Clarify Area2D/Area3D `overlaps_area()`/`overlaps_body()` documentation

Hugo Locurcio 3 年之前
父节点
当前提交
2ea08134c3
共有 2 个文件被更改,包括 6 次插入6 次删除
  1. 3 3
      doc/classes/Area2D.xml
  2. 3 3
      doc/classes/Area3D.xml

+ 3 - 3
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>

+ 3 - 3
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>