Package com.github.shynixn.structureblocklib.core.block

Class StructureBlockAbstractImpl<L,V>

java.lang.Object
com.github.shynixn.structureblocklib.core.block.StructureBlockAbstractImpl<L,V>
All Implemented Interfaces:
com.github.shynixn.structureblocklib.api.block.StructureBlockAbstract, com.github.shynixn.structureblocklib.api.block.StructureBlockConstructionAbstract<L>, com.github.shynixn.structureblocklib.api.block.StructureBlockCornerAbstract, com.github.shynixn.structureblocklib.api.block.StructureBlockDataAbstract, com.github.shynixn.structureblocklib.api.block.StructureBlockLoadAbstract<L,V>, com.github.shynixn.structureblocklib.api.block.StructureBlockSaveAbstract<L,V>
public class StructureBlockAbstractImpl<L,V> extends Object implements com.github.shynixn.structureblocklib.api.block.StructureBlockDataAbstract, com.github.shynixn.structureblocklib.api.block.StructureBlockSaveAbstract<L,V>, com.github.shynixn.structureblocklib.api.block.StructureBlockLoadAbstract<L,V>

  • Constructor Summary

    Constructors
    Constructor
    Description
    StructureBlockAbstractImpl(com.github.shynixn.structureblocklib.api.service.ProxyService proxyService, com.github.shynixn.structureblocklib.api.entity.StructureLoaderAbstract<L,V> loader, com.github.shynixn.structureblocklib.api.entity.StructureSaverAbstract<L,V> saver)
    Creates a new instance with dependencies.

  • Method Summary

    Modifier and Type
    Method
    Description
    @Nullable String
    getAuthor()
    Returns the author of the structure.
    @Nullable String
    getBlockNameMetaData()
    Returns the custom meta data.
    float
    getIntegrity()
    Returns the integrity of the structure.
    @NotNull com.github.shynixn.structureblocklib.api.enumeration.StructureMirror
    getMirrorType()
    Returns the mirrorType of the structure when getting load.
    @NotNull com.github.shynixn.structureblocklib.api.enumeration.StructureRotation
    getRotationType()
    Returns the rotation of the structure when getting load.
    @Nullable String
    getSaveName()
    Returns the name of the save.
    long
    getSeed()
    Returns the seed 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.
    @NotNull com.github.shynixn.structureblocklib.api.enumeration.StructureMode
    getStructureMode()
    Returns the type of the structureBlock.
    boolean
    isBoundingBoxVisible()
    Returns if the boundingBox is visible.
    boolean
    isIncludeEntitiesEnabled()
    Should entities which may or may not be included in the saved file be included in the loaded/saved structure.
    boolean
    isInvisibleBlocksEnabled()
    Returns if invisibleBlocks are visible.
    @NotNull com.github.shynixn.structureblocklib.api.entity.StructureLoaderAbstract<L,V>
    loadStructure()
    Gets the associated StructureLoaderAbstract instance which contains the current block properties.
    @NotNull com.github.shynixn.structureblocklib.api.entity.StructureSaverAbstract<L,V>
    saveStructure()
    Gets the associated StructureSaverAbstract instance which contains the current block properties.
    void
    setAuthor(@Nullable String author)
    Sets the author of the structure.
    void
    setBlockNameMetaData(@Nullable String blockNameMetaData)
    Sets custom meta data.
    void
    setBoundingBoxVisible(boolean visible)
    Sets the boundingBoxVisibility.
    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
    setIntegrity(float integrity)
    Sets the integrity of the structure.
    void
    setInvisibleBlocksEnabled(boolean flag)
    Sets if invisibleBlocks should be visible.
    void
    setMirrorType(@NotNull com.github.shynixn.structureblocklib.api.enumeration.StructureMirror mirrorType)
    Sets the mirrorType of the structure when getting load.
    void
    setRotationType(@NotNull com.github.shynixn.structureblocklib.api.enumeration.StructureRotation rotation)
    Sets the rotation of the structure when getting load.
    void
    setSaveName(@Nullable String name)
    Sets the name of the save.
    void
    setSeed(long seed)
    Sets the seed of the 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.
    void
    setStructureMode(@NotNull com.github.shynixn.structureblocklib.api.enumeration.StructureMode structureMode)
    Changes the type of the structureBlock.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • StructureBlockAbstractImpl

      public StructureBlockAbstractImpl(com.github.shynixn.structureblocklib.api.service.ProxyService proxyService, com.github.shynixn.structureblocklib.api.entity.StructureLoaderAbstract<L,V> loader, com.github.shynixn.structureblocklib.api.entity.StructureSaverAbstract<L,V> saver)
      Creates a new instance with dependencies.

  • Method Details

    • setStructureMode

      public void setStructureMode(@NotNull @NotNull com.github.shynixn.structureblocklib.api.enumeration.StructureMode structureMode)
      Changes the type of the structureBlock.
      Specified by:
      setStructureMode in interface com.github.shynixn.structureblocklib.api.block.StructureBlockAbstract
      Parameters:
      structureMode - structureMode.

    • getStructureMode

      @NotNull public @NotNull com.github.shynixn.structureblocklib.api.enumeration.StructureMode getStructureMode()
      Returns the type of the structureBlock.
      Specified by:
      getStructureMode in interface com.github.shynixn.structureblocklib.api.block.StructureBlockAbstract
      Returns:
      structureMode.

    • setMirrorType

      public void setMirrorType(@NotNull @NotNull com.github.shynixn.structureblocklib.api.enumeration.StructureMirror mirrorType)
      Sets the mirrorType of the structure when getting load.
      Specified by:
      setMirrorType in interface com.github.shynixn.structureblocklib.api.block.StructureBlockLoadAbstract<L,V>
      Parameters:
      mirrorType - mirrorType.

    • setRotationType

      public void setRotationType(@NotNull @NotNull com.github.shynixn.structureblocklib.api.enumeration.StructureRotation rotation)
      Sets the rotation of the structure when getting load.
      Specified by:
      setRotationType in interface com.github.shynixn.structureblocklib.api.block.StructureBlockLoadAbstract<L,V>
      Parameters:
      rotation - rotation.

    • getRotationType

      @NotNull public @NotNull com.github.shynixn.structureblocklib.api.enumeration.StructureRotation getRotationType()
      Returns the rotation of the structure when getting load.
      Specified by:
      getRotationType in interface com.github.shynixn.structureblocklib.api.block.StructureBlockLoadAbstract<L,V>
      Returns:
      rotation.

    • getMirrorType

      @NotNull public @NotNull com.github.shynixn.structureblocklib.api.enumeration.StructureMirror getMirrorType()
      Returns the mirrorType of the structure when getting load.
      Specified by:
      getMirrorType in interface com.github.shynixn.structureblocklib.api.block.StructureBlockLoadAbstract<L,V>
      Returns:
      mirrorType.

    • setBoundingBoxVisible

      public void setBoundingBoxVisible(boolean visible)
      Sets the boundingBoxVisibility.
      Specified by:
      setBoundingBoxVisible in interface com.github.shynixn.structureblocklib.api.block.StructureBlockLoadAbstract<L,V>
      Parameters:
      visible - visible.

    • isBoundingBoxVisible

      public boolean isBoundingBoxVisible()
      Returns if the boundingBox is visible.
      Specified by:
      isBoundingBoxVisible in interface com.github.shynixn.structureblocklib.api.block.StructureBlockLoadAbstract<L,V>
      Returns:
      visible.

    • setIntegrity

      public void setIntegrity(float integrity)
      Sets the integrity of the structure.
      Specified by:
      setIntegrity in interface com.github.shynixn.structureblocklib.api.block.StructureBlockLoadAbstract<L,V>
      Parameters:
      integrity - integrity.

    • getIntegrity

      public float getIntegrity()
      Returns the integrity of the structure.
      Specified by:
      getIntegrity in interface com.github.shynixn.structureblocklib.api.block.StructureBlockLoadAbstract<L,V>
      Returns:
      integrity.

    • setSeed

      public void setSeed(long seed)
      Sets the seed of the structure.
      Specified by:
      setSeed in interface com.github.shynixn.structureblocklib.api.block.StructureBlockLoadAbstract<L,V>
      Parameters:
      seed - seed.

    • getSeed

      public long getSeed()
      Returns the seed of the structure.
      Specified by:
      getSeed in interface com.github.shynixn.structureblocklib.api.block.StructureBlockLoadAbstract<L,V>
      Returns:
      seed.

    • setAuthor

      public void setAuthor(@Nullable @Nullable String author)
      Sets the author of the structure.
      Specified by:
      setAuthor in interface com.github.shynixn.structureblocklib.api.block.StructureBlockConstructionAbstract<L>
      Parameters:
      author - author.

    • getAuthor

      @Nullable public @Nullable String getAuthor()
      Returns the author of the structure.
      Specified by:
      getAuthor in interface com.github.shynixn.structureblocklib.api.block.StructureBlockConstructionAbstract<L>
      Returns:
      author.

    • setStructureLocation

      public void setStructureLocation(@Nullable L location)
      Changes the location of the structure.
      Specified by:
      setStructureLocation in interface com.github.shynixn.structureblocklib.api.block.StructureBlockConstructionAbstract<L>
      Parameters:
      location - location.

    • getStructureLocation

      @Nullable public L getStructureLocation()
      Returns the location of the structure.
      Specified by:
      getStructureLocation in interface com.github.shynixn.structureblocklib.api.block.StructureBlockConstructionAbstract<L>
      Returns:
      location.

    • setIncludeEntities

      public 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.
      Specified by:
      setIncludeEntities in interface com.github.shynixn.structureblocklib.api.block.StructureBlockConstructionAbstract<L>
      Parameters:
      flag - flag.

    • isIncludeEntitiesEnabled

      public boolean isIncludeEntitiesEnabled()
      Should entities which may or may not be included in the saved file be included in the loaded/saved structure. Default false.
      Specified by:
      isIncludeEntitiesEnabled in interface com.github.shynixn.structureblocklib.api.block.StructureBlockConstructionAbstract<L>
      Returns:
      false.

    • setSizeX

      public void setSizeX(int sizeX)
      Changes the size of the structure in X direction.
      Specified by:
      setSizeX in interface com.github.shynixn.structureblocklib.api.block.StructureBlockConstructionAbstract<L>
      Parameters:
      sizeX - sizeX.

    • setSizeY

      public void setSizeY(int sizeY)
      Changes the size of the structure in Y direction.
      Specified by:
      setSizeY in interface com.github.shynixn.structureblocklib.api.block.StructureBlockConstructionAbstract<L>
      Parameters:
      sizeY - sizeY.

    • setSizeZ

      public void setSizeZ(int sizeZ)
      Changes the size of the structure in Z direction.
      Specified by:
      setSizeZ in interface com.github.shynixn.structureblocklib.api.block.StructureBlockConstructionAbstract<L>
      Parameters:
      sizeZ - sizeZ.

    • getSizeX

      public int getSizeX()
      Returns the size of the structure in X direction.
      Specified by:
      getSizeX in interface com.github.shynixn.structureblocklib.api.block.StructureBlockConstructionAbstract<L>
      Returns:
      xSize.

    • getSizeY

      public int getSizeY()
      Returns the size of the structure in Y direction.
      Specified by:
      getSizeY in interface com.github.shynixn.structureblocklib.api.block.StructureBlockConstructionAbstract<L>
      Returns:
      ySize.

    • getSizeZ

      public int getSizeZ()
      Returns the size of the structure in Z direction.
      Specified by:
      getSizeZ in interface com.github.shynixn.structureblocklib.api.block.StructureBlockConstructionAbstract<L>
      Returns:
      zSize.

    • setSaveName

      public void setSaveName(@Nullable @Nullable String name)
      Sets the name of the save.
      Specified by:
      setSaveName in interface com.github.shynixn.structureblocklib.api.block.StructureBlockCornerAbstract
      Parameters:
      name - name.

    • getSaveName

      @Nullable public @Nullable String getSaveName()
      Returns the name of the save.
      Specified by:
      getSaveName in interface com.github.shynixn.structureblocklib.api.block.StructureBlockCornerAbstract
      Returns:
      name.

    • setBlockNameMetaData

      public void setBlockNameMetaData(@Nullable @Nullable String blockNameMetaData)
      Sets custom meta data. Please use the minecraft documentation to find out more.
      Specified by:
      setBlockNameMetaData in interface com.github.shynixn.structureblocklib.api.block.StructureBlockDataAbstract
      Parameters:
      blockNameMetaData - customMeta.

    • getBlockNameMetaData

      @Nullable public @Nullable String getBlockNameMetaData()
      Returns the custom meta data.
      Specified by:
      getBlockNameMetaData in interface com.github.shynixn.structureblocklib.api.block.StructureBlockDataAbstract
      Returns:
      customMeta

    • setInvisibleBlocksEnabled

      public void setInvisibleBlocksEnabled(boolean flag)
      Sets if invisibleBlocks should be visible.
      Specified by:
      setInvisibleBlocksEnabled in interface com.github.shynixn.structureblocklib.api.block.StructureBlockSaveAbstract<L,V>
      Parameters:
      flag - flag.

    • isInvisibleBlocksEnabled

      public boolean isInvisibleBlocksEnabled()
      Returns if invisibleBlocks are visible.
      Specified by:
      isInvisibleBlocksEnabled in interface com.github.shynixn.structureblocklib.api.block.StructureBlockSaveAbstract<L,V>
      Returns:
      visible

    • saveStructure

      @NotNull public @NotNull com.github.shynixn.structureblocklib.api.entity.StructureSaverAbstract<L,V> saveStructure()
      Gets the associated StructureSaverAbstract instance which contains the current block properties.
      Specified by:
      saveStructure in interface com.github.shynixn.structureblocklib.api.block.StructureBlockSaveAbstract<L,V>
      Returns:
      Saver.

    • loadStructure

      @NotNull public @NotNull com.github.shynixn.structureblocklib.api.entity.StructureLoaderAbstract<L,V> loadStructure()
      Gets the associated StructureLoaderAbstract instance which contains the current block properties.
      Specified by:
      loadStructure in interface com.github.shynixn.structureblocklib.api.block.StructureBlockLoadAbstract<L,V>
      Returns:
      Loader.