feat: expose current previewed multiblock to API

common/src/main/java/com/klikli_dev/modonomicon/api/ModonomiconAPI.java

@@ -10,9 +10,14 @@
 import com.klikli_dev.modonomicon.api.datagen.BookContextHelper;
 import com.klikli_dev.modonomicon.api.datagen.CategoryEntryMap;
 import com.klikli_dev.modonomicon.api.multiblock.Multiblock;
+import com.klikli_dev.modonomicon.api.multiblock.MultiblockPreviewData;
 import com.klikli_dev.modonomicon.api.stub.ModonomiconAPIStub;
+import net.minecraft.core.BlockPos;
 import net.minecraft.resources.ResourceLocation;
+import net.minecraft.world.level.Level;
+import net.minecraft.world.level.block.Rotation;
 import org.apache.logging.log4j.LogManager;
+import org.jetbrains.annotations.Nullable;
 
 import java.util.function.Supplier;
 
@@ -44,6 +49,15 @@ static ModonomiconAPI get() {
 
     Multiblock getMultiblock(ResourceLocation id);
 
+    /**
+     * Gets the multiblock currently previewed by the player, or null if none.
+     * Make sure to check for isAnchored(), a non-anchored multiblock can move any tick if the player looks around.
+     * Use {@link Multiblock#simulate(Level, BlockPos, Rotation, boolean, boolean)} to get the simulation results.
+     * Client side only!
+     */
+    @Nullable
+    MultiblockPreviewData getCurrentPreviewMultiblock();
+
     class Helper {
         private static final Supplier<ModonomiconAPI> lazyInstance = Suppliers.memoize(() -> {
             try {

common/src/main/java/com/klikli_dev/modonomicon/api/multiblock/MultiblockPreviewData.java

@@ -0,0 +1,7 @@
+package com.klikli_dev.modonomicon.api.multiblock;
+
+import net.minecraft.core.BlockPos;
+import net.minecraft.world.level.block.Rotation;
+
+public record MultiblockPreviewData(Multiblock multiblock, BlockPos anchor, Rotation facing, boolean isAnchored) {
+}

common/src/main/java/com/klikli_dev/modonomicon/api/stub/ModonomiconAPIStub.java

@@ -11,7 +11,9 @@
 import com.klikli_dev.modonomicon.api.datagen.BookContextHelper;
 import com.klikli_dev.modonomicon.api.datagen.CategoryEntryMap;
 import com.klikli_dev.modonomicon.api.multiblock.Multiblock;
+import com.klikli_dev.modonomicon.api.multiblock.MultiblockPreviewData;
 import net.minecraft.resources.ResourceLocation;
+import org.jetbrains.annotations.Nullable;
 
 public class ModonomiconAPIStub implements ModonomiconAPI {
     private static final ModonomiconAPIStub instance = new ModonomiconAPIStub();
@@ -42,4 +44,9 @@ public CategoryEntryMap getEntryMap() {
     public Multiblock getMultiblock(ResourceLocation id) {
         return null;
     }
+
+    @Override
+    public @Nullable MultiblockPreviewData getCurrentPreviewMultiblock() {
+        return null;
+    }
 }

common/src/main/java/com/klikli_dev/modonomicon/apiimpl/ModonomiconAPIImpl.java

@@ -10,8 +10,11 @@
 import com.klikli_dev.modonomicon.api.datagen.BookContextHelper;
 import com.klikli_dev.modonomicon.api.datagen.CategoryEntryMap;
 import com.klikli_dev.modonomicon.api.multiblock.Multiblock;
+import com.klikli_dev.modonomicon.api.multiblock.MultiblockPreviewData;
+import com.klikli_dev.modonomicon.client.render.MultiblockPreviewRenderer;
 import com.klikli_dev.modonomicon.data.MultiblockDataManager;
 import net.minecraft.resources.ResourceLocation;
+import org.jetbrains.annotations.Nullable;
 
 public class ModonomiconAPIImpl implements ModonomiconAPI {
     public boolean isStub() {
@@ -32,4 +35,9 @@ public CategoryEntryMap getEntryMap() {
     public Multiblock getMultiblock(ResourceLocation id) {
         return MultiblockDataManager.get().getMultiblock(id);
     }
+
+    @Override
+    public @Nullable MultiblockPreviewData getCurrentPreviewMultiblock() {
+        return MultiblockPreviewRenderer.getMultiblockPreviewData();
+    }
 }

common/src/main/java/com/klikli_dev/modonomicon/client/render/MultiblockPreviewRenderer.java

@@ -11,6 +11,7 @@
 import com.klikli_dev.modonomicon.api.ModonomiconAPI;
 import com.klikli_dev.modonomicon.api.ModonomiconConstants;
 import com.klikli_dev.modonomicon.api.multiblock.Multiblock;
+import com.klikli_dev.modonomicon.api.multiblock.MultiblockPreviewData;
 import com.klikli_dev.modonomicon.client.ClientTicks;
 import com.klikli_dev.modonomicon.multiblock.AbstractMultiblock;
 import com.klikli_dev.modonomicon.multiblock.matcher.DisplayOnlyMatcher;
@@ -50,6 +51,7 @@
 import net.minecraft.world.level.block.entity.BlockEntity;
 import net.minecraft.world.level.block.state.BlockState;
 import net.minecraft.world.phys.BlockHitResult;
+import org.jetbrains.annotations.Nullable;
 import org.joml.Matrix4f;
 
 import java.awt.*;
@@ -58,10 +60,9 @@
 
 public class MultiblockPreviewRenderer {
 
-    public static boolean hasMultiblock;
-
     private static final Map<BlockPos, BlockEntity> blockEntityCache = new Object2ObjectOpenHashMap<>();
     private static final Set<BlockEntity> erroredBlockEntities = Collections.newSetFromMap(new WeakHashMap<>());
+    public static boolean hasMultiblock;
     private static Multiblock multiblock;
     private static Component name;
     private static BlockPos pos;
@@ -337,6 +338,14 @@ public static void renderBlock(Level world, BlockState state, BlockPos pos, Mult
         }
     }
 
+    @Nullable
+    public static MultiblockPreviewData getMultiblockPreviewData() {
+        if (!hasMultiblock) {
+            return null;
+        }
+        return new MultiblockPreviewData(multiblock, pos, facingRotation, isAnchored);
+    }
+
     public static Multiblock getMultiblock() {
         return multiblock;
     }

gradle.properties

@@ -62,7 +62,7 @@ group=com.klikli_dev
 mod_id=modonomicon
 mod_name=Modonomicon
 mod_license=MIT AND CC-BY-4.0
-mod_version=1.105.0
+mod_version=1.106.0
 mod_authors=Kli Kli
 mod_description=Data-driven minecraft in-game documentation with progress visualization.