Fix DataPalette index & deprecate unused globalPaletteBits

[davidmayr]

This PR attempts to fix #774

From my basic testing, the block palettes still work as they did before without any issues and biome palettes do not throw any errors anymore. They also seem correct in game, but don't quote me on that. (Since my test world is very small with not that many different biomes (2 to be exact))

[AlexProgrammerDE]

I've found this in vanilla code:

[davidmayr]

I've found this in vanilla code:

That would result in a completly different index then before, right? I don't think that would work correctly unless other parts are rewritten aswell? Or am I wrong here?

[davidmayr]

But I can try if it works in a few hours

[Kas-tle]

These are equivalent as sizeBits is effectively maxBitsPerEntry minus minBitsPerEntry, so the position of the encoded bytes is the same.

For example, a chunk section is CHUNK(4, 8, 4096), meaning a sizeBits of 4. Let's consider the position [5, 7, 9] in the chunk.

With the code in this PR, we would do:

( 7 << 8 ) | ( 9 << 4 ) | ( 5 )
11100000000b | 10010000b | 101b

11100000000
   10010000
        101
-----------
11110010101 = 1941

With the code from the Minecraft jar we would do:

( ( ( 7 << 4 ) | 9 ) << 4 ) | ( 5 )
( ( 1110000b | 1001b ) << 4 ) | ( 101b )

1110000
   1001
-------
1111001

( 1111001b << 4 ) | ( 101b )
11110010000b | 101b

11110010000
        101
-----------
11110010101 = 1941

[Kas-tle]

Also since you're working in this area feel free to remove globalPaletteBits per #676

[davidmayr]

Also since you're working in this area feel free to remove globalPaletteBits per #676

Do you want me to make breaking API changes, or should I keep the existing static createEmpty, createForChunk, createForBiome methods and deprecate them?

[Kas-tle]

Yes it should have a deprecation notice and for now just redirect to the new method

[davidmayr]

Yes it should have a deprecation notice and for now just redirect to the new method

And as for the @AllArgsConstructor ? Should I manually recreate a deprecated constructor with globalPaletteBits to not cause any breaking changes as well?

[Kas-tle]

Correct. Basically the goal is just that we can easily remove it in the next breaking version.

[davidmayr]

Done. Shouldn't involve any breaking changes now

[Kas-tle]

Thank you!