Package com.infernalsuite.asp.api.world

Interface SlimeChunk

public interface SlimeChunk
In-memory representation of a SRF chunk.

  • Method Summary

    Modifier and Type
    Method
    Description
    net.kyori.adventure.nbt.ListBinaryTag
    getBlockTicks()
    Returns all block ticks of the chunk.
    List<net.kyori.adventure.nbt.CompoundBinaryTag>
    getEntities()
    Returns all the entities of the chunk.
    Map<String,net.kyori.adventure.nbt.BinaryTag>
    getExtraData()
    Returns the extra data of the chunk.
    net.kyori.adventure.nbt.ListBinaryTag
    getFluidTicks()
    Returns all fluid ticks of the chunk.
    net.kyori.adventure.nbt.CompoundBinaryTag
    getHeightMaps()
    Returns the height maps of the chunk.
    net.kyori.adventure.nbt.CompoundBinaryTag
    getPoiChunkSections()
    Returns the poi sections of the chunk.
    SlimeChunkSection[]
    getSections()
    Returns all the sections of the chunk.
    List<net.kyori.adventure.nbt.CompoundBinaryTag>
    getTileEntities()
    Returns all the tile entities of the chunk.
    net.kyori.adventure.nbt.CompoundBinaryTag
    getUpgradeData()
    Upgrade data used to fix the chunks.
    int
    getX()
    Returns the X coordinate of the chunk.
    int
    getZ()
    Returns the Z coordinate of the chunk.

  • Method Details

    • getX

      int getX()
      Returns the X coordinate of the chunk.
      Returns:
      X coordinate of the chunk.

    • getZ

      int getZ()
      Returns the Z coordinate of the chunk.
      Returns:
      Z coordinate of the chunk.

    • getSections

      SlimeChunkSection[] getSections()
      Returns all the sections of the chunk.
      Returns:
      A SlimeChunkSection array.

    • getHeightMaps

      @Nullable net.kyori.adventure.nbt.CompoundBinaryTag getHeightMaps()
      Returns the height maps of the chunk.
      Returns:
      A CompoundBinaryTag containing all the height maps of the chunk.

    • getTileEntities

      List<net.kyori.adventure.nbt.CompoundBinaryTag> getTileEntities()
      Returns all the tile entities of the chunk.
      Returns:
      A CompoundBinaryTag containing all the tile entities of the chunk.

    • getEntities

      List<net.kyori.adventure.nbt.CompoundBinaryTag> getEntities()
      Returns all the entities of the chunk.
      Returns:
      A CompoundBinaryTag containing all the entities

    • getExtraData

      Map<String,net.kyori.adventure.nbt.BinaryTag> getExtraData()
      Returns the extra data of the chunk. Any information can be stored in this Map and later retrieved, as it's saved alongside the chunk data.
      Beware, a compound tag under the key "ChunkBukkitValues" will be stored here. It is used for storing chunk-based Bukkit PDC. Do not overwrite it.
      Returns:
      A Map containing the extra data of the chunk as NBT tags,

    • getUpgradeData

      @Nullable net.kyori.adventure.nbt.CompoundBinaryTag getUpgradeData()
      Upgrade data used to fix the chunks. Not intended to be serialized.
      Returns:
      A CompoundBinaryTag containing the upgrade data of the chunk,

    • getBlockTicks

      @Nullable net.kyori.adventure.nbt.ListBinaryTag getBlockTicks()
      Returns all block ticks of the chunk. This data is only saved when SlimeProperties.SAVE_BLOCK_TICKS is true.

      Even if SlimeProperties.SAVE_BLOCK_TICKS is false, this might still return a ListBinaryTag containing the block ticks, if the data was present when the world was read or when the chunk is currently loaded.

      Returns:
      A ListBinaryTag containing all the block ticks of the chunk, if present.
      See Also:

    • getFluidTicks

      @Nullable net.kyori.adventure.nbt.ListBinaryTag getFluidTicks()
      Returns all fluid ticks of the chunk. This data is only saved when SlimeProperties.SAVE_FLUID_TICKS is true.

      Even if SlimeProperties.SAVE_FLUID_TICKS is false, this might still return a ListBinaryTag containing the fluid ticks, if the data was present when the world was read or when the chunk is currently loaded.

      Returns:
      A ListBinaryTag containing all the fluid ticks of the chunk, if present.
      See Also:

    • getPoiChunkSections

      @Nullable net.kyori.adventure.nbt.CompoundBinaryTag getPoiChunkSections()
      Returns the poi sections of the chunk. This data is only saved when SlimeProperties.SAVE_POI is true.

      Even if SlimeProperties.SAVE_POI is false, this might still return a CompoundBinaryTag containing the poi sections, if the data was present when the world was read or when the chunk is currently loaded.

      Returns:
      A CompoundBinaryTag containing the poi chunks of the chunk, if present.
      See Also: