Package net.sandrohc.schematic4j.schematic

Interface Schematic

All Known Implementing Classes:
SchematicSponge
public interface Schematic

  • Method Details

    • getFormat

      SchematicFormat getFormat()

    • getWidth

      int getWidth()
      The width of the schematic.
      Returns:
      the schematic width

    • getHeight

      int getHeight()
      The height of the schematic.
      Returns:
      the schematic height

    • getLength

      int getLength()
      The length of the schematic.
      Returns:
      the schematic length

    • getOffset

      int[] getOffset()
      The relative offset of the schematic.
      Returns:
      the schematic length

    • getBlock

      SchematicBlock getBlock(int x, int y, int z)
      The block at the specified block.

      Depending on the schematic format, each coordinate can also be negative and is relative to the schematic origin.

      Parameters:
      x - The X coordinate, can be a negative value
      y - The X coordinate, can be a negative value
      z - The X coordinate, can be a negative value
      Returns:
      block, or null if information is not available.

    • getBlocks

      BlockIterator getBlocks()
      Iterator for iterating over the list of blocks.
      Returns:
      an iterator

    • getBlockEntities

      Collection<SchematicBlockEntity> getBlockEntities()
      The list of tile/block entities.
      Returns:
      list of block entities

    • getEntities

      Collection<SchematicEntity> getEntities()
      The list of entities.
      Returns:
      list of entities

    • getBiome

      SchematicBiome getBiome(int x, int z)
      The biome at the specified block.
      Parameters:
      x - the X coordinate
      z - the Z coordinate
      Returns:
      biome, or null if information is not available.

    • getBiomes

      BiomeIterator getBiomes()
      Iterator for iterating over the list of biomes.
      Returns:
      an iterator

    • getName

      String getName()
      The name of the schematic.
      Returns:
      schematic name, or null if information is not available.

    • getAuthor

      String getAuthor()
      The name of the author of the schematic.
      Returns:
      author, or null if information is not available.

    • date

      LocalDateTime date()
      The date that this schematic was created on.
      Returns:
      creation date, or null if information is not available.