-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Use UnsafeWorldCell
to increase code quality for SystemParam
#8174
Merged
alice-i-cecile
merged 6 commits into
bevyengine:main
from
JoJoJet:system-param-unsafe-world-cell
Apr 1, 2023
Merged
Use UnsafeWorldCell
to increase code quality for SystemParam
#8174
alice-i-cecile
merged 6 commits into
bevyengine:main
from
JoJoJet:system-param-unsafe-world-cell
Apr 1, 2023
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
JoJoJet
added
A-ECS
Entities, components, systems, and events
C-Code-Quality
A section of code that is hard to understand or change
labels
Mar 23, 2023
alice-i-cecile
added
M-Needs-Migration-Guide
A breaking change to Bevy's public API that needs to be noted in a migration guide
and removed
M-Needs-Migration-Guide
A breaking change to Bevy's public API that needs to be noted in a migration guide
labels
Mar 23, 2023
Currently at least this appears to be completely non-breaking. |
Any manual implementations of |
alice-i-cecile
added
the
M-Needs-Migration-Guide
A breaking change to Bevy's public API that needs to be noted in a migration guide
label
Mar 23, 2023
jakobhellermann
approved these changes
Apr 1, 2023
alice-i-cecile
approved these changes
Apr 1, 2023
alice-i-cecile
added
the
S-Ready-For-Final-Review
This PR has been approved by the community. It's ready for a maintainer to consider merging it
label
Apr 1, 2023
This was referenced Jun 28, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
A-ECS
Entities, components, systems, and events
C-Code-Quality
A section of code that is hard to understand or change
M-Needs-Migration-Guide
A breaking change to Bevy's public API that needs to be noted in a migration guide
S-Ready-For-Final-Review
This PR has been approved by the community. It's ready for a maintainer to consider merging it
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
The type
&World
is currently in an awkward place, since it has two meanings:This makes
&World
difficult to reason about, and surprising to see in function signatures if one does not know about the interior mutable property.The type
UnsafeWorldCell
was added in #6404, which is meant to alleviate this confusion by adding a dedicated type for interior mutable world access. However, much of the engine still treats&World
as an interior mutable-ish type. One of those places isSystemParam
.Solution
Modify
SystemParam::get_param
to acceptUnsafeWorldCell
instead of&World
. Simplify the safety invariants, since theUnsafeWorldCell
type encapsulates the concept of constrained world access.Changelog
SystemParam::get_param
now accepts anUnsafeWorldCell
instead of&World
. This type provides a high-level API for unsafe interior mutable world access.Migration Guide
For manual implementers of
SystemParam
: the functionget_item
now takesUnsafeWorldCell
instead of&World
. To access world data, use:.get_entity()
, which returns anUnsafeEntityCell
which can be used to access component data.get_resource()
and its variants, to access resource data.