Closed
Description
What problem does this solve or what need does it fill?
Users are commonly confused by this method, and try and fail to use it for synchronization tasks.
What solution would you like?
Make this method pub(crate)
.
What alternative(s) have you considered?
Better document if and when it can be correctly used.
Additional context
Generally the advice when attempting to synchronize the ECS is to insert a secondary identifier as a component, rather than attempting to ensure that Entity
lines up between the instances.
I have not seen any valid external use of this API, but if they exist, we should attempt to create workarounds or focus on the documentation path.