Bugfix: Scene reload fix (nonbreaking) #7951
Merged
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
Shatur
approved these changes
Mar 7, 2023
Shatur
reviewed
Mar 7, 2023
| .get::<Parent>() | ||
| .unwrap() | ||
| .get(), | ||
| "Something about reloading the scene is touching entities with the same scene Ids" |
There was a problem hiding this comment.
One minor nitpick. Usually assert* and except messages in Rust starts with non-capital letters. See: https://doc.rust-lang.org/std/error/index.html#common-message-styles
There was a problem hiding this comment.
Thanks for this! Useful knowledge =] Fixed it
alice-i-cecile
added
A-Assets
Shatur
reviewed
Mar 7, 2023
nicopap
approved these changes
Mar 7, 2023
MrGVSV
approved these changes
Mar 21, 2023
When a scene was reloaded, it was corrupting components that weren't native to the scene itself. In particular, when a DynamicScene was created and Parent components added to entities without parents so that they were children of the entity that spawne them, if that scene was reloaded and the ID of the DyanmicSceneSpawner entity was in the scene, that parent component was corrupted, causing the hierarchy to become malformed and bevy to panic.
Testare
force-pushed
the
scene_reload_fix_nonbreaking
branch
from
c007d6e
to
2a1043d
Compare
cart
approved these changes
Mar 27, 2023
mockersf
pushed a commit
that referenced
this pull request
Mar 27, 2023
Fix a bug with scene reload. (This is a copy of #7570 but without the breaking API change, in order to allow the bugfix to be introduced in 0.10.1) When a scene was reloaded, it was corrupting components that weren't native to the scene itself. In particular, when a DynamicScene was created on Entity (A), all components in the scene without parents are automatically added as children of Entity (A). But if that scene was reloaded and the same ID of Entity (A) was a scene ID as well*, that parent component was corrupted, causing the hierarchy to become malformed and bevy to panic. *For example, if Entity (A)'s ID was 3, and the scene contained an entity with ID 3 This issue could affect any components that: * Implemented `MapEntities`, basically components that contained references to other entities * Were added to entities from a scene file but weren't defined in the scene file - Fixes #7529 The solution was to keep track of entities+components that had `MapEntities` functionality during scene load, and only apply the entity update behavior to them. They were tracked with a HashMap from the component's TypeID to a vector of entity ID's. Then the `ReflectMapEntities` struct was updated to hold a function that took a list of entities to be applied to, instead of naively applying itself to all values in the EntityMap. (See this PR comment #7570 (comment) for a story-based explanation of this bug and solution) - Components that implement `MapEntities` added to scene entities after load are not corrupted during scene reload.
UkoeHB
pushed a commit
to UkoeHB/bevy
that referenced
this pull request
Sep 10, 2023
Fix a bug with scene reload. (This is a copy of bevyengine#7570 but without the breaking API change, in order to allow the bugfix to be introduced in 0.10.1) When a scene was reloaded, it was corrupting components that weren't native to the scene itself. In particular, when a DynamicScene was created on Entity (A), all components in the scene without parents are automatically added as children of Entity (A). But if that scene was reloaded and the same ID of Entity (A) was a scene ID as well*, that parent component was corrupted, causing the hierarchy to become malformed and bevy to panic. *For example, if Entity (A)'s ID was 3, and the scene contained an entity with ID 3 This issue could affect any components that: * Implemented `MapEntities`, basically components that contained references to other entities * Were added to entities from a scene file but weren't defined in the scene file - Fixes bevyengine#7529 The solution was to keep track of entities+components that had `MapEntities` functionality during scene load, and only apply the entity update behavior to them. They were tracked with a HashMap from the component's TypeID to a vector of entity ID's. Then the `ReflectMapEntities` struct was updated to hold a function that took a list of entities to be applied to, instead of naively applying itself to all values in the EntityMap. (See this PR comment bevyengine#7570 (comment) for a story-based explanation of this bug and solution) - Components that implement `MapEntities` added to scene entities after load are not corrupted during scene reload.
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.
Objective
Fix a bug with scene reload.
(This is a copy of #7570 but without the breaking API change, in order to allow the bugfix to be introduced in 0.10.1)
When a scene was reloaded, it was corrupting components that weren't native to the scene itself. In particular, when a DynamicScene was created on Entity (A), all components in the scene without parents are automatically added as children of Entity (A). But if that scene was reloaded and the same ID of Entity (A) was a scene ID as well*, that parent component was corrupted, causing the hierarchy to become malformed and bevy to panic.
*For example, if Entity (A)'s ID was 3, and the scene contained an entity with ID 3
This issue could affect any components that:
MapEntities, basically components that contained references to other entitiesSolution
The solution was to keep track of entities+components that had
MapEntitiesfunctionality during scene load, and only apply the entity update behavior to them. They were tracked with a HashMap from the component's TypeID to a vector of entity ID's. Then theReflectMapEntitiesstruct was updated to hold a function that took a list of entities to be applied to, instead of naively applying itself to all values in the EntityMap.(See this PR comment #7570 (comment) for a story-based explanation of this bug and solution)
Changelog
Fixed
MapEntitiesadded to scene entities after load are not corrupted during scene reload.