Skip to content

Commit 6758a7f

Browse files
committed
Merge pull request #80875 from Sauermann/fix-picking-doc
Document mouse-picking limit of 64 objects
2 parents b195b0a + 765da0a commit 6758a7f

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

doc/classes/Viewport.xml

+2
Original file line numberDiff line numberDiff line change
@@ -298,10 +298,12 @@
298298
</member>
299299
<member name="physics_object_picking" type="bool" setter="set_physics_object_picking" getter="get_physics_object_picking" default="false">
300300
If [code]true[/code], the objects rendered by viewport become subjects of mouse picking process.
301+
[b]Note:[/b] The number of simultaneously pickable objects is limited to 64 and they are selected in a non-deterministic order, which can be different in each picking process.
301302
</member>
302303
<member name="physics_object_picking_sort" type="bool" setter="set_physics_object_picking_sort" getter="get_physics_object_picking_sort" default="false">
303304
If [code]true[/code], objects receive mouse picking events sorted primarily by their [member CanvasItem.z_index] and secondarily by their position in the scene tree. If [code]false[/code], the order is undetermined.
304305
[b]Note:[/b] This setting is disabled by default because of its potential expensive computational cost.
306+
[b]Note:[/b] Sorting happens after selecting the pickable objects. Because of the limitation of 64 simultaneously pickable objects, it is not guaranteed that the object with the highest [member CanvasItem.z_index] receives the picking event.
305307
</member>
306308
<member name="positional_shadow_atlas_16_bits" type="bool" setter="set_positional_shadow_atlas_16_bits" getter="get_positional_shadow_atlas_16_bits" default="true">
307309
Use 16 bits for the omni/spot shadow depth map. Enabling this results in shadows having less precision and may result in shadow acne, but can lead to performance improvements on some devices.

0 commit comments

Comments
 (0)