Add RelationshipHookMode argument to BundleWriter::write#24406
Open
eugineerd wants to merge 1 commit into
Open
Add RelationshipHookMode argument to BundleWriter::write#24406eugineerd wants to merge 1 commit into
RelationshipHookMode argument to BundleWriter::write#24406eugineerd wants to merge 1 commit into
Conversation
kfc35
approved these changes
May 23, 2026
Contributor
kfc35
left a comment
There was a problem hiding this comment.
Not knowledgable enough to know whether the api change is worth it / if most cases should just use RelationshipHookMode::Run and not think too much about it, but the logic looks good to me
This file contains hidden or 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
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've been using
BundleScratchfor batch writing components when synchronizing entities across worlds, it's been quite nice. However currentlyBundleWriter::writedoesn't allow settingRelationshipHookMode, which makes it less usable for this task since it requires mapping entities when inserting relationships while also preserving ordering inRelationshipTargets (which becomes broken when running with the defaultRelationshipHookMode::Run)Also
BundleWriter::writewas missing#[track_caller].Solution
RelationshipHookModeargument toBundleWriter::writeand set all existing calls to useRelationshipHookMode::Run, which was the default passed by it when inserting components.BundleWriter::writewith#[track_caller]Testing
BundleWriter::writepassed