Skip to content

SystemNodeId, SystemSetNodeId #10765

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.

Sign up for GitHub

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

Jump to bottom
Closed
wants to merge 1 commit into from
Closed

SystemNodeId, SystemSetNodeId #10765

wants to merge 1 commit into from

Conversation

stepancheg
Copy link
Contributor

Add SystemNodeId and SystemSetNodeId types to be used when NodeId is known to be either of them.

This should make code easier to read and slightly safer.

@alice-i-cecile alice-i-cecile added 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 labels Nov 27, 2023
@github-actions GitHub Actions
Copy link
Contributor

It looks like your PR is a breaking change, but you didn't provide a migration guide.

Could you add some context on what users should update when this change get released in a new version of Bevy?
It will be used to help writing the migration guide for the version. Putting it after a ## Migration Guide will help it get automatically picked up by our tooling.

alice-i-cecile
alice-i-cecile reviewed Nov 27, 2023
View reviewed changes
alice-i-cecile
alice-i-cecile reviewed Nov 27, 2023
View reviewed changes
alice-i-cecile
alice-i-cecile reviewed Nov 27, 2023
View reviewed changes
alice-i-cecile
alice-i-cecile requested changes Nov 27, 2023
View reviewed changes
Copy link
Member

@alice-i-cecile alice-i-cecile left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a nice direction: more clearly distinguishing between these uses is valuable! My initial reaction was that it wouldn't be, since it's already wrapped in an enum, but since we're passing these values around directly, I much prefer the more strictly typed approach.

I'd like to have a little bit more documentation, especially on how these are generated and uniqueness is managed, but I'm overall very pleased with the diff.

@hymm hymm self-requested a review November 28, 2023 04:32
@BenjaminBrienen BenjaminBrienen added D-Straightforward Simple bug fixes and API improvements, docs, test and examples S-Waiting-on-Author The author needs to make changes or address concerns before this can be merged labels Jan 23, 2025
@theotherphil
Copy link
Contributor

SystemKey and SystemSetKey added in #19352 play the same role as the SystemNodeId and SystemSetNodeId in this PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@alice-i-cecile alice-i-cecile alice-i-cecile approved these changes

@hymm hymm Awaiting requested review from hymm

Assignees
No one assigned
Labels
A-ECS Entities, components, systems, and events C-Code-Quality A section of code that is hard to understand or change D-Straightforward Simple bug fixes and API improvements, docs, test and examples M-Needs-Migration-Guide A breaking change to Bevy's public API that needs to be noted in a migration guide S-Waiting-on-Author The author needs to make changes or address concerns before this can be merged
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@stepancheg @theotherphil @alice-i-cecile @BenjaminBrienen