Package com.github.shynixn.structureblocklib.core.entity

Class StructureReadMetaImpl

java.lang.Object
com.github.shynixn.structureblocklib.core.entity.StructureReadMetaImpl
All Implemented Interfaces:
com.github.shynixn.structureblocklib.api.entity.StructureReadMeta
public class StructureReadMetaImpl extends Object implements com.github.shynixn.structureblocklib.api.entity.StructureReadMeta

  • Field Details

    • location

      public com.github.shynixn.structureblocklib.api.entity.Position location

    • offset

      public com.github.shynixn.structureblocklib.api.entity.Position offset

    • includeEntities

      public boolean includeEntities

    • structureVoid

      public String structureVoid

    • author

      public String author

  • Constructor Details

    • StructureReadMetaImpl

      public StructureReadMetaImpl()

  • Method Details

    • getLocation

      @NotNull public @NotNull com.github.shynixn.structureblocklib.api.entity.Position getLocation()
      Gets the source Location.
      Specified by:
      getLocation in interface com.github.shynixn.structureblocklib.api.entity.StructureReadMeta
      Returns:
      location.

    • getOffset

      @NotNull public @NotNull com.github.shynixn.structureblocklib.api.entity.Position getOffset()
      Gets the offset of the selection.
      Specified by:
      getOffset in interface com.github.shynixn.structureblocklib.api.entity.StructureReadMeta
      Returns:
      offset.

    • getAuthor

      @NotNull public @NotNull String getAuthor()
      Gets the author. The author is a optional meta data in the final structure file.
      Specified by:
      getAuthor in interface com.github.shynixn.structureblocklib.api.entity.StructureReadMeta
      Returns:
      author.

    • isIncludeEntitiesEnabled

      public boolean isIncludeEntitiesEnabled()
      Should entities included in the saved file. Default false.
      Specified by:
      isIncludeEntitiesEnabled in interface com.github.shynixn.structureblocklib.api.entity.StructureReadMeta
      Returns:
      flag.

    • getStructureVoidTypeName

      @NotNull public @NotNull String getStructureVoidTypeName()
      Gets the name of the block type which is being used as a Structure_Void.

      Default STRUCTURE_VOID in 1.10 - Latest, BARRIER_BLOCK in 1.9.

      If the selected structure contains blocks with this typename. They are going to get ignored.

      Specified by:
      getStructureVoidTypeName in interface com.github.shynixn.structureblocklib.api.entity.StructureReadMeta
      Returns:
      Name of the block type.