Refactoring and bug fixes regarding note blocks, candles and torches

.github/workflows/build.yml

@@ -34,4 +34,4 @@ jobs:
         uses: actions/upload-artifact@v2
         with:
           name: Artifacts
-          path: /**/build/*.jar
+          path: ./**/build/*.jar

README.md

@@ -60,6 +60,9 @@ Currently, the following features are still broken or missing:
   sometimes it can't place all the rails (to avoid placing anything incorrectly).
 - Legit mode? (for anticheats)
 
+Also, I have decided that features that fix existing builds,
+such as automatic excavation or correcting incorrectly placed blocks are out of the scope of this mod.
+
 ## Building and Contributing
 
 Each Minecraft version has its own submodule, that has the default fabric mod development tasks

v1_19_3/src/main/java/me/aleksilassila/litematica/printer/v1_19_3/BlockHelper.java

@@ -1,6 +1,8 @@
 package me.aleksilassila.litematica.printer.v1_19_3;
 
 import net.minecraft.block.*;
+import net.minecraft.item.Item;
+import net.minecraft.item.Items;
 
 import java.util.ArrayList;
 import java.util.Arrays;
@@ -16,5 +18,14 @@ abstract public class BlockHelper {
             DropperBlock.class, DispenserBlock.class, ShulkerBoxBlock.class, LecternBlock.class,
             FlowerPotBlock.class, BarrelBlock.class, BellBlock.class, SmithingTableBlock.class,
             LoomBlock.class, CartographyTableBlock.class, GrindstoneBlock.class,
-            StonecutterBlock.class, AbstractSignBlock.class));
+            StonecutterBlock.class, AbstractSignBlock.class, AbstractCandleBlock.class));
+
+    public static final Item[] SHOVEL_ITEMS = new Item[]{
+            Items.NETHERITE_SHOVEL,
+            Items.DIAMOND_SHOVEL,
+            Items.GOLDEN_SHOVEL,
+            Items.IRON_SHOVEL,
+            Items.STONE_SHOVEL,
+            Items.WOODEN_SHOVEL
+    };
 }

v1_19_3/src/main/java/me/aleksilassila/litematica/printer/v1_19_3/Printer.java

@@ -1,6 +1,7 @@
 package me.aleksilassila.litematica.printer.v1_19_3;
 
 import fi.dy.masa.litematica.data.DataManager;
+import fi.dy.masa.litematica.util.RayTraceUtils;
 import fi.dy.masa.litematica.world.SchematicWorldHandler;
 import fi.dy.masa.litematica.world.WorldSchematic;
 import me.aleksilassila.litematica.printer.v1_19_3.actions.Action;
@@ -13,6 +14,7 @@
 import net.minecraft.util.math.BlockPos;
 import net.minecraft.util.math.MathHelper;
 import net.minecraft.util.math.Vec3d;
+import net.minecraft.world.RaycastContext;
 import org.jetbrains.annotations.NotNull;
 
 import java.util.ArrayList;
@@ -54,7 +56,8 @@ public boolean onGameTick() {
 
             Guide[] guides = interactionGuides.getInteractionGuides(state);
 
-            boolean isCurrentlyLooking = ((BlockHitResult) player.raycast(20, 1, false)).getBlockPos().equals(position);
+            BlockHitResult result = RayTraceUtils.traceToSchematicWorld(player, 10, true, true);
+            boolean isCurrentlyLookingSchematic = result != null && result.getBlockPos().equals(position);
 
             for (Guide guide : guides) {
                 if (guide.canExecute(player)) {

v1_19_3/src/main/java/me/aleksilassila/litematica/printer/v1_19_3/guides/Guide.java

@@ -29,13 +29,14 @@ public Guide(SchematicBlockState state) {
     }
 
     protected boolean playerHasRightItem(ClientPlayerEntity player) {
-        return getStackSlot(player) != -1;
+        return getRequiredItemStackSlot(player) != -1;
     }
 
     protected int getSlotWithItem(ClientPlayerEntity player, ItemStack itemStack) {
         PlayerInventory inventory = player.getInventory();
 
         for (int i = 0; i < inventory.main.size(); ++i) {
+            if (itemStack.isEmpty() && inventory.main.get(i).isOf(itemStack.getItem())) return i;
             if (!inventory.main.get(i).isEmpty() && inventory.main.get(i).isItemEqual(itemStack)) {
                 return i;
             }
@@ -44,7 +45,7 @@ protected int getSlotWithItem(ClientPlayerEntity player, ItemStack itemStack) {
         return -1;
     }
 
-    protected int getStackSlot(ClientPlayerEntity player) {
+    protected int getRequiredItemStackSlot(ClientPlayerEntity player) {
         if (player.getAbilities().creativeMode) {
             return player.getInventory().selectedSlot;
         }
@@ -64,7 +65,7 @@ public boolean canExecute(ClientPlayerEntity player) {
         return !statesEqual(targetState, currentState);
     }
 
-    abstract public List<Action> execute(ClientPlayerEntity player);
+    abstract public @NotNull List<Action> execute(ClientPlayerEntity player);
 
     abstract protected @NotNull List<ItemStack> getRequiredItems();
 
@@ -79,7 +80,7 @@ protected Optional<ItemStack> getRequiredItem(ClientPlayerEntity player) {
             if (player.getAbilities().creativeMode) return Optional.of(requiredItem);
 
             int slot = getSlotWithItem(player, requiredItem);
-            if (slot > -1 && !requiredItem.isOf(Items.AIR))
+            if (slot > -1)
                 return Optional.of(requiredItem);
         }
 

v1_19_3/src/main/java/me/aleksilassila/litematica/printer/v1_19_3/guides/Guides.java

@@ -34,14 +34,13 @@ protected static void registerGuide(Class<? extends Guide> guideClass, Class<? e
                 BambooBlock.class, CactusBlock.class, SaplingBlock.class, ScaffoldingBlock.class, PointedDripstoneBlock.class,
                 HorizontalConnectingBlock.class, DoorBlock.class, TrapdoorBlock.class, FenceGateBlock.class, ChestBlock.class,
                 SnowBlock.class, SeaPickleBlock.class, CandleBlock.class, LeverBlock.class, EndPortalFrameBlock.class,
-                CandleBlock.class, RedstoneTorchBlock.class, CampfireBlock.class, PoweredRailBlock.class, LeavesBlock.class,
-                TripwireHookBlock.class);
+                NoteBlock.class, CampfireBlock.class, PoweredRailBlock.class, LeavesBlock.class, TripwireHookBlock.class);
         registerGuide(FallingBlockGuide.class, FallingBlock.class);
         registerGuide(BlockIndifferentGuesserGuide.class, BambooBlock.class, BigDripleafStemBlock.class, BigDripleafBlock.class,
                 TwistingVinesPlantBlock.class, TripwireBlock.class);
-        registerGuide(GuesserGuide.class);
 
         registerGuide(CampfireExtinguishGuide.class, CampfireBlock.class);
+        registerGuide(LightCandleGuide.class, AbstractCandleBlock.class);
         registerGuide(EnderEyeGuide.class, EndPortalFrameBlock.class);
         registerGuide(CycleStateGuide.class,
                 DoorBlock.class, FenceGateBlock.class, TrapdoorBlock.class,
@@ -50,6 +49,7 @@ protected static void registerGuide(Class<? extends Guide> guideClass, Class<? e
         registerGuide(BlockReplacementGuide.class, SnowBlock.class, SeaPickleBlock.class, CandleBlock.class, SlabBlock.class);
         registerGuide(LogGuide.class);
         registerGuide(LogStrippingGuide.class);
+        registerGuide(GuesserGuide.class);
     }
 
     public ArrayList<Pair<Class<? extends Guide>, Class<? extends Block>[]>> getGuides() {

v1_19_3/src/main/java/me/aleksilassila/litematica/printer/v1_19_3/guides/SkipGuide.java

@@ -26,7 +26,7 @@ public boolean canExecute(ClientPlayerEntity player) {
     }
 
     @Override
-    public List<Action> execute(ClientPlayerEntity player) {
+    public @NotNull List<Action> execute(ClientPlayerEntity player) {
         return new ArrayList<>();
     }
 

v1_19_3/src/main/java/me/aleksilassila/litematica/printer/v1_19_3/guides/interaction/CampfireExtinguishGuide.java

@@ -12,28 +12,21 @@
 import java.util.List;
 
 public class CampfireExtinguishGuide extends InteractionGuide {
-    static final Item[] SHOVEL_ITEMS = new Item[]{
-            Items.NETHERITE_SHOVEL,
-            Items.DIAMOND_SHOVEL,
-            Items.GOLDEN_SHOVEL,
-            Items.IRON_SHOVEL,
-            Items.STONE_SHOVEL,
-            Items.WOODEN_SHOVEL
-    };
+    boolean shouldBeLit;
+    boolean isLit;
 
     public CampfireExtinguishGuide(SchematicBlockState state) {
         super(state);
+
+        shouldBeLit = getProperty(targetState, CampfireBlock.LIT).orElse(false);
+        isLit = getProperty(currentState, CampfireBlock.LIT).orElse(false);
     }
 
     @Override
     public boolean canExecute(ClientPlayerEntity player) {
         if (!super.canExecute(player)) return false;
 
-        if (currentState.getBlock() instanceof CampfireBlock && targetState.getBlock() instanceof CampfireBlock) {
-            return currentState.get(CampfireBlock.LIT) && !targetState.get(CampfireBlock.LIT);
-        }
-
-        return false;
+        return (currentState.getBlock() instanceof CampfireBlock) && !shouldBeLit && isLit;
     }
 
     @Override

v1_19_3/src/main/java/me/aleksilassila/litematica/printer/v1_19_3/guides/interaction/CycleStateGuide.java

@@ -2,6 +2,7 @@
 
 import me.aleksilassila.litematica.printer.v1_19_3.SchematicBlockState;
 import net.minecraft.block.BlockState;
+import net.minecraft.block.LeverBlock;
 import net.minecraft.client.network.ClientPlayerEntity;
 import net.minecraft.item.ItemStack;
 import net.minecraft.state.property.Properties;
@@ -12,8 +13,9 @@
 import java.util.List;
 
 public class CycleStateGuide extends InteractionGuide {
-    private static final Property<?>[] propertiesToIgnore = new Property[] {
-            Properties.POWERED
+    private static final Property<?>[] propertiesToIgnore = new Property[]{
+            Properties.POWERED,
+            Properties.LIT
     };
 
     public CycleStateGuide(SchematicBlockState state) {
@@ -34,6 +36,10 @@ public boolean canExecute(ClientPlayerEntity player) {
 
     @Override
     protected boolean statesEqual(BlockState state1, BlockState state2) {
+        if (state2.getBlock() instanceof LeverBlock) {
+            return super.statesEqual(state1, state2);
+        }
+
         return statesEqualIgnoreProperties(state1, state2, propertiesToIgnore);
     }
 }

v1_19_3/src/main/java/me/aleksilassila/litematica/printer/v1_19_3/guides/interaction/InteractionGuide.java

@@ -26,12 +26,17 @@ public InteractionGuide(SchematicBlockState state) {
     }
 
     @Override
-    public List<Action> execute(ClientPlayerEntity player) {
+    public @NotNull List<Action> execute(ClientPlayerEntity player) {
+        List<Action> actions = new ArrayList<>();
+
         BlockHitResult hitResult = new BlockHitResult(Vec3d.ofCenter(state.blockPos), Direction.UP, state.blockPos, false);
-        ItemStack itemStack = getRequiredItem(player).orElse(ItemStack.EMPTY);
-        PrinterPlacementContext ctx = new PrinterPlacementContext(player, hitResult, itemStack, getSlotWithItem(player, itemStack));
+        ItemStack requiredItem = getRequiredItem(player).orElse(ItemStack.EMPTY);
+        int requiredSlot = getRequiredItemStackSlot(player);
+
+        if (requiredSlot == -1) return actions;
+
+        PrinterPlacementContext ctx = new PrinterPlacementContext(player, hitResult, requiredItem, requiredSlot);
 
-        List<Action> actions = new ArrayList<>();
         actions.add(new ReleaseShiftAction());
         actions.add(new PrepareAction(ctx));
         actions.add(new InteractActionImpl(ctx));

v1_19_3/src/main/java/me/aleksilassila/litematica/printer/v1_19_3/guides/interaction/LightCandleGuide.java

@@ -0,0 +1,36 @@
+package me.aleksilassila.litematica.printer.v1_19_3.guides.interaction;
+
+import me.aleksilassila.litematica.printer.v1_19_3.SchematicBlockState;
+import net.minecraft.block.AbstractCandleBlock;
+import net.minecraft.client.network.ClientPlayerEntity;
+import net.minecraft.item.ItemStack;
+import net.minecraft.item.Items;
+import net.minecraft.state.property.Properties;
+import org.jetbrains.annotations.NotNull;
+
+import java.util.Collections;
+import java.util.List;
+
+public class LightCandleGuide extends InteractionGuide {
+    boolean shouldBeLit;
+    boolean isLit;
+
+    public LightCandleGuide(SchematicBlockState state) {
+        super(state);
+
+        shouldBeLit = getProperty(targetState, Properties.LIT).orElse(false);
+        isLit = getProperty(currentState, Properties.LIT).orElse(false);
+    }
+
+    @Override
+    protected @NotNull List<ItemStack> getRequiredItems() {
+        return Collections.singletonList(new ItemStack(Items.FLINT_AND_STEEL));
+    }
+
+    @Override
+    public boolean canExecute(ClientPlayerEntity player) {
+        if (!super.canExecute(player)) return false;
+
+        return (currentState.getBlock() instanceof AbstractCandleBlock) && shouldBeLit && !isLit;
+    }
+}

v1_19_3/src/main/java/me/aleksilassila/litematica/printer/v1_19_3/guides/placement/BlockReplacementGuide.java

@@ -23,20 +23,15 @@ public class BlockReplacementGuide extends PlacementGuide {
     private static final HashMap<IntProperty, Item> increasingProperties = new HashMap<>();
 
     static {
-        addProperties();
+        increasingProperties.put(SnowBlock.LAYERS, null);
+        increasingProperties.put(SeaPickleBlock.PICKLES, null);
+        increasingProperties.put(CandleBlock.CANDLES, null);
     }
 
     private Integer currentLevel = null;
     private Integer targetLevel = null;
     private IntProperty increasingProperty = null;
 
-    protected static void addProperties() {
-        increasingProperties.put(SnowBlock.LAYERS, null);
-        increasingProperties.put(SeaPickleBlock.PICKLES, null);
-        increasingProperties.put(CandleBlock.CANDLES, null);
-//            increasingProperties.put(LeveledCauldronBlock.LEVEL, Items.GLASS_BOTTLE);
-    }
-
     public BlockReplacementGuide(SchematicBlockState state) {
         super(state);
 
@@ -58,10 +53,11 @@ protected boolean getUseShift(SchematicBlockState state) {
     @Override
     public @Nullable PrinterPlacementContext getPlacementContext(ClientPlayerEntity player) {
         Optional<ItemStack> requiredItem = getRequiredItem(player);
-        if (requiredItem.isEmpty()) return null;
+        int slot = getRequiredItemStackSlot(player);
+        if (requiredItem.isEmpty() || slot == -1) return null;
 
         BlockHitResult hitResult = new BlockHitResult(Vec3d.ofCenter(state.blockPos), Direction.UP, state.blockPos, false);
-        return new PrinterPlacementContext(player, hitResult, requiredItem.get(), getSlotWithItem(player, requiredItem.get()));
+        return new PrinterPlacementContext(player, hitResult, requiredItem.get(), slot);
     }
 
     @Override
@@ -71,7 +67,7 @@ public boolean canExecute(ClientPlayerEntity player) {
         }
 
         if (currentLevel == null || targetLevel == null || increasingProperty == null) return false;
-        if (!statesEqualIgnoreProperties(currentState, targetState, increasingProperty)) return false;
+        if (!statesEqualIgnoreProperties(currentState, targetState, CandleBlock.LIT, increasingProperty)) return false;
         if (currentLevel >= targetLevel) return false;
 
         return super.canExecute(player);

v1_19_3/src/main/java/me/aleksilassila/litematica/printer/v1_19_3/guides/placement/GeneralPlacementGuide.java

@@ -101,15 +101,16 @@ public PrinterPlacementContext getPlacementContext(ClientPlayerEntity player) {
             Optional<Direction> validSide = getValidSide(state);
             Optional<Vec3d> hitVec = getHitVector(state);
             Optional<ItemStack> requiredItem = getRequiredItem(player);
+            int requiredSlot = getRequiredItemStackSlot(player);
 
-            if (validSide.isEmpty() || hitVec.isEmpty() || requiredItem.isEmpty()) return null;
+            if (validSide.isEmpty() || hitVec.isEmpty() || requiredItem.isEmpty() || requiredSlot == -1) return null;
 
             Optional<Direction> lookDirection = getLookDirection();
             boolean requiresShift = getUseShift(state);
 
             BlockHitResult blockHitResult = new BlockHitResult(hitVec.get(), validSide.get().getOpposite(), state.blockPos.offset(validSide.get()), false);
 
-            return new PrinterPlacementContext(player, blockHitResult, requiredItem.get(), getSlotWithItem(player, requiredItem.get()), lookDirection.orElse(null), requiresShift);
+            return new PrinterPlacementContext(player, blockHitResult, requiredItem.get(), requiredSlot, lookDirection.orElse(null), requiresShift);
         } catch (Exception e) {
             e.printStackTrace();
             return null;

v1_19_3/src/main/java/me/aleksilassila/litematica/printer/v1_19_3/guides/placement/GuesserGuide.java

@@ -52,6 +52,9 @@ public PrinterPlacementContext getPlacementContext(ClientPlayerEntity player) {
         if (contextCache != null && !LitematicaMixinMod.DEBUG) return contextCache;
 
         ItemStack requiredItem = getRequiredItem(player).orElse(ItemStack.EMPTY);
+        int slot = getRequiredItemStackSlot(player);
+
+        if (slot == -1) return null;
 
         for (Direction lookDirection : directionsToTry) {
             for (Direction side : directionsToTry) {
@@ -71,10 +74,10 @@ public PrinterPlacementContext getPlacementContext(ClientPlayerEntity player) {
                     multiplier = new Vec3d(multiplier.x == 0 ? 1 : 0, multiplier.y == 0 ? 1 : 0, multiplier.z == 0 ? 1 : 0);
 
                     BlockHitResult hitResult = new BlockHitResult(hitVec.add(hitVecToTry.multiply(multiplier)), side.getOpposite(), neighborPos, false);
-                    PrinterPlacementContext context = new PrinterPlacementContext(player, hitResult, requiredItem, getSlotWithItem(player, requiredItem), lookDirection, requiresShift);
+                    PrinterPlacementContext context = new PrinterPlacementContext(player, hitResult, requiredItem, slot, lookDirection, requiresShift);
                     BlockState result = getRequiredItemAsBlock(player)
                             .orElse(targetState.getBlock())
-                            .getPlacementState(context);
+                            .getPlacementState(context); // FIXME torch shift clicks another torch and getPlacementState is the clicked block, which is true
 
                     if (result != null && (statesEqual(result, targetState) || correctChestPlacement(targetState, result))) {
                         contextCache = context;

v1_19_3/src/main/java/me/aleksilassila/litematica/printer/v1_19_3/guides/placement/PlacementGuide.java

@@ -90,12 +90,11 @@ && getProperty(state.currentState, FluidBlock.LEVEL).orElse(1) == 0)
     }
 
     @Override
-    public List<Action> execute(ClientPlayerEntity player) {
+    public @NotNull List<Action> execute(ClientPlayerEntity player) {
+        List<Action> actions = new ArrayList<>();
         PrinterPlacementContext ctx = getPlacementContext(player);
 
-        if (ctx == null) return null;
-
-        List<Action> actions = new ArrayList<>();
+        if (ctx == null) return actions;
         actions.add(new PrepareAction(ctx));
         actions.add(new InteractActionImpl(ctx));
         if (ctx.shouldSneak) actions.add(new ReleaseShiftAction());

v1_19_3/src/main/java/me/aleksilassila/litematica/printer/v1_19_3/guides/placement/PropertySpecificGuesserGuide.java

@@ -36,6 +36,9 @@ public class PropertySpecificGuesserGuide extends GuesserGuide {
             LeavesBlock.DISTANCE,
             LeavesBlock.PERSISTENT,
             Properties.ATTACHED,
+            Properties.NOTE,
+            Properties.INSTRUMENT,
+
     };
 
     public PropertySpecificGuesserGuide(SchematicBlockState state) {