Add support for copying pattern inventories (given enough blank patte…

…rns) from one pattern provider to another. (#6657)

(cherry picked from commit 7431cca)

src/main/java/appeng/api/crafting/PatternDetailsHelper.java

@@ -92,8 +92,8 @@ public static IPatternDetails decodePattern(ItemStack stack, Level level, boolea
      * using some process external to the ME system.
      *
      * @param out The first element is considered the primary output and must be present
-     * @throws IllegalArgumentException If either in or out contain only empty ItemStacks, or no primary output
      * @return A new encoded pattern.
+     * @throws IllegalArgumentException If either in or out contain only empty ItemStacks, or no primary output
      */
     public static ItemStack encodeProcessingPattern(GenericStack[] in, GenericStack[] out) {
         return AEItems.PROCESSING_PATTERN.asItem().encode(in, out);

src/main/java/appeng/blockentity/crafting/PatternProviderBlockEntity.java

@@ -27,6 +27,7 @@
 import net.minecraft.core.Direction;
 import net.minecraft.nbt.CompoundTag;
 import net.minecraft.network.FriendlyByteBuf;
+import net.minecraft.world.entity.player.Player;
 import net.minecraft.world.item.ItemStack;
 import net.minecraft.world.level.Level;
 import net.minecraft.world.level.block.entity.BlockEntityType;
@@ -39,6 +40,7 @@
 import appeng.helpers.iface.PatternProviderLogic;
 import appeng.helpers.iface.PatternProviderLogicHost;
 import appeng.util.Platform;
+import appeng.util.SettingsFrom;
 
 public class PatternProviderBlockEntity extends AENetworkBlockEntity implements PatternProviderLogicHost {
     private final PatternProviderLogic logic = new PatternProviderLogic(this.getMainNode(), this);
@@ -157,6 +159,22 @@ public EnumSet<Direction> getTargets() {
         return EnumSet.of(this.getForward());
     }
 
+    @Override
+    public void exportSettings(SettingsFrom mode, CompoundTag output,
+            @org.jetbrains.annotations.Nullable Player player) {
+        if (mode == SettingsFrom.MEMORY_CARD) {
+            logic.exportSettings(output);
+        }
+    }
+
+    @Override
+    public void importSettings(SettingsFrom mode, CompoundTag input,
+            @org.jetbrains.annotations.Nullable Player player) {
+        if (mode == SettingsFrom.MEMORY_CARD) {
+            logic.importSettings(input, player);
+        }
+    }
+
     public boolean isOmniDirectional() {
         return this.omniDirectional;
     }

src/main/java/appeng/core/localization/PlayerMessages.java

@@ -24,6 +24,7 @@ public enum PlayerMessages implements LocalizationEnum {
     CommunicationError("Error Communicating with Network."),
     DeviceNotLinked("Device is not linked."),
     DeviceNotPowered("Device is low on power."),
+    MissingBlankPatterns("Not enough blank pattern to restore patterns (missing %d)."),
     MissingUpgrades("Not enough %s to restore upgrades (missing %d)."),
     InvalidMachine("Could not restore configuration for an incompatible device."),
     InvalidMachinePartiallyRestored("Partially restored configuration for an incompatible device: %s."),

src/main/java/appeng/helpers/iface/PatternProviderLogic.java

@@ -26,6 +26,7 @@
 
 import javax.annotation.Nullable;
 
+import net.minecraft.Util;
 import net.minecraft.core.BlockPos;
 import net.minecraft.core.Direction;
 import net.minecraft.nbt.CompoundTag;
@@ -35,6 +36,7 @@
 import net.minecraft.network.chat.TextComponent;
 import net.minecraft.network.chat.TranslatableComponent;
 import net.minecraft.server.level.ServerLevel;
+import net.minecraft.world.entity.player.Player;
 import net.minecraft.world.item.Item;
 import net.minecraft.world.item.ItemStack;
 import net.minecraft.world.item.Items;
@@ -65,19 +67,24 @@
 import appeng.api.stacks.GenericStack;
 import appeng.api.stacks.KeyCounter;
 import appeng.api.util.IConfigManager;
+import appeng.core.AELog;
+import appeng.core.definitions.AEItems;
+import appeng.core.localization.PlayerMessages;
 import appeng.core.settings.TickRates;
 import appeng.helpers.ICustomNameObject;
 import appeng.me.helpers.MachineSource;
 import appeng.util.ConfigManager;
 import appeng.util.inv.AppEngInternalInventory;
 import appeng.util.inv.InternalInventoryHost;
+import appeng.util.inv.PlayerInternalInventory;
 
 /**
  * Shared code between the pattern provider block and part.
  */
 public class PatternProviderLogic implements InternalInventoryHost, ICraftingProvider {
 
     public static final int NUMBER_OF_PATTERN_SLOTS = 9;
+    public static final String NBT_MEMORY_CARD_PATTERNS = "patterns";
 
     private final PatternProviderLogicHost host;
     private final IManagedGridNode mainNode;
@@ -130,7 +137,7 @@ public void setPriority(int priority) {
 
     public void writeToNBT(CompoundTag tag) {
         this.configManager.writeToNBT(tag);
-        this.patternInventory.writeToNBT(tag, "patterns");
+        this.patternInventory.writeToNBT(tag, NBT_MEMORY_CARD_PATTERNS);
         tag.putInt("priority", this.priority);
 
         ListTag sendListTag = new ListTag();
@@ -147,7 +154,7 @@ public void writeToNBT(CompoundTag tag) {
 
     public void readFromNBT(CompoundTag tag) {
         this.configManager.readFromNBT(tag);
-        this.patternInventory.readFromNBT(tag, "patterns");
+        this.patternInventory.readFromNBT(tag, NBT_MEMORY_CARD_PATTERNS);
         this.priority = tag.getInt("priority");
 
         ListTag sendListTag = tag.getList("sendList", Tag.TAG_COMPOUND);
@@ -395,6 +402,89 @@ public PatternProviderReturnInventory getReturnInv() {
         return this.returnInv;
     }
 
+    public void exportSettings(CompoundTag output) {
+        patternInventory.writeToNBT(output, NBT_MEMORY_CARD_PATTERNS);
+    }
+
+    public void importSettings(CompoundTag input, @org.jetbrains.annotations.Nullable Player player) {
+        if (player != null && input.contains(NBT_MEMORY_CARD_PATTERNS) && !player.level.isClientSide) {
+            clearPatternInventory(player);
+
+            var desiredPatterns = new AppEngInternalInventory(patternInventory.size());
+            desiredPatterns.readFromNBT(input, NBT_MEMORY_CARD_PATTERNS);
+
+            // Restore from blank patterns in the player inv
+            var playerInv = player.getInventory();
+            var blankPatternsAvailable = player.getAbilities().instabuild ? Integer.MAX_VALUE
+                    : playerInv.countItem(AEItems.BLANK_PATTERN.asItem());
+            var blankPatternsUsed = 0;
+            for (int i = 0; i < desiredPatterns.size(); i++) {
+                // Don't restore junk
+                var pattern = PatternDetailsHelper.decodePattern(desiredPatterns.getStackInSlot(i),
+                        host.getBlockEntity().getLevel(), true);
+                if (pattern == null) {
+                    continue; // Skip junk / broken recipes
+                }
+
+                // Keep track of how many blank patterns we need
+                ++blankPatternsUsed;
+                if (blankPatternsAvailable >= blankPatternsUsed) {
+                    if (!patternInventory.addItems(pattern.getDefinition().toStack()).isEmpty()) {
+                        AELog.warn("Failed to add pattern to pattern provider");
+                        blankPatternsUsed--;
+                    }
+                }
+            }
+
+            // Deduct the used blank patterns
+            if (blankPatternsUsed > 0 && !player.getAbilities().instabuild) {
+                new PlayerInternalInventory(playerInv)
+                        .removeItems(blankPatternsUsed, AEItems.BLANK_PATTERN.stack(), null);
+            }
+
+            // Warn about not being able to restore all patterns due to lack of blank patterns
+            if (blankPatternsUsed > blankPatternsAvailable) {
+                player.sendMessage(
+                        PlayerMessages.MissingBlankPatterns.text(blankPatternsUsed - blankPatternsAvailable),
+                        Util.NIL_UUID);
+            }
+        }
+    }
+
+    // Converts all patterns in this provider to blank patterns and give them to the player
+    private void clearPatternInventory(Player player) {
+        // Just clear it for creative mode players
+        if (player.getAbilities().instabuild) {
+            for (int i = 0; i < patternInventory.size(); i++) {
+                patternInventory.setItemDirect(i, ItemStack.EMPTY);
+            }
+            return;
+        }
+
+        var playerInv = player.getInventory();
+
+        // Clear out any existing patterns and give them to the player
+        var blankPatternCount = 0;
+        for (int i = 0; i < patternInventory.size(); i++) {
+            var pattern = patternInventory.getStackInSlot(i);
+            // Auto-Clear encoded patterns to allow them to stack
+            if (pattern.is(AEItems.CRAFTING_PATTERN.asItem())
+                    || pattern.is(AEItems.PROCESSING_PATTERN.asItem())
+                    || pattern.is(AEItems.BLANK_PATTERN.asItem())) {
+                blankPatternCount += pattern.getCount();
+            } else {
+                // Give back any non-blank-patterns individually
+                playerInv.placeItemBackInInventory(pattern);
+            }
+            patternInventory.setItemDirect(i, ItemStack.EMPTY);
+        }
+
+        // Place back the removed blank patterns all at once
+        if (blankPatternCount > 0) {
+            playerInv.placeItemBackInInventory(AEItems.BLANK_PATTERN.stack(blankPatternCount), false);
+        }
+    }
+
     private class Ticker implements IGridTickable {
 
         @Override

src/main/java/appeng/parts/crafting/PatternProviderPart.java

@@ -21,6 +21,8 @@
 import java.util.EnumSet;
 import java.util.List;
 
+import org.jetbrains.annotations.Nullable;
+
 import net.minecraft.core.Direction;
 import net.minecraft.nbt.CompoundTag;
 import net.minecraft.resources.ResourceLocation;
@@ -42,6 +44,7 @@
 import appeng.menu.locator.MenuLocators;
 import appeng.parts.BasicStatePart;
 import appeng.parts.PartModel;
+import appeng.util.SettingsFrom;
 
 public class PatternProviderPart extends BasicStatePart implements PatternProviderLogicHost {
 
@@ -112,6 +115,20 @@ public float getCableConnectionLength(AECableType cable) {
         return 4;
     }
 
+    @Override
+    public void exportSettings(SettingsFrom mode, CompoundTag output) {
+        if (mode == SettingsFrom.MEMORY_CARD) {
+            logic.exportSettings(output);
+        }
+    }
+
+    @Override
+    public void importSettings(SettingsFrom mode, CompoundTag input, @Nullable Player player) {
+        if (mode == SettingsFrom.MEMORY_CARD) {
+            logic.importSettings(input, player);
+        }
+    }
+
     @Override
     public boolean onPartActivate(Player p, InteractionHand hand, Vec3 pos) {
         if (!p.getCommandSenderWorld().isClientSide()) {