Adding some docs for archetype internals #12578
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
cBournhonesque
added
C-Docs
alice-i-cecile
approved these changes
Mar 19, 2024
mockersf
reviewed
Mar 19, 2024
| pub archetype_id: ArchetypeId, | ||
| /// For each component iterated in the same order as the source [`Bundle`](crate::bundle::Bundle), | ||
| /// indicate if the component is newly added to the target archetype or if it already existed |
There was a problem hiding this comment.
I think that's the status on the entity
There was a problem hiding this comment.
Sorry; of which entity?
From what I understand, the bundle_status is computed just by comparing the components of the bundle with the components of the source archetype; no entities are involved.
(https://github.com/cBournhonesque/bevy/blob/7281b0e06c531cac4b9073cbb119b036a2ddfacb/crates/bevy_ecs/src/bundle.rs#L442)
There was a problem hiding this comment.
Yep @cBournhonesque is right here. The entity's components are based on which archetype it's in, so this comment makes perfect sense.
james7132
approved these changes
Mar 23, 2024
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
I was reading some of the Archetype and Bundle code and was getting confused a little bit in some places (is the
archetype_idinAddBundlethe source or the target archetype id?).Small PR that adds some docstrings to make it easier for first-time readers.