Expand a bit of Schematic API to support serialiation

Signed-off-by: Gabriel Harris-Rouquette <[email protected]>

Author: gabizou

src/main/java/org/spongepowered/api/world/schematic/PaletteTypes.java

@@ -28,6 +28,7 @@
 import org.spongepowered.api.Sponge;
 import org.spongepowered.api.block.BlockState;
 import org.spongepowered.api.block.BlockType;
+import org.spongepowered.api.block.entity.BlockEntityType;
 import org.spongepowered.api.registry.DefaultedRegistryReference;
 import org.spongepowered.api.registry.RegistryKey;
 import org.spongepowered.api.registry.RegistryScope;
@@ -58,6 +59,8 @@ public final class PaletteTypes {
      */
     public static final DefaultedRegistryReference<PaletteType<BlockState, BlockType>> BLOCK_STATE_PALETTE = PaletteTypes.key(ResourceKey.sponge("block_state_palette"));
 
+    public static final DefaultedRegistryReference<PaletteType<BlockEntityType, BlockEntityType>> BLOCK_ENTITY_PALETTE = PaletteTypes.key(ResourceKey.sponge("block_entity_type_palette"));
+
     // SORTFIELDS:OFF
 
     // @formatter:on

src/main/java/org/spongepowered/api/world/schematic/Schematic.java

@@ -90,6 +90,11 @@ interface Builder extends org.spongepowered.api.util.Builder<Schematic, Builder>
 
         /**
          * Specifies an archetype volume for the world data of the schematic.
+         * This is to take part of the schematic, so it should not be referenced
+         * outside of the schematic, less modifications are going to be made
+         * also affecting {@link #blockEntities(BlockEntityVolume) the block
+         * entity volume}.
+         *
          *
          * @param volume The archetype volume
          * @return This builder, for chaining

src/main/java/org/spongepowered/api/world/volume/archetype/ArchetypeVolume.java

@@ -24,13 +24,73 @@
  */
 package org.spongepowered.api.world.volume.archetype;
 
+import org.spongepowered.api.Sponge;
+import org.spongepowered.api.block.BlockType;
+import org.spongepowered.api.event.CauseStackManager;
+import org.spongepowered.api.event.EventContextKeys;
+import org.spongepowered.api.event.cause.entity.SpawnType;
+import org.spongepowered.api.registry.Registry;
+import org.spongepowered.api.registry.RegistryTypes;
+import org.spongepowered.api.world.BlockChangeFlags;
+import org.spongepowered.api.world.biome.Biome;
+import org.spongepowered.api.world.server.ServerWorld;
 import org.spongepowered.api.world.volume.archetype.block.entity.BlockEntityArchetypeVolume;
 import org.spongepowered.api.world.volume.archetype.entity.EntityArchetypeVolume;
 import org.spongepowered.api.world.volume.biome.BiomeVolume;
 import org.spongepowered.api.world.volume.block.BlockVolume;
+import org.spongepowered.api.world.volume.stream.StreamOptions;
+import org.spongepowered.api.world.volume.stream.VolumeApplicators;
+import org.spongepowered.api.world.volume.stream.VolumeCollectors;
+import org.spongepowered.api.world.volume.stream.VolumePositionTranslators;
+import org.spongepowered.math.vector.Vector3i;
+
+import java.util.Objects;
+import java.util.function.Supplier;
 
 public interface ArchetypeVolume extends BlockVolume.Mutable<ArchetypeVolume>,
     BlockEntityArchetypeVolume.Mutable<ArchetypeVolume>,
     EntityArchetypeVolume.Mutable<ArchetypeVolume>,
     BiomeVolume.Mutable<ArchetypeVolume> {
+
+    Registry<BlockType> blockStateRegistry();
+
+    Registry<Biome> biomeRegistry();
+
+    default void applyToWorld(final ServerWorld target, final Vector3i placement, final Supplier<SpawnType> spawnContext) {
+        Objects.requireNonNull(target, "Target world cannot be null");
+        Objects.requireNonNull(placement, "Target position cannot be null");
+        try (final CauseStackManager.StackFrame frame = Sponge.server().causeStackManager().pushCauseFrame()) {
+            this.blockStateStream(this.blockMin(), this.blockMax(), StreamOptions.lazily())
+                .apply(VolumeCollectors.of(
+                    target,
+                    VolumePositionTranslators.relativeTo(placement),
+                    VolumeApplicators.applyBlocks(BlockChangeFlags.ALL)
+                ));
+
+            this.biomeStream(this.blockMin(), this.blockMax(), StreamOptions.lazily())
+                // It's common that we'll have to be translating back and forth between ResourceKeys because a Biome
+                // is reloadable between worlds (one biome instance can be limited to that world)
+                .map((v, b, x, y, z) -> this.biomeRegistry().valueKey(b.get()))
+                .map((v, key, x, y, z) -> target.registries().registry(RegistryTypes.BIOME).<Biome>value(key.get()))
+                .apply(VolumeCollectors.of(
+                    target,
+                    VolumePositionTranslators.relativeTo(placement),
+                    VolumeApplicators.applyBiomes()
+                ));
+            this.blockEntityArchetypeStream(this.blockMin(), this.blockMax(), StreamOptions.lazily())
+                .apply(VolumeCollectors.of(
+                    target,
+                    VolumePositionTranslators.relativeTo(placement),
+                    VolumeApplicators.applyBlockEntityArchetype()
+                ));
+            frame.addContext(EventContextKeys.SPAWN_TYPE, spawnContext);
+            this.entityArchetypeStream(this.blockMin(), this.blockMax(), StreamOptions.lazily())
+                .apply(VolumeCollectors.of(
+                    target,
+                    VolumePositionTranslators.relativeTo(placement),
+                    VolumeApplicators.applyEntityArchetype()
+                ));
+        }
+    }
+
 }

src/main/java/org/spongepowered/api/world/volume/archetype/entity/EntityArchetypeVolume.java

@@ -53,6 +53,8 @@ public interface EntityArchetypeVolume extends Volume {
 
     Collection<EntityArchetype> entityArchetypes();
 
+    Collection<EntityArchetypeEntry> entityArchetypesByPosition();
+
     Collection<EntityArchetype> entityArchetypes(Predicate<EntityArchetype> filter);
 
     interface Streamable<B extends Streamable<B>> extends EntityArchetypeVolume {

src/main/java/org/spongepowered/api/world/volume/stream/VolumeApplicators.java

@@ -24,6 +24,7 @@
  */
 package org.spongepowered.api.world.volume.stream;
 
+import org.checkerframework.checker.nullness.qual.NonNull;
 import org.spongepowered.api.block.BlockState;
 import org.spongepowered.api.block.entity.BlockEntity;
 import org.spongepowered.api.block.entity.BlockEntityArchetype;
@@ -99,7 +100,6 @@ extends BlockEntity>> applyBlockEntityArchetype() {
         return (volume, element) -> element.type().apply((ServerLocation) volume.location(element.position()));
     }
 
-    @SuppressWarnings("ConstantConditions")
     public static <M extends BlockEntityArchetypeVolume.Mutable<M>> VolumeApplicator<M, BlockEntityArchetype, Boolean> applyBlockEntityArchetypes() {
         return (volume, element) -> {
             volume.addBlockEntity(element.position(), element.type());
@@ -115,7 +115,8 @@ public static <M extends BiomeVolume.Mutable<M>> VolumeApplicator<M, Biome, Bool
         return (volume, element) -> volume.setBiome(element.position(), element.type());
     }
 
-    public static <M extends LocationCreator<?, ? extends ServerLocation> & EntityVolume.Mutable<M>> VolumeApplicator<M, EntityArchetype, Optional<?
+    @SuppressWarnings("RedundantCast")
+    public static <M extends LocationCreator<@NonNull ?, ? extends ServerLocation> & EntityVolume.Mutable<M>> VolumeApplicator<M, EntityArchetype, Optional<?
             extends Entity>> applyEntityArchetype() {
         return (volume, element) -> element.type().apply((ServerLocation) volume.location(element.position()));
     }