-
-
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
Fix boxed labels #8436
Merged
Merged
Fix boxed labels #8436
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
C-Bug
An unexpected or incorrect behavior
A-ECS
Entities, components, systems, and events
C-Usability
A targeted quality-of-life change that makes Bevy easier to use
labels
Apr 18, 2023
cart
approved these changes
Apr 18, 2023
james7132
reviewed
Apr 18, 2023
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
Apr 19, 2023
Selene-Amanita
added
the
M-Needs-Migration-Guide
A breaking change to Bevy's public API that needs to be noted in a migration guide
label
Jul 10, 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-Bug
An unexpected or incorrect behavior
C-Usability
A targeted quality-of-life change that makes Bevy easier to use
M-Needs-Migration-Guide
A breaking change to Bevy's public API that needs to be noted in a migration guide
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
Label traits such as
ScheduleLabel
currently have a major footgun: the trait is implemented forBox<dyn ScheduleLabel>
, but the implementation does not function as one would expect sinceBox<T>
is considered to be a distinct type fromT
. This is because the behavior of theScheduleLabel
trait is specified mainly through blanket implementations, which preventsBox<dyn ScheduleLabel>
from being properly special-cased.Solution
Replace the blanket-implemented behavior with a series of methods defined on
ScheduleLabel
. This allows us to fully special-caseBox<dyn ScheduleLabel>
.Changelog
Fixed a bug where boxed label types (such as
Box<dyn ScheduleLabel>
) behaved incorrectly when compared with concretely-typed labels.Migration Guide
The
ScheduleLabel
trait has been refactored to no longer depend on the traitsstd::any::Any
,bevy_utils::DynEq
, andbevy_utils::DynHash
. Any manual implementations will need to implement new trait methods in their stead.