Skip warning of missing entity referenced from sort order component #15827
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: michabr <82236305+michabr@users.noreply.github.com>
alexmontAmazon
approved these changes
Apr 27, 2023
forkercat
reviewed
Apr 27, 2023
Comment on lines
132
to
134
| // to be added back to the parent's sort order array | ||
| AZ::JsonEntityIdSerializer::JsonEntityIdMapper** idMapper = | ||
| context.GetMetadata().Find<AZ::JsonEntityIdSerializer::JsonEntityIdMapper*>(); |
dtamkin1
approved these changes
Apr 27, 2023
srikappa-amzn
approved these changes
Apr 28, 2023
Comment on lines
128
to
132
| // So when an entity is added/removed as a prefab override, two separate overrides are | ||
| // generated, one referencing the child and one referencing the parent. | ||
| // Reverting prefab overrides only affects one entity at a time, so reverting overrides on | ||
| // a parent whose child was deleted as an override would cause the deleted child's entityId | ||
| // to be added back to the parent's sort order array |
There was a problem hiding this comment.
nit: Instead of giving a very specific repro case here, it's better to keep it general since the warning was previously being sent anytime it can't resolve an entity id reference.
Something like "Since sort order component on an entity stores a vector of child entity ids in it, it's possible for the component to be left with stale entity ids when updates on child entities don't update the parent entity's sort order component. To reduce the noise in error log, we are allowing the component to have stale entity ids."
Signed-off-by: michabr <82236305+michabr@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Add an option to skip serialization warning when an entity reference does not match any registered entities. Skip these warnings when serializing the sort order component because undoing prefab overrides may leave stale entity Ids in the sort order array.
Fixes #15652
How was this PR tested?
Tested in Editor using repro steps in ticket.