Package net.william278.husksync.util

Interface BukkitMapPersister

All Known Implementing Classes:
BukkitHuskSync
public interface BukkitMapPersister

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static class 
    BukkitMapPersister.PersistentMapCanvas
    A MapCanvas implementation used for pre-rendering maps to be converted into MapData
    static class 
    BukkitMapPersister.PersistentMapRenderer
    A MapRenderer that can be used to render persistently serialized MapData to a MapView

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static String
    MAP_DATA_KEY
     
    static String
    MAP_PIXEL_DATA_KEY
     
    static String
    MAP_VIEW_ID_MAPPINGS_KEY
     

  • Method Summary

    Modifier and Type
    Method
    Description
    default Optional<org.bukkit.map.MapView>
    getMapView​(int id)
     
    Map<Integer,​org.bukkit.map.MapView>
    getMapViews()
     
    net.william278.husksync.HuskSync
    getPlugin()
     
    default org.bukkit.inventory.ItemStack[]
    persistLockedMaps​(org.bukkit.inventory.ItemStack[] items, org.bukkit.entity.Player delegateRenderer)
    Persist locked maps in an array of ItemStacks
    default void
    renderMapFromFile​(org.bukkit.map.MapView view)
     
    default void
    saveMapToFile​(net.william278.mapdataapi.MapData data, int id)
     
    default void
    setMapView​(org.bukkit.map.MapView view)
     
    default org.bukkit.inventory.ItemStack[]
    setMapViews​(org.bukkit.inventory.ItemStack[] items)
    Apply persisted locked maps to an array of ItemStacks

  • Field Details

  • Method Details

    • persistLockedMaps

      @NotNull default org.bukkit.inventory.ItemStack[] persistLockedMaps​(@NotNull org.bukkit.inventory.ItemStack[] items, @NotNull org.bukkit.entity.Player delegateRenderer)
      Persist locked maps in an array of ItemStacks
      Parameters:
      items - the array of ItemStacks to persist locked maps in
      delegateRenderer - the player to delegate the rendering of map pixel canvases to
      Returns:
      the array of ItemStacks with locked maps persisted to serialized NBT

    • setMapViews

      @NotNull default org.bukkit.inventory.ItemStack[] setMapViews​(@NotNull org.bukkit.inventory.ItemStack[] items)
      Apply persisted locked maps to an array of ItemStacks
      Parameters:
      items - the array of ItemStacks to apply persisted locked maps to
      Returns:
      the array of ItemStacks with persisted locked maps applied

    • renderMapFromFile

      default void renderMapFromFile​(@NotNull org.bukkit.map.MapView view)

    • saveMapToFile

      default void saveMapToFile​(@NotNull net.william278.mapdataapi.MapData data, int id)

    • getMapView

      default Optional<org.bukkit.map.MapView> getMapView​(int id)

    • setMapView

      default void setMapView​(@NotNull org.bukkit.map.MapView view)

    • getMapViews

      @NotNull Map<Integer,​org.bukkit.map.MapView> getMapViews()

    • getPlugin

      @Internal @NotNull net.william278.husksync.HuskSync getPlugin()