diff options
| author | Juan Linietsky | 2018-01-11 11:18:40 -0300 |
|---|---|---|
| committer | Juan Linietsky | 2018-01-11 11:19:12 -0300 |
| commit | e633a04c42e9a1332c83840353332af9cfee2a4d (patch) | |
| tree | ec9351dcbf45602bc4080c03fae288f2c39f017d /doc/classes/Area2D.xml | |
| parent | 90de1d236c88a57bc6c8dd705117a41c56d2287a (diff) | |
| download | godot-e633a04c42e9a1332c83840353332af9cfee2a4d.tar.gz godot-e633a04c42e9a1332c83840353332af9cfee2a4d.tar.zst godot-e633a04c42e9a1332c83840353332af9cfee2a4d.zip | |
Update documentation to clarify that list of overlaps is not updated immediately.
Diffstat (limited to 'doc/classes/Area2D.xml')
| -rw-r--r-- | doc/classes/Area2D.xml | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/classes/Area2D.xml b/doc/classes/Area2D.xml index 6a3f0e764..ca395321e 100644 --- a/doc/classes/Area2D.xml +++ b/doc/classes/Area2D.xml @@ -33,14 +33,14 @@ <return type="Array"> </return> <description> - Returns a list of intersecting [code]Area2D[/code]s. + Returns a list of intersecting [code]Area2D[/code]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="Array"> </return> <description> - Returns a list of intersecting [PhysicsBody2D]s. + 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"> @@ -49,7 +49,7 @@ <argument index="0" name="area" type="Node"> </argument> <description> - If [code]true[/code] the given area overlaps the Area2D. + If [code]true[/code] the given area overlaps the Area2D. Note that 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"> @@ -58,7 +58,7 @@ <argument index="0" name="body" type="Node"> </argument> <description> - If [code]true[/code] the given body overlaps the Area2D. + If [code]true[/code] the given body overlaps the Area2D. Note that 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="set_collision_layer_bit"> |