Improve compatibility with custom NBT #183
Merged
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
Will later be replaced by more robust support for arbitrary non-vanilla NBT tags
Rather than expanding tag preservation, preserve all tags that are not known tags that may not be clobbered by the save process. This has the side benefit of more easily preserving vehicles and the previously-missed shoulder entities. Session timestamp tags still need to be reverted.
Affected only vanilla players who had never logged in on a Craftbukkit-based server
Using a prefix does save a couple lines of text, but also means that non-vanilla tags like "Spawner" etc. would be deleted. Anyone using a namespace prefixed with "Bukkit" should also be using a Bukkit-supported save method, so that should always be safe. Other server implementation tags that I've viewed ("Spigot"- and "Paper"-prefixed) are written every time.
Shoulder entities are actually loaded and kept in memory as a CompoundTag. As they aren't read into the world unless evicted from the shoulder, they should be saved properly, so preserving them would cause entity duplication.
Adds backwards compatibility for deleting migrated active effects tag. In the future, these backwards compatibilities will be maintained only for the current supported versions, i.e. when 1.21 comes out, the 1.19 module will be dropped, and 1.21 will not contain 1.19 backwards compatibility.
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.
Improve compatibility with plugins that add arbitrary NBT. This works by copying the player's old data and writing the current data into it after removing a list of tags that the server is will not clobber if the corresponding internal values are not set. This does make updates marginally more complex, but a good chunk of the save code already needed to be reviewed, so it's not a huge deal.
This will not support ancient data versions - tags are not removed if they no longer exist in a supported version. It is assumed that when you upgrade your server you upgrade your world and players in a reasonable amount of time. In cases where data has not been upgraded in several major versions, it is possible that a very old tag may be preserved and clobber changes made via OI when it is converted into a modern copy.
For example, in 1.20 the tag
ActiveEffectswas replaced byactive_effects. In 1.21, this will become an unsupported tag due to not having been present in the previous version. If a plugin were to load a player in 1.21 whose data had not been upgraded from the 1.19 format, OI would preserve theActiveEffectstag, which would likely clobber any data inactive_effectsnext load. This would result in potion effects appearing to not save.Closes #182