Lock room upgrades behind a feature flag

Author: robotgryphon

core-api/src/main/java/dev/compactmods/machines/api/CompactMachines.java

@@ -8,7 +8,7 @@
 import dev.compactmods.machines.api.room.template.RoomTemplate;
 import dev.compactmods.machines.api.room.data.IRoomDataAttachmentAccessor;
 import dev.compactmods.machines.api.room.history.IPlayerHistoryApi;
-import dev.compactmods.machines.api.room.upgrade.RoomUpgradeDefinition;
+import dev.compactmods.machines.api.room.upgrade.RoomUpgradeType;
 import dev.compactmods.machines.api.util.BlockSpaceUtil;
 import net.minecraft.core.Direction;
 import net.minecraft.resources.ResourceLocation;
@@ -34,8 +34,8 @@ public static ResourceLocation modRL(String path) {
 		return ResourceLocation.fromNamespaceAndPath(MOD_ID, path);
 	}
 
-	public static DeferredRegister<RoomUpgradeDefinition<?>> roomUpgradeDR(String namespace) {
-		return DeferredRegister.create(RoomUpgradeDefinition.REG_KEY, namespace);
+	public static DeferredRegister<RoomUpgradeType<?>> roomUpgradeDR(String namespace) {
+		return DeferredRegister.create(RoomUpgradeType.REGISTRY_KEY, namespace);
 	}
 
 	public static IRoomApi roomApi() {

core-api/src/main/java/dev/compactmods/machines/api/room/upgrade/RoomUpgrade.java

@@ -1,15 +1,17 @@
 package dev.compactmods.machines.api.room.upgrade;
 
 import dev.compactmods.machines.api.room.upgrade.events.RoomUpgradeEvent;
+import net.minecraft.world.flag.FeatureElement;
+import net.minecraft.world.item.ItemStack;
 import net.minecraft.world.item.component.TooltipProvider;
 
 import java.util.stream.Stream;
 
 public interface RoomUpgrade extends TooltipProvider {
 
-	RoomUpgradeDefinition<?> getType();
+    RoomUpgradeType<?> getType();
 
-   default Stream<RoomUpgradeEvent> gatherEvents() {
-	  return Stream.empty();
-   }
+    default Stream<RoomUpgradeEvent> gatherEvents() {
+        return Stream.empty();
+    }
 }

core-api/src/main/java/dev/compactmods/machines/api/room/upgrade/RoomUpgradeCodecs.java

@@ -10,11 +10,11 @@
 
 public interface RoomUpgradeCodecs {
     Codec<RoomUpgrade> DISPATCH_CODEC = Codec.lazyInitialized(() -> {
-       @SuppressWarnings("unchecked") final var reg = (Registry<RoomUpgradeDefinition<?>>) BuiltInRegistries.REGISTRY.get(CompactMachines.modRL("room_upgrades"));
+       @SuppressWarnings("unchecked") final var reg = (Registry<RoomUpgradeType<?>>) BuiltInRegistries.REGISTRY.get(CompactMachines.modRL("room_upgrades"));
 
        if (reg != null) {
           var upgradeRegistry = reg.byNameCodec();
-          return upgradeRegistry.dispatchStable(RoomUpgrade::getType, RoomUpgradeDefinition::codec);
+          return upgradeRegistry.dispatchStable(RoomUpgrade::getType, RoomUpgradeType::codec);
        }
 
        throw new RuntimeException("Room upgrade registry not registered yet; calling too early?");

core-api/src/main/java/dev/compactmods/machines/api/room/upgrade/RoomUpgradeDefinition.java

@@ -0,0 +1,59 @@
+package dev.compactmods.machines.api.room.upgrade;
+
+import com.mojang.serialization.MapCodec;
+import dev.compactmods.machines.api.CompactMachines;
+import net.minecraft.core.Registry;
+import net.minecraft.resources.ResourceKey;
+import net.minecraft.world.flag.FeatureElement;
+import net.minecraft.world.flag.FeatureFlagSet;
+import net.minecraft.world.flag.FeatureFlags;
+import net.minecraft.world.item.ItemStack;
+
+import java.util.function.Predicate;
+import java.util.function.Supplier;
+
+// TODO: Room Upgrade context (level, itemstack, etc)
+public record RoomUpgradeType<T extends RoomUpgrade>(Supplier<T> constructor,
+                                                     MapCodec<T> codec,
+                                                     FeatureFlagSet requiredFeatures,
+                                                     Predicate<ItemStack> itemstackFilter
+) implements FeatureElement {
+
+    public static final ResourceKey<Registry<RoomUpgradeType<?>>> REGISTRY_KEY = ResourceKey.createRegistryKey(CompactMachines.modRL("room_upgrades"));
+
+    public static <T extends RoomUpgrade> Builder<T> builder(Supplier<T> constructor, MapCodec<T> codec) {
+        return new Builder<>(constructor, codec);
+    }
+
+    public boolean canApplyTo(ItemStack item) {
+        return itemstackFilter == null || itemstackFilter.test(item);
+    }
+
+    public static class Builder<T extends RoomUpgrade> {
+        private final Supplier<T> constructor;
+        private final MapCodec<T> codec;
+        private FeatureFlagSet requiredFeatures;
+        private Predicate<ItemStack> itemPredicate;
+
+        public Builder(Supplier<T> constructor, MapCodec<T> codec) {
+            this.constructor = constructor;
+            this.codec = codec;
+            this.requiredFeatures = FeatureFlags.DEFAULT_FLAGS;
+        }
+
+        public Builder<T> requiredFeatures(FeatureFlagSet featureFlagSet) {
+            this.requiredFeatures = featureFlagSet;
+            return this;
+        }
+
+        public Builder<T> itemPredicate(Predicate<ItemStack> predicate) {
+            this.itemPredicate = predicate;
+            return this;
+        }
+
+        public RoomUpgradeType<T> build() {
+            return new RoomUpgradeType<>(constructor, codec, requiredFeatures, itemPredicate);
+        }
+
+    }
+}

core-api/src/main/java/dev/compactmods/machines/api/room/upgrade/RoomUpgradeType.java

@@ -28,6 +28,15 @@ public static boolean fitsInside(AABB outer, AABB inner) {
         return fitsInside(outer, sizeOf(inner));
     }
 
+    public static Stream<BlockPos> floorCorners(AABB bounds) {
+        Stream.Builder<BlockPos> stream = Stream.builder();
+        stream.add(BlockPos.containing(bounds.maxX - 1, bounds.minY, bounds.maxZ - 1));
+        stream.add(BlockPos.containing(bounds.minX, bounds.minY, bounds.maxZ - 1));
+        stream.add(BlockPos.containing(bounds.maxX - 1, bounds.minY, bounds.minZ));
+        stream.add(BlockPos.containing(bounds.minX, bounds.minY, bounds.minZ));
+        return stream.build();
+    }
+
     public static Vec3 minCorner(AABB aabb) {
         return new Vec3(aabb.minX, aabb.minY, aabb.minZ);
     }

core-api/src/main/java/dev/compactmods/machines/api/util/AABBHelper.java

@@ -8,7 +8,12 @@
 import dev.compactmods.machines.datagen.tags.BlockTagGenerator;
 import dev.compactmods.machines.datagen.tags.ItemTagGenerator;
 import dev.compactmods.machines.datagen.tags.PointOfInterestTagGenerator;
+import dev.compactmods.machines.feature.CMFeatureFlags;
+import net.minecraft.data.DataGenerator;
 import net.minecraft.data.loot.LootTableProvider;
+import net.minecraft.data.metadata.PackMetadataGenerator;
+import net.minecraft.network.chat.Component;
+import net.minecraft.world.flag.FeatureFlagSet;
 import net.minecraft.world.level.storage.loot.parameters.LootContextParamSets;
 import net.neoforged.bus.api.SubscribeEvent;
 import net.neoforged.fml.common.EventBusSubscriber;
@@ -28,6 +33,8 @@ public static void gatherData(GatherDataEvent event) {
         final var packOut = generator.getPackOutput();
         final var holderLookup = event.getLookupProvider();
 
+        addExperimentalPacks(event);
+
         // Server
         boolean server = event.includeServer();
 
@@ -57,4 +64,15 @@ public static void gatherData(GatherDataEvent event) {
 
         generator.addProvider(client, new EnglishLangGenerator(generator));
     }
+
+    private static void addExperimentalPacks(GatherDataEvent event) {
+        final var generator = event.getGenerator();
+
+        DataGenerator.PackGenerator roomUpgrades = generator.getBuiltinDatapack(true, CompactMachines.MOD_ID, "room_upgrades");
+        roomUpgrades.addProvider(output -> PackMetadataGenerator.forFeaturePack(
+                output,
+                Component.literal("Enables the room upgrade experimental features."),
+                FeatureFlagSet.of(CMFeatureFlags.ROOM_UPDATES_FLAG)
+        ));
+    }
 }

neoforge-datagen/src/main/java/dev.compactmods.machines.datagen/DataGeneration.java

@@ -8,6 +8,7 @@
 import dev.compactmods.machines.api.room.RoomTranslations;
 import dev.compactmods.machines.client.keybinds.room.RoomExitKeyMapping;
 import dev.compactmods.machines.client.creative.CreativeTabs;
+import dev.compactmods.machines.client.keybinds.room.RoomUpgradeUIMapping;
 import dev.compactmods.machines.datagen.lang.BaseLangGenerator;
 import dev.compactmods.machines.room.Rooms;
 import dev.compactmods.machines.shrinking.Shrinking;
@@ -67,6 +68,7 @@ protected void addTranslations() {
 
         add(RoomExitKeyMapping.I18n.CATEGORY, "Compact Machines");
         add(RoomExitKeyMapping.I18n.NAME, "Quick-Exit Compact Machine");
+        add(RoomUpgradeUIMapping.NAME, "Open Room Upgrade Screen");
 
         addJade();
     }

neoforge-datagen/src/main/java/dev.compactmods.machines.datagen/lang/EnglishLangGenerator.java

@@ -2,7 +2,6 @@
 
 import dev.compactmods.machines.api.room.template.RoomTemplate;
 import dev.compactmods.machines.api.CompactMachines;
-import dev.compactmods.machines.api.room.upgrade.RoomUpgradeDefinition;
 import dev.compactmods.machines.shrinking.Shrinking;
 import net.minecraft.commands.synchronization.ArgumentTypeInfo;
 import net.minecraft.core.registries.BuiltInRegistries;

neoforge-main/src/main/java/dev/compactmods/machines/CMRegistries.java

@@ -3,6 +3,7 @@
 import dev.compactmods.machines.api.CompactMachines;
 import dev.compactmods.machines.command.Commands;
 import dev.compactmods.machines.compat.InterModCompat;
+import dev.compactmods.machines.feature.CMFeaturePacks;
 import dev.compactmods.machines.server.ServerConfig;
 import dev.compactmods.machines.dimension.Dimension;
 import dev.compactmods.machines.dimension.WorldBorderFixer;
@@ -54,6 +55,7 @@ private static void registerEvents(IEventBus modBus) {
         RoomUpgrades.registerEvents(modBus);
         WorldBorderFixer.registerEvents();
 
+        modBus.addListener(CMFeaturePacks::addFeaturePacks);
         modBus.addListener(CMNetworks::onPacketRegistration);
         modBus.addListener(InterModCompat::enqueueCompatMessages);