Update sounds.json data generation to match vanilla #5030
Merged
+384
−30
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
Extend the sound type builder with the missing replace value that is accepted by the vanilla SoundEventRegistrationSerializer.
Add API note to clarify the existence of the category field.
Add codec validation to the sound class record. Add additional documentation comments making the goal of data generation explicit.
Remove the category field of the sound event registration class to be added in data generation, as it is not interpreted by vanilla in the sounds file.
Update codec to match validation with entry builder. Add test class for sound type builder to ensure sound types are build correctly. Add test class for sound type codec to ensure sound types generate and are interpreted to sound event registration classes as expected.
Clarify deprecated behavior of category method.
Update param doc to conform to yarn conventions
Remove see tag that might be more distracting than helpful
Remove unused imports. Remove space indentation.
Apply Spotless to add licenses.
Fix package name of sounds test. Replace hard coded value checks with the already existing default variables.
Add default implementation to deprecated method, so implementation does not need to use it anymore.
pistonpoek
changed the title
modmuss50
approved these changes
Dec 7, 2025
Member
modmuss50
left a comment
modmuss50
left a comment
There was a problem hiding this comment.
This looks great, the tests are really good to have.
| * @deprecated Category is not a field interpreted by vanilla in the sounds file, | ||
| * calling this method will have no effect. | ||
| */ | ||
| @Deprecated |
Member
There was a problem hiding this comment.
Maybe use @Deprecated(forRemoval = true) if we know its tottaly broken?
Contributor
Author
There was a problem hiding this comment.
Yeah, seems sensible to eventually want to get rid of it. I will add a commit for it.
modmuss50
added
bug
Add for removal to category property method.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Updates the SoundTypeBuilderImpl to create a codec that is fully interpreted by the vanilla SoundEventRegistrationSerialization, as this is what the soundType tries to provide. The links between the implementation records and their vanilla classes are being made explicit with additional documentation.
For the public API this means that a replace options has been added and the category method of the soundTypeBuilder has been made deprecated, as it wasn't processed by vanilla and thus provides no functionality.
News tests are also added. The class SoundTypeBuilderTest tests if the SoundTypeBuilder actually provides the expected SoundType. The class SoundTypeCodecTest tests if the implementation codec generates json that is interpreted to the expected vanilla objects.
Small additional tweaks that have been made are using the existing default variables in matching places and additional validation in the Entry codec to match what is being checked at the builder.