godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update documentation to clarify that list of overlaps is not updated immediately.

This commit is contained in:
Juan Linietsky 2018-01-11 11:18:40 -03:00
parent 90de1d236c
commit e633a04c42
4 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/classes/Area.xml
View File

@ -33,14 +33,14 @@
<return type="Array">
</return>
<description>
Returns a list of intersecting [code]Area[/code]s.
Returns a list of intersecting [code]Area[/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 [PhysicsBody]s.
Returns a list of intersecting [PhysicsBody]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 Area.
If [code]true[/code] the given area overlaps the Area. 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 Area.
If [code]true[/code] the given body overlaps the Area. 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">

8
doc/classes/Area2D.xml
View File

@ -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">

2
doc/classes/RigidBody.xml
View File

@ -39,7 +39,7 @@
<return type="Array">
</return>
<description>
Return a list of the bodies colliding with this one. By default, number of max contacts reported is at 0 , see [method set_max_contacts_reported] to increase it.
Return a list of the bodies colliding with this one. By default, number of max contacts reported is at 0 , see [method set_max_contacts_reported] to increase it. Note that the result of this test is not immediate after moving objects. For performance, list of collisions is updated once per frame and before the physics step. Consider using signals instead.
</description>
</method>
<method name="set_axis_velocity">

2
doc/classes/RigidBody2D.xml
View File

@ -67,7 +67,7 @@
<return type="Array">
</return>
<description>
Returns a list of the bodies colliding with this one. Use [member contacts_reported] to set the maximum number reported. You must also set [member contact_monitor] to [code]true[/code].
Returns a list of the bodies colliding with this one. Use [member contacts_reported] to set the maximum number reported. You must also set [member contact_monitor] to [code]true[/code]. Note that the result of this test is not immediate after moving objects. For performance, list of collisions is updated once per frame and before the physics step. Consider using signals instead.
</description>
</method>
<method name="get_inertia" qualifiers="const">