Open
Conversation
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.
What
FluidIngredient::equals was broken in a way that doesn't usually show because FluidIngredient.values is usually size 1. (The nested loop should be a zip loop)
Additionally, VALUE_COMPARATOR was broken (no meaningful comparison values)
Implementation Details
Sorting is fixed by first sorting by Type (TagValue, FluidValue, other Value), and then inside those groups sort by tag or key.
For other Values, we can't meaningfully sort because Value doesn't implement Comparable. I considered having Value implement Comparable but it would change the public API and might break existing code so I decided not to.
As a consequence, in a very specific case, the
equalsbehavior is too lenient. If you have two FluidIngredients that:Then the code will consider those alternative Values to be always equal even if they are not, because I can't guarantee that these alternative Values are Comparable so I can't compare them.
Outcome
Fix latent bugs in cases where a FluidIngredient consists of multiple ingredients or tags
How Was This Tested
Game compiles and runs
Potential Compatibility Issues
Specifically avoided API changes