Improve area method descriptions
This commit is contained in:
parent
83eb214bcf
commit
4dd8ab745a
|
@ -16,13 +16,15 @@
|
||||||
<method name="get_overlapping_areas" qualifiers="const">
|
<method name="get_overlapping_areas" qualifiers="const">
|
||||||
<return type="Area2D[]" />
|
<return type="Area2D[]" />
|
||||||
<description>
|
<description>
|
||||||
Returns a list of intersecting [Area2D]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.
|
Returns a list of intersecting [Area2D]s. The overlapping area's [member CollisionObject2D.collision_layer] must be part of this area's [member CollisionObject2D.collision_mask] in order to be detected.
|
||||||
|
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>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="get_overlapping_bodies" qualifiers="const">
|
<method name="get_overlapping_bodies" qualifiers="const">
|
||||||
<return type="Node2D[]" />
|
<return type="Node2D[]" />
|
||||||
<description>
|
<description>
|
||||||
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.
|
Returns a list of intersecting [PhysicsBody2D]s. The overlapping body's [member CollisionObject2D.collision_layer] must be part of this area's [member CollisionObject2D.collision_mask] in order to be detected.
|
||||||
|
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>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="overlaps_area" qualifiers="const">
|
<method name="overlaps_area" qualifiers="const">
|
||||||
|
|
|
@ -14,13 +14,15 @@
|
||||||
<method name="get_overlapping_areas" qualifiers="const">
|
<method name="get_overlapping_areas" qualifiers="const">
|
||||||
<return type="Area3D[]" />
|
<return type="Area3D[]" />
|
||||||
<description>
|
<description>
|
||||||
Returns a list of intersecting [Area3D]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.
|
Returns a list of intersecting [Area3D]s. The overlapping area's [member CollisionObject3D.collision_layer] must be part of this area's [member CollisionObject3D.collision_mask] in order to be detected.
|
||||||
|
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>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="get_overlapping_bodies" qualifiers="const">
|
<method name="get_overlapping_bodies" qualifiers="const">
|
||||||
<return type="Node3D[]" />
|
<return type="Node3D[]" />
|
||||||
<description>
|
<description>
|
||||||
Returns a list of intersecting [PhysicsBody3D]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.
|
Returns a list of intersecting [PhysicsBody3D]s. The overlapping body's [member CollisionObject3D.collision_layer] must be part of this area's [member CollisionObject3D.collision_mask] in order to be detected.
|
||||||
|
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>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="overlaps_area" qualifiers="const">
|
<method name="overlaps_area" qualifiers="const">
|
||||||
|
|
Loading…
Reference in New Issue