Package net.minecraft.world.chunk

Interface Palette<T>

All Known Implementing Classes:
ArrayPalette, BiMapPalette, IdListPalette, SingularPalette
public interface Palette<T>
A palette maps objects from and to small integer IDs that uses less number of bits to make storage smaller.

While the objects palettes handle are already represented by integer IDs, shrinking IDs in cases where only a few appear can further reduce storage space and network traffic volume.

See Also:
Mappings:
Namespace Name
official cxb
intermediary net/minecraft/class_2837
named net/minecraft/world/chunk/Palette

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    Palette.Factory
    An interface for easy creation of palettes.

  • Method Summary

    Modifier and Type
    Method
    Description
    Palette<T>
    copy()
     
    T
    get(int id)
    Returns the object associated with the given id.
    int
    getPacketSize()
    Returns the serialized size of this palette in a byte buf, in bytes.
    int
    getSize()
    Returns the size of the palette.
    boolean
    hasAny(Predicate<T> predicate)
    Returns true if any entry in this palette passes the predicate.
    int
    index(T object)
    Returns the ID of an object in this palette.
    void
    readPacket(PacketByteBuf buf)
    Initializes this palette from the buf.
    void
    writePacket(PacketByteBuf buf)
    Writes this palette to the buf.

  • Method Details

    • index

      int index(T object)
      Returns the ID of an object in this palette.

      If the object does not yet exist in this palette, this palette will register the object. If the palette is too small to include this object, a resize listener will be called and this palette may be discarded.

      Parameters:
      object - the object to look up
      Returns:
      the ID of an object in this palette
      Mappings:
      Namespace Name Mixin selector
      official a Lcxb;a(Ljava/lang/Object;)I
      intermediary method_12291 Lnet/minecraft/class_2837;method_12291(Ljava/lang/Object;)I
      named index Lnet/minecraft/world/chunk/Palette;index(Ljava/lang/Object;)I

    • hasAny

      boolean hasAny(Predicate<T> predicate)
      Returns true if any entry in this palette passes the predicate.
      Returns:
      true if any entry in this palette passes the predicate
      Mappings:
      Namespace Name Mixin selector
      official a Lcxb;a(Ljava/util/function/Predicate;)Z
      intermediary method_19525 Lnet/minecraft/class_2837;method_19525(Ljava/util/function/Predicate;)Z
      named hasAny Lnet/minecraft/world/chunk/Palette;hasAny(Ljava/util/function/Predicate;)Z

    • get

      T get(int id)
      Returns the object associated with the given id.
      Parameters:
      id - the ID to look up
      Returns:
      the object associated with the given id
      Throws:
      EntryMissingException - if this ID does not exist in this palette
      Mappings:
      Namespace Name Mixin selector
      official a Lcxb;a(I)Ljava/lang/Object;
      intermediary method_12288 Lnet/minecraft/class_2837;method_12288(I)Ljava/lang/Object;
      named get Lnet/minecraft/world/chunk/Palette;get(I)Ljava/lang/Object;

    • readPacket

      void readPacket(PacketByteBuf buf)
      Initializes this palette from the buf. Clears the preexisting data in this palette.
      Parameters:
      buf - the packet byte buffer
      Mappings:
      Namespace Name Mixin selector
      official a Lcxb;a(Lqx;)V
      intermediary method_12289 Lnet/minecraft/class_2837;method_12289(Lnet/minecraft/class_2540;)V
      named readPacket Lnet/minecraft/world/chunk/Palette;readPacket(Lnet/minecraft/network/PacketByteBuf;)V

    • writePacket

      void writePacket(PacketByteBuf buf)
      Writes this palette to the buf.
      Parameters:
      buf - the packet byte buffer
      Mappings:
      Namespace Name Mixin selector
      official b Lcxb;b(Lqx;)V
      intermediary method_12287 Lnet/minecraft/class_2837;method_12287(Lnet/minecraft/class_2540;)V
      named writePacket Lnet/minecraft/world/chunk/Palette;writePacket(Lnet/minecraft/network/PacketByteBuf;)V

    • getPacketSize

      int getPacketSize()
      Returns the serialized size of this palette in a byte buf, in bytes.
      Returns:
      the serialized size of this palette in a byte buf, in bytes
      Mappings:
      Namespace Name Mixin selector
      official a Lcxb;a()I
      intermediary method_12290 Lnet/minecraft/class_2837;method_12290()I
      named getPacketSize Lnet/minecraft/world/chunk/Palette;getPacketSize()I

    • getSize

      int getSize()
      Returns the size of the palette.
      Returns:
      the size of the palette
      Mappings:
      Namespace Name Mixin selector
      official b Lcxb;b()I
      intermediary method_12197 Lnet/minecraft/class_2837;method_12197()I
      named getSize Lnet/minecraft/world/chunk/Palette;getSize()I

    • copy

      Palette<T> copy()
      Mappings:
      Namespace Name Mixin selector
      official c Lcxb;c()Lcxb;
      intermediary method_39956 Lnet/minecraft/class_2837;method_39956()Lnet/minecraft/class_2837;
      named copy Lnet/minecraft/world/chunk/Palette;copy()Lnet/minecraft/world/chunk/Palette;