Package net.minestom.server.item.metadata

Class MapMeta

java.lang.Object
net.minestom.server.item.metadata.MapMeta
All Implemented Interfaces:
ItemMeta
public class MapMeta
extends java.lang.Object
implements ItemMeta

  • Nested Class Summary

    Nested Classes 
    Modifier and Type Class Description
    static class  MapMeta.MapDecoration  

  • Constructor Summary

    Constructors 
    Constructor Description
    MapMeta()  
    MapMeta​(int id)  

  • Method Summary

    Modifier and Type Method Description
    ItemMeta copy()
    Copies this item meta.
    java.util.List<MapMeta.MapDecoration> getDecorations()
    Gets the map decorations.
    ChatColor getMapColor()
    Gets the map color.
    int getMapId()
    Gets the map id.
    int getMapScaleDirection()
    Gets the map scale direction.
    boolean hasNbt()
    Gets if this meta object contains any useful data to send to the client.
    boolean isSimilar​(ItemMeta itemMeta)
    Gets if the two ItemMeta are similar.
    void read​(org.jglrxavpok.hephaistos.nbt.NBTCompound compound)
    Reads nbt data from a compound.
    void setDecorations​(java.util.List<MapMeta.MapDecoration> decorations)
    Changes the map decorations list.
    void setMapColor​(ChatColor mapColor)
    Changes the map color.
    void setMapId​(int mapId)
    Changes the map id.
    void setMapScaleDirection​(int mapScaleDirection)
    Changes the map scale direction.
    void write​(org.jglrxavpok.hephaistos.nbt.NBTCompound compound)
    Writes nbt data to a compound.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

  • Method Details

    • getMapId

      public int getMapId()
      Gets the map id.
      Returns:
      the map id

    • setMapId

      public void setMapId​(int mapId)
      Changes the map id.
      Parameters:
      mapId - the new map id

    • getMapScaleDirection

      public int getMapScaleDirection()
      Gets the map scale direction.
      Returns:
      the map scale direction

    • setMapScaleDirection

      public void setMapScaleDirection​(int mapScaleDirection)
      Changes the map scale direction.
      Parameters:
      mapScaleDirection - the new map scale direction

    • getDecorations

      public java.util.List<MapMeta.MapDecoration> getDecorations()
      Gets the map decorations.
      Returns:
      a modifiable list containing all the map decorations

    • setDecorations

      public void setDecorations​(java.util.List<MapMeta.MapDecoration> decorations)
      Changes the map decorations list.
      Parameters:
      decorations - the new map decorations list

    • getMapColor

      public ChatColor getMapColor()
      Gets the map color.
      Returns:
      the map color

    • setMapColor

      public void setMapColor​(ChatColor mapColor)
      Changes the map color.

      WARNING: RGB colors are not supported.

      Parameters:
      mapColor - the new map color

    • hasNbt

      public boolean hasNbt()
      Description copied from interface: ItemMeta
      Gets if this meta object contains any useful data to send to the client.
      Specified by:
      hasNbt in interface ItemMeta
      Returns:
      true if this item has nbt data, false otherwise

    • isSimilar

      public boolean isSimilar​(@NotNull ItemMeta itemMeta)
      Description copied from interface: ItemMeta
      Gets if the two ItemMeta are similar.

      It is used by ItemStack.isSimilar(ItemStack).

      Specified by:
      isSimilar in interface ItemMeta
      Parameters:
      itemMeta - the second item meta to check
      Returns:
      true if the two meta are similar, false otherwise

    • read

      public void read​(@NotNull org.jglrxavpok.hephaistos.nbt.NBTCompound compound)
      Description copied from interface: ItemMeta
      Reads nbt data from a compound.

      WARNING: it is possible that it contains no useful data, it has to be checked before getting anything.

      Specified by:
      read in interface ItemMeta
      Parameters:
      compound - the compound containing the data

    • write

      public void write​(@NotNull org.jglrxavpok.hephaistos.nbt.NBTCompound compound)
      Description copied from interface: ItemMeta
      Writes nbt data to a compound.
      Specified by:
      write in interface ItemMeta
      Parameters:
      compound - the compound receiving the item meta data

    • copy

      @NotNull public ItemMeta copy()
      Description copied from interface: ItemMeta
      Copies this item meta.

      Used by ItemStack.copy().

      Specified by:
      copy in interface ItemMeta
      Returns:
      the cloned item meta