Package com.github.shynixn.structureblocklib.api.block

Interface StructureBlockConstructionAbstract<L>

All Superinterfaces:
StructureBlockAbstract, StructureBlockCornerAbstract
All Known Subinterfaces:
StructureBlockLoadAbstract<L,V,B,E,W>, StructureBlockSaveAbstract<L,V>
public interface StructureBlockConstructionAbstract<L> extends StructureBlockCornerAbstract

  • Method Summary

    Modifier and Type
    Method
    Description
    @Nullable String
    getAuthor()
    Returns the author of the structure.
    int
    getSizeX()
    Returns the size of the structure in X direction.
    int
    getSizeY()
    Returns the size of the structure in Y direction.
    int
    getSizeZ()
    Returns the size of the structure in Z direction.
    L
    getStructureLocation()
    Returns the location of the structure.
    boolean
    isIncludeEntitiesEnabled()
    Should entities which may or may not be included in the saved file be included in the loaded/saved structure.
    void
    setAuthor(@Nullable String author)
    Sets the author of the structure.
    void
    setIncludeEntities(boolean flag)
    Should entities which may or may not be included in the saved file be included in the loaded/saved structure.
    void
    setSizeX(int sizeX)
    Changes the size of the structure in X direction.
    void
    setSizeY(int sizeY)
    Changes the size of the structure in Y direction.
    void
    setSizeZ(int sizeZ)
    Changes the size of the structure in Z direction.
    void
    setStructureLocation(L location)
    Changes the location of the structure.

    Methods inherited from interface com.github.shynixn.structureblocklib.api.block.StructureBlockAbstract

    getStructureMode, setStructureMode

    Methods inherited from interface com.github.shynixn.structureblocklib.api.block.StructureBlockCornerAbstract

    getSaveName, setSaveName

  • Method Details

    • setAuthor

      void setAuthor(@Nullable @Nullable String author)
      Sets the author of the structure.
      Parameters:
      author - author.

    • getAuthor

      @Nullable @Nullable String getAuthor()
      Returns the author of the structure.
      Returns:
      author.

    • setStructureLocation

      void setStructureLocation(@Nullable L location)
      Changes the location of the structure.
      Parameters:
      location - location.

    • getStructureLocation

      @Nullable L getStructureLocation()
      Returns the location of the structure.
      Returns:
      location.

    • setIncludeEntities

      void setIncludeEntities(boolean flag)
      Should entities which may or may not be included in the saved file be included in the loaded/saved structure. Default false.
      Parameters:
      flag - flag.

    • isIncludeEntitiesEnabled

      boolean isIncludeEntitiesEnabled()
      Should entities which may or may not be included in the saved file be included in the loaded/saved structure. Default false.
      Returns:
      false.

    • setSizeX

      void setSizeX(int sizeX)
      Changes the size of the structure in X direction.
      Parameters:
      sizeX - sizeX.

    • setSizeY

      void setSizeY(int sizeY)
      Changes the size of the structure in Y direction.
      Parameters:
      sizeY - sizeY.

    • setSizeZ

      void setSizeZ(int sizeZ)
      Changes the size of the structure in Z direction.
      Parameters:
      sizeZ - sizeZ.

    • getSizeX

      int getSizeX()
      Returns the size of the structure in X direction.
      Returns:
      xSize.

    • getSizeY

      int getSizeY()
      Returns the size of the structure in Y direction.
      Returns:
      ySize.

    • getSizeZ

      int getSizeZ()
      Returns the size of the structure in Z direction.
      Returns:
      zSize.