#99 Added includeBlocks and onProcessEntity functions to loader.

Author: Shynixn

structureblocklib-api/src/main/java/com/github/shynixn/structureblocklib/api/block/StructureBlockLoadAbstract.java

@@ -5,7 +5,7 @@
 import com.github.shynixn.structureblocklib.api.enumeration.StructureRotation;
 import org.jetbrains.annotations.NotNull;
 
-public interface StructureBlockLoadAbstract<L, V, B, W> extends StructureBlockConstructionAbstract<L> {
+public interface StructureBlockLoadAbstract<L, V, B, E, W> extends StructureBlockConstructionAbstract<L> {
     /**
      * Sets the mirrorType of the structure when getting load.
      *
@@ -85,5 +85,5 @@ public interface StructureBlockLoadAbstract<L, V, B, W> extends StructureBlockCo
      * @return Loader.
      */
     @NotNull
-    StructureLoaderAbstract<L, V, B, W> loadStructure();
+    StructureLoaderAbstract<L, V, B, E, W> loadStructure();
 }

structureblocklib-api/src/main/java/com/github/shynixn/structureblocklib/api/entity/StructureEntity.java

@@ -0,0 +1,39 @@
+package com.github.shynixn.structureblocklib.api.entity;
+
+import java.util.Optional;
+import java.util.function.Consumer;
+
+/**
+ * Represents an entity stored in a structure.
+ */
+public interface StructureEntity<Entity, Location> {
+    /**
+     * Tries to spawn an entity from the stored nbt data at the given location.
+     *
+     * @param location Target {@link  Location}.
+     * @return A valid entity or empty optional.
+     */
+    Optional<Entity> spawnEntity(Location location);
+
+    /**
+     * Generates a virtual entity, which is not added to the world but the data
+     * can be extracted. This entity is destroyed after peeking.
+     *
+     * @return A valid entity or empty optional.
+     */
+    Optional<Entity> getEntity();
+
+    /**
+     * Gets the relative source location inside the structure.
+     *
+     * @return {@link Location}.
+     */
+    Location getSourceLocation();
+
+    /**
+     * Gets the nbt data of the stored entity in string format.
+     *
+     * @return NBT data.
+     */
+    String getNbtData();
+}

structureblocklib-api/src/main/java/com/github/shynixn/structureblocklib/api/entity/StructureLoaderAbstract.java

@@ -14,7 +14,7 @@
  * Interface fluent API to load structures from sources into
  * the world
  */
-public interface StructureLoaderAbstract<L, V, B, W> {
+public interface StructureLoaderAbstract<L, V, B, E, W> {
     /**
      * Gets the target Location.
      *
@@ -32,6 +32,15 @@ public interface StructureLoaderAbstract<L, V, B, W> {
      */
     boolean isIncludeEntitiesEnabled();
 
+    /**
+     * Should blocks which may or may not be included in the
+     * saved file be included in the loaded structure.
+     * Default true.
+     *
+     * @return flag.
+     */
+    boolean isIncludeBlocksEnabled();
+
     /**
      * Gets the target mirror type.
      * Default StructureMirror.NONE.
@@ -76,7 +85,7 @@ public interface StructureLoaderAbstract<L, V, B, W> {
      * @return This instance.
      */
     @NotNull
-    StructureLoaderAbstract<L, V, B, W> at(@Nullable L location);
+    StructureLoaderAbstract<L, V, B, E, W> at(@Nullable L location);
 
     /**
      * Should entities which may or may not be included in the
@@ -86,7 +95,17 @@ public interface StructureLoaderAbstract<L, V, B, W> {
      * @param enabled Flag.
      * @return This instance.
      */
-    StructureLoaderAbstract<L, V, B, W> includeEntities(boolean enabled);
+    StructureLoaderAbstract<L, V, B, E, W> includeEntities(boolean enabled);
+
+    /**
+     * Should blocks which may or may not be included in the
+     * saved file be included in the loaded structure.
+     * Default true.
+     *
+     * @param enabled Flag.
+     * @return This instance.
+     */
+    StructureLoaderAbstract<L, V, B, E, W> includeBlocks(boolean enabled);
 
     /**
      * Sets the target mirror type.
@@ -95,7 +114,7 @@ public interface StructureLoaderAbstract<L, V, B, W> {
      * @param mirror Mirror.
      * @return This instance.
      */
-    StructureLoaderAbstract<L, V, B, W> mirror(StructureMirror mirror);
+    StructureLoaderAbstract<L, V, B, E, W> mirror(StructureMirror mirror);
 
     /**
      * Sets the target rotation type.
@@ -104,7 +123,7 @@ public interface StructureLoaderAbstract<L, V, B, W> {
      * @param rotation Rotation.
      * @return This instance.
      */
-    StructureLoaderAbstract<L, V, B, W> rotation(StructureRotation rotation);
+    StructureLoaderAbstract<L, V, B, E, W> rotation(StructureRotation rotation);
 
     /**
      * Sets the target integrity.
@@ -115,7 +134,7 @@ public interface StructureLoaderAbstract<L, V, B, W> {
      * @param integrity Integrity.
      * @return This instance.
      */
-    StructureLoaderAbstract<L, V, B, W> integrity(float integrity);
+    StructureLoaderAbstract<L, V, B, E, W> integrity(float integrity);
 
     /**
      * Sets the target seed.
@@ -125,7 +144,7 @@ public interface StructureLoaderAbstract<L, V, B, W> {
      * @param seed Seed.
      * @return This instance.
      */
-    StructureLoaderAbstract<L, V, B, W> seed(long seed);
+    StructureLoaderAbstract<L, V, B, E, W> seed(long seed);
 
     /**
      * Attaches a new function to the structure processor which is called for each block being placed in the world.
@@ -137,7 +156,19 @@ public interface StructureLoaderAbstract<L, V, B, W> {
      * @return This instance.
      */
     @NotNull
-    StructureLoaderAbstract<L, V, B, W> onProcessBlock(Function<StructurePlacePart<B, W>, Boolean> onStructurePlace);
+    StructureLoaderAbstract<L, V, B, E, W> onProcessBlock(Function<StructurePlacePart<B, W>, Boolean> onStructurePlace);
+
+    /**
+     * Attaches a new function to the structure processor which is called for each entity being placed in the world.
+     * If true, the entity is getting placed in the world. If false, the entity is not getting placed.
+     * Multiple processor can be attached to a single structure load (e.g. executed in the order they are added).
+     * If one processor returns false, subsequent processor are no longer being called.
+     *
+     * @param onStructurePlace A function being called for each entity being placed.
+     * @return This instance.
+     */
+    @NotNull
+    StructureLoaderAbstract<L, V, B, E, W> onProcessEntity(Function<StructureEntity<E, L>, Boolean> onStructurePlace);
 
     /**
      * Loads the structure blocks and entities from the given source and places

structureblocklib-api/src/main/java/com/github/shynixn/structureblocklib/api/entity/StructurePlaceMeta.java

@@ -17,12 +17,27 @@ public interface StructurePlaceMeta {
     Position getLocation();
 
     /**
-     * Gets the processors when placing this structure.
+     * Deprecated, use getBlockProcessors instead.
+     */
+    @NotNull
+    @Deprecated
+    List<Function<?, Boolean>> getProcessors();
+
+    /**
+     * Gets the block processors when placing this structure.
      *
      * @return processors.
      */
     @NotNull
-    List<Function<?, Boolean>> getProcessors();
+    List<Function<?, Boolean>> getBlockProcessors();
+
+    /**
+     * Gets the Entity processors when placing this structure.
+     *
+     * @return processors.
+     */
+    @NotNull
+    List<Function<?, Boolean>> getEntityProcessors();
 
     /**
      * Should entities be loaded.
@@ -32,6 +47,14 @@ public interface StructurePlaceMeta {
      */
     boolean isIncludeEntitiesEnabled();
 
+    /**
+     * Should blocks be loaded.
+     * Default false.
+     *
+     * @return flag.
+     */
+    boolean isIncludeBlockEnabled();
+
     /**
      * Gets the target mirror type.
      * Default StructureMirror.NONE.

structureblocklib-bukkit-api/src/main/java/com/github/shynixn/structureblocklib/api/bukkit/block/StructureBlockLoad.java

@@ -4,10 +4,11 @@
 import org.bukkit.Location;
 import org.bukkit.World;
 import org.bukkit.block.Block;
+import org.bukkit.entity.Entity;
 import org.bukkit.util.Vector;
 
 /**
  * Bukkit Wrapper for the StructureBlock.
  */
-public interface StructureBlockLoad extends StructureBlockLoadAbstract<Location, Vector, Block, World>, StructureBlockConstruction {
+public interface StructureBlockLoad extends StructureBlockLoadAbstract<Location, Vector, Block, Entity, World>, StructureBlockConstruction {
 }

structureblocklib-bukkit-api/src/main/java/com/github/shynixn/structureblocklib/api/bukkit/entity/StructureLoader.java

@@ -4,10 +4,11 @@
 import org.bukkit.Location;
 import org.bukkit.World;
 import org.bukkit.block.Block;
+import org.bukkit.entity.Entity;
 import org.bukkit.util.Vector;
 
 /**
  * Bukkit Wrapper for StructureLoader.
  */
-public interface StructureLoader extends StructureLoaderAbstract<Location, Vector, Block, World> {
+public interface StructureLoader extends StructureLoaderAbstract<Location, Vector, Block, Entity, World> {
 }

structureblocklib-bukkit-core/bukkit-nms-109R2/src/main/java/com/github/shynixn/structureblocklib/bukkit/v1_9_R2/CraftStructureBlock.java

@@ -19,12 +19,13 @@
 import org.bukkit.block.Block;
 import org.bukkit.craftbukkit.v1_9_R2.CraftWorld;
 import org.bukkit.craftbukkit.v1_9_R2.block.CraftBlockState;
+import org.bukkit.entity.Entity;
 import org.bukkit.util.Vector;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
 public class CraftStructureBlock extends CraftBlockState implements StructureBlockData, StructureBlockSave, StructureBlockLoad {
-    public StructureBlockAbstractImpl<Location, Vector, Block, World> internalBlock;
+    public StructureBlockAbstractImpl<Location, Vector, Block, Entity, World> internalBlock;
     public TypeConversionService conversionService;
     public TileEntityStructure tileEntityStructure;
 
@@ -34,7 +35,7 @@ public class CraftStructureBlock extends CraftBlockState implements StructureBlo
      * @param structure dependency.
      * @param block     dependency.
      */
-    public CraftStructureBlock(StructureBlockAbstractImpl<Location, Vector, Block, World> structure, TypeConversionService conversionService, Block block) {
+    public CraftStructureBlock(StructureBlockAbstractImpl<Location, Vector, Block, Entity, World> structure, TypeConversionService conversionService, Block block) {
         super(block);
         final CraftWorld world = (CraftWorld) block.getWorld();
         this.internalBlock = structure;
@@ -407,7 +408,7 @@ public void setStructureMode(@NotNull StructureMode structureMode) {
      * @return New instance.
      */
     @Override
-    public @NotNull StructureLoaderAbstract<Location, Vector, Block, World> loadStructure() {
+    public @NotNull StructureLoaderAbstract<Location, Vector, Block, Entity, World> loadStructure() {
         return internalBlock.loadStructure();
     }
 

structureblocklib-bukkit-core/bukkit-nms-110R1/src/main/java/com/github/shynixn/structureblocklib/bukkit/v1_10_R1/CraftStructureBlock.java

@@ -19,12 +19,13 @@
 import org.bukkit.block.Block;
 import org.bukkit.craftbukkit.v1_10_R1.CraftWorld;
 import org.bukkit.craftbukkit.v1_10_R1.block.CraftBlockState;
+import org.bukkit.entity.Entity;
 import org.bukkit.util.Vector;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
 public class CraftStructureBlock extends CraftBlockState implements StructureBlockData, StructureBlockSave, StructureBlockLoad {
-    public StructureBlockAbstractImpl<Location, Vector, Block, World> internalBlock;
+    public StructureBlockAbstractImpl<Location, Vector, Block, Entity, World> internalBlock;
     public TypeConversionService conversionService;
     public TileEntityStructure tileEntityStructure;
 
@@ -34,7 +35,7 @@ public class CraftStructureBlock extends CraftBlockState implements StructureBlo
      * @param structure dependency.
      * @param block     dependency.
      */
-    public CraftStructureBlock(StructureBlockAbstractImpl<Location, Vector, Block, World> structure, TypeConversionService conversionService, Block block) {
+    public CraftStructureBlock(StructureBlockAbstractImpl<Location, Vector, Block, Entity, World> structure, TypeConversionService conversionService, Block block) {
         super(block);
         final CraftWorld world = (CraftWorld) block.getWorld();
         this.internalBlock = structure;
@@ -411,7 +412,7 @@ public void setStructureMode(@NotNull StructureMode structureMode) {
      * @return New instance.
      */
     @Override
-    public @NotNull StructureLoaderAbstract<Location, Vector, Block, World> loadStructure() {
+    public @NotNull StructureLoaderAbstract<Location, Vector, Block, Entity, World> loadStructure() {
         return internalBlock.loadStructure();
     }
 

structureblocklib-bukkit-core/bukkit-nms-111R1/src/main/java/com/github/shynixn/structureblocklib/bukkit/v1_11_R1/CraftStructureBlock.java

@@ -19,12 +19,13 @@
 import org.bukkit.block.Block;
 import org.bukkit.craftbukkit.v1_11_R1.CraftWorld;
 import org.bukkit.craftbukkit.v1_11_R1.block.CraftBlockState;
+import org.bukkit.entity.Entity;
 import org.bukkit.util.Vector;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
 public class CraftStructureBlock extends CraftBlockState implements StructureBlockData, StructureBlockSave, StructureBlockLoad {
-    public StructureBlockAbstractImpl<Location, Vector, Block, World> internalBlock;
+    public StructureBlockAbstractImpl<Location, Vector, Block, Entity, World> internalBlock;
     public TypeConversionService conversionService;
     public TileEntityStructure tileEntityStructure;
 
@@ -34,7 +35,7 @@ public class CraftStructureBlock extends CraftBlockState implements StructureBlo
      * @param structure dependency.
      * @param block     dependency.
      */
-    public CraftStructureBlock(StructureBlockAbstractImpl<Location, Vector, Block, World> structure, TypeConversionService conversionService, Block block) {
+    public CraftStructureBlock(StructureBlockAbstractImpl<Location, Vector, Block, Entity, World> structure, TypeConversionService conversionService, Block block) {
         super(block);
         final CraftWorld world = (CraftWorld) block.getWorld();
         this.internalBlock = structure;
@@ -411,7 +412,7 @@ public void setStructureMode(@NotNull StructureMode structureMode) {
      * @return New instance.
      */
     @Override
-    public @NotNull StructureLoaderAbstract<Location, Vector, Block, World> loadStructure() {
+    public @NotNull StructureLoaderAbstract<Location, Vector, Block, Entity, World> loadStructure() {
         return internalBlock.loadStructure();
     }
 

structureblocklib-bukkit-core/bukkit-nms-112R1/src/main/java/com/github/shynixn/structureblocklib/bukkit/v1_12_R1/CraftStructureBlock.java

@@ -19,12 +19,13 @@
 import org.bukkit.block.Block;
 import org.bukkit.craftbukkit.v1_12_R1.CraftWorld;
 import org.bukkit.craftbukkit.v1_12_R1.block.CraftBlockState;
+import org.bukkit.entity.Entity;
 import org.bukkit.util.Vector;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
 public class CraftStructureBlock extends CraftBlockState implements StructureBlockData, StructureBlockSave, StructureBlockLoad {
-    public StructureBlockAbstractImpl<Location, Vector, Block, World> internalBlock;
+    public StructureBlockAbstractImpl<Location, Vector, Block, Entity, World> internalBlock;
     public TypeConversionService conversionService;
     public TileEntityStructure tileEntityStructure;
 
@@ -34,7 +35,7 @@ public class CraftStructureBlock extends CraftBlockState implements StructureBlo
      * @param structure dependency.
      * @param block     dependency.
      */
-    public CraftStructureBlock(StructureBlockAbstractImpl<Location, Vector, Block, World> structure, TypeConversionService conversionService, Block block) {
+    public CraftStructureBlock(StructureBlockAbstractImpl<Location, Vector, Block, Entity, World> structure, TypeConversionService conversionService, Block block) {
         super(block);
         final CraftWorld world = (CraftWorld) block.getWorld();
         this.internalBlock = structure;
@@ -411,7 +412,7 @@ public void setStructureMode(@NotNull StructureMode structureMode) {
      * @return New instance.
      */
     @Override
-    public @NotNull StructureLoaderAbstract<Location, Vector, Block, World> loadStructure() {
+    public @NotNull StructureLoaderAbstract<Location, Vector, Block, Entity, World> loadStructure() {
         return internalBlock.loadStructure();
     }