Interface Palette

public sealed interface Palette
Palette is a data storage with three storage models used to store blocks and biomes
Single Value Mode (bitsPerEntry == 0): All blocks have the same value. No arrays allocated, value stored in count field.
Indirect Mode (bitsPerEntry <= maxBitsPerEntry): Uses palette compression. Values array stores palette indices, paletteToValueList and valueToPaletteMap provide bidirectional mapping between indices and block values.
Direct Mode (bitsPerEntry > maxBitsPerEntry): Stores block values directly. No palette structures, values array contains actual block values using directBits.
You can optimize for space/speed using optimize(Optimization)

  • Field Details

  • Method Details

    • blocks

      static Palette blocks(int bitsPerEntry)

    • biomes

      static Palette biomes(int bitsPerEntry)

    • blocks

      static Palette blocks()

    • biomes

      static Palette biomes()

    • empty

      static Palette empty(int dimension, int minBitsPerEntry, int maxBitsPerEntry, int directBits)

    • sized

      static Palette sized(int dimension, int minBitsPerEntry, int maxBitsPerEntry, int directBits, int bitsPerEntry)

    • get

      int get(int x, int y, int z)

    • getAll

      void getAll(Palette.EntryConsumer consumer)

    • getAllPresent

      void getAllPresent(Palette.EntryConsumer consumer)

    • height

      int height(int x, int z, Palette.EntryPredicate predicate)

    • set

      void set(int x, int y, int z, int value)

    • fill

      void fill(int value)

    • load

      void load(int[] palette, long[] values)

    • offset

      void offset(int offset)

    • replace

      void replace(int oldValue, int newValue)

    • setAll

      void setAll(Palette.EntrySupplier supplier)

    • replace

      void replace(int x, int y, int z, IntUnaryOperator operator)

    • replaceAll

      void replaceAll(Palette.EntryFunction function)

    • copyFrom

      void copyFrom(Palette source, int offsetX, int offsetY, int offsetZ)
      Efficiently copies values from another palette with the given offset.

      Both palettes must have the same dimension.

      Parameters:
      source - the source palette to copy from
      offsetX - the X offset to apply when copying
      offsetY - the Y offset to apply when copying
      offsetZ - the Z offset to apply when copying

    • copyFrom

      void copyFrom(Palette source)
      Efficiently copies values from another palette starting at position (0, 0, 0).

      Both palettes must have the same dimension.

      This is a convenience method equivalent to calling copyFrom(source, 0, 0, 0).

      Parameters:
      source - the source palette to copy from

    • count

      int count()
      Returns the number of entries in this palette.

    • count

      int count(int value)
      Returns the number of entries in this palette that match the given value.
      Parameters:
      value - the value to count
      Returns:
      the number of entries matching the value

    • isEmpty

      default boolean isEmpty()

    • any

      boolean any(int value)
      Checks if the palette contains the given value.
      Parameters:
      value - the value to check
      Returns:
      true if the palette contains the value, false otherwise

    • bitsPerEntry

      int bitsPerEntry()
      Returns the number of bits used per entry.

    • dimension

      int dimension()

    • maxSize

      default int maxSize()
      Returns the maximum number of entries in this palette.

    • optimize

      void optimize(Palette.Optimization focus)
      Attempts to optimize the current Palette
      If plausible the only optimization will be performed is converting to a single value regardless of Palette.Optimization
      Parameters:
      focus - the optimization focus

    • compare

      boolean compare(Palette palette)
      Compare palettes content independently of their storage format.
      Parameters:
      palette - the palette to compare with
      Returns:
      true if the palettes are equivalent, false otherwise

    • clone

      Palette clone()

    • paletteIndexToValue

      @Internal int paletteIndexToValue(int value)

    • valueToPaletteIndex

      @Internal int valueToPaletteIndex(int value)

    • singleValue

      @Internal int singleValue()
      Gets the single value of this palette if it is a single value palette, otherwise returns -1.

    • indexedValues

      @Internal long @Nullable [] indexedValues()
      Gets the value array if it has one, otherwise returns null (i.e. single value palette).

    • biomeSerializer

      static NetworkBuffer.Type<Palette> biomeSerializer(int biomeCount)

    • serializer

      static NetworkBuffer.Type<Palette> serializer(int dimension, int minIndirect, int maxIndirect, int directBits)