refactor: remove ResourceType system and reuse PlatformStorageChannel…

…Type We'll need to do this to make filtering behavior consistent with grid behavior.
refinedmods · Jan 30, 2023 · 05b9ec7 · 05b9ec7
1 parent 0a5926a
commit 05b9ec7
Show file tree

Hide file tree

Showing 70 changed files with 673 additions and 1,073 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -15,9 +15,11 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 -   Ported to Minecraft 1.19.3.
 -   The regular Grid now shows fluids as well.
--   You can insert fluids in the Grid by right-clicking a fluid container item in the Grid slots.
--   You can no longer insert fluids straight from the player slots, you have to insert the fluid while holding the
-    fluid container item.
+-   You can insert fluids in the Grid by right-clicking a fluid container in the Grid slots.
+-   You no longer have to explicitly select a resource type for the filter configuration slots. You can set a fluid
+    by right-clicking a fluid container in the filter slots.
+-   You can no longer insert fluids into the Grid or filter slots straight from the player inventory slots, you have to
+    insert the fluid while holding the fluid container.
 
 ### Removed
 

diff --git a/...-platform-api/src/main/java/com/refinedmods/refinedstorage2/platform/api/PlatformApi.java b/...-platform-api/src/main/java/com/refinedmods/refinedstorage2/platform/api/PlatformApi.java
@@ -20,7 +20,7 @@
 import com.refinedmods.refinedstorage2.platform.api.network.node.externalstorage.PlatformExternalStorageProviderFactory;
 import com.refinedmods.refinedstorage2.platform.api.network.node.importer.ImporterTransferStrategyFactory;
 import com.refinedmods.refinedstorage2.platform.api.resource.ItemResource;
-import com.refinedmods.refinedstorage2.platform.api.resource.filter.ResourceType;
+import com.refinedmods.refinedstorage2.platform.api.resource.filter.FilteredResourceFactory;
 import com.refinedmods.refinedstorage2.platform.api.storage.StorageRepository;
 import com.refinedmods.refinedstorage2.platform.api.storage.channel.PlatformStorageChannelType;
 import com.refinedmods.refinedstorage2.platform.api.storage.type.StorageType;
@@ -61,8 +61,6 @@ <T> Set<PlatformExternalStorageProviderFactory> getExternalStorageProviderFactor
 
     MutableComponent createTranslation(String category, String value, Object... args);
 
-    OrderedRegistry<ResourceLocation, ResourceType> getResourceTypeRegistry();
-
     ComponentMapFactory<NetworkComponent, Network> getNetworkComponentMapFactory();
 
     OrderedRegistry<ResourceLocation, GridSynchronizer> getGridSynchronizerRegistry();
@@ -93,4 +91,8 @@ GridScrollingStrategy createGridScrollingStrategy(AbstractContainerMenu containe
                                                       GridServiceFactory gridServiceFactory);
 
     void addGridScrollingStrategyFactory(GridScrollingStrategyFactory scrollingStrategyFactory);
+
+    void addFilteredResourceFactory(FilteredResourceFactory factory);
+
+    FilteredResourceFactory getFilteredResourceFactory();
 }
diff --git a/...form-api/src/main/java/com/refinedmods/refinedstorage2/platform/api/PlatformApiProxy.java b/...form-api/src/main/java/com/refinedmods/refinedstorage2/platform/api/PlatformApiProxy.java
@@ -20,7 +20,7 @@
 import com.refinedmods.refinedstorage2.platform.api.network.node.externalstorage.PlatformExternalStorageProviderFactory;
 import com.refinedmods.refinedstorage2.platform.api.network.node.importer.ImporterTransferStrategyFactory;
 import com.refinedmods.refinedstorage2.platform.api.resource.ItemResource;
-import com.refinedmods.refinedstorage2.platform.api.resource.filter.ResourceType;
+import com.refinedmods.refinedstorage2.platform.api.resource.filter.FilteredResourceFactory;
 import com.refinedmods.refinedstorage2.platform.api.storage.StorageRepository;
 import com.refinedmods.refinedstorage2.platform.api.storage.channel.PlatformStorageChannelType;
 import com.refinedmods.refinedstorage2.platform.api.storage.type.StorageType;
@@ -95,11 +95,6 @@ public MutableComponent createTranslation(final String category, final String va
         return ensureLoaded().createTranslation(category, value, args);
     }
 
-    @Override
-    public OrderedRegistry<ResourceLocation, ResourceType> getResourceTypeRegistry() {
-        return ensureLoaded().getResourceTypeRegistry();
-    }
-
     @Override
     public ComponentMapFactory<NetworkComponent, Network> getNetworkComponentMapFactory() {
         return ensureLoaded().getNetworkComponentMapFactory();
@@ -175,6 +170,16 @@ public void addGridScrollingStrategyFactory(final GridScrollingStrategyFactory s
         ensureLoaded().addGridScrollingStrategyFactory(scrollingStrategyFactory);
     }
 
+    @Override
+    public void addFilteredResourceFactory(final FilteredResourceFactory factory) {
+        ensureLoaded().addFilteredResourceFactory(factory);
+    }
+
+    @Override
+    public FilteredResourceFactory getFilteredResourceFactory() {
+        return ensureLoaded().getFilteredResourceFactory();
+    }
+
     private PlatformApi ensureLoaded() {
         if (delegate == null) {
             throw new IllegalStateException("Platform API not loaded yet");

diff --git a/...src/main/java/com/refinedmods/refinedstorage2/platform/api/grid/PlatformGridResource.java b/...src/main/java/com/refinedmods/refinedstorage2/platform/api/grid/PlatformGridResource.java
@@ -18,7 +18,7 @@ void onExtract(GridExtractMode extractMode,
     void onScroll(GridScrollMode scrollMode,
                   GridScrollingStrategy scrollingStrategy);
 
-    void render(PoseStack poseStack, int slotX, int slotY);
+    void render(PoseStack poseStack, int x, int y);
 
     String getDisplayedAmount();
 

diff --git a/...n/java/com/refinedmods/refinedstorage2/platform/api/resource/filter/FilteredResource.java b/...n/java/com/refinedmods/refinedstorage2/platform/api/resource/filter/FilteredResource.java
@@ -1,34 +1,28 @@
 package com.refinedmods.refinedstorage2.platform.api.resource.filter;
 
+import com.refinedmods.refinedstorage2.platform.api.storage.channel.PlatformStorageChannelType;
+
 import java.util.List;
-import javax.annotation.Nullable;
 
 import com.mojang.blaze3d.vertex.PoseStack;
-import net.minecraft.nbt.CompoundTag;
-import net.minecraft.network.FriendlyByteBuf;
 import net.minecraft.network.chat.Component;
-import net.minecraft.world.entity.player.Player;
 import org.apiguardian.api.API;
 
 @API(status = API.Status.STABLE, since = "2.0.0-milestone.2.0")
-public interface FilteredResource {
-    void writeToPacket(FriendlyByteBuf buf);
-
-    CompoundTag toTag();
-
+public interface FilteredResource<T> {
     void render(PoseStack poseStack, int x, int y, int z);
 
-    Object getValue();
+    T getValue();
 
-    long getAmount();
+    FilteredResource<T> withAmount(long newAmount);
 
-    FilteredResource withAmount(long newAmount);
+    long getAmount();
 
     long getMaxAmount();
 
-    String getFormattedAmount();
+    String getDisplayedAmount();
 
-    ResourceType getType();
+    List<Component> getTooltip();
 
-    List<Component> getTooltipLines(@Nullable Player player);
+    PlatformStorageChannelType<T> getStorageChannelType();
 }
diff --git a/...com/refinedmods/refinedstorage2/platform/api/resource/filter/FilteredResourceFactory.java b/...com/refinedmods/refinedstorage2/platform/api/resource/filter/FilteredResourceFactory.java
@@ -0,0 +1,11 @@
+package com.refinedmods.refinedstorage2.platform.api.resource.filter;
+
+import java.util.Optional;
+
+import net.minecraft.world.item.ItemStack;
+import org.apiguardian.api.API;
+
+@API(status = API.Status.STABLE, since = "2.0.0-milestone.2.6")
+public interface FilteredResourceFactory {
+    Optional<FilteredResource<?>> create(ItemStack stack, boolean tryAlternatives);
+}
diff --git a/.../main/java/com/refinedmods/refinedstorage2/platform/api/resource/filter/ResourceType.java b/.../main/java/com/refinedmods/refinedstorage2/platform/api/resource/filter/ResourceType.java
diff --git a/...mods/refinedstorage2/platform/api/storage/channel/AbstractPlatformStorageChannelType.java b/...mods/refinedstorage2/platform/api/storage/channel/AbstractPlatformStorageChannelType.java
@@ -5,7 +5,6 @@
 import com.refinedmods.refinedstorage2.api.storage.channel.StorageChannelType;
 import com.refinedmods.refinedstorage2.api.storage.tracked.TrackedResource;
 
-import java.util.Optional;
 import java.util.function.BiConsumer;
 
 import net.minecraft.nbt.CompoundTag;
@@ -47,8 +46,6 @@ public CompoundTag toTag(final T resource, final TrackedResource trackedResource
         return tag;
     }
 
-    protected abstract CompoundTag toTag(T resource);
-
     @Override
     public void fromTag(final CompoundTag tag, final BiConsumer<T, TrackedResource> acceptor) {
         fromTag(tag).ifPresent(resource -> {
@@ -58,8 +55,6 @@ public void fromTag(final CompoundTag tag, final BiConsumer<T, TrackedResource>
         });
     }
 
-    protected abstract Optional<T> fromTag(CompoundTag tag);
-
     @Override
     public StorageChannel<T> create() {
         return delegate.create();

diff --git a/.../refinedmods/refinedstorage2/platform/api/storage/channel/PlatformStorageChannelType.java b/.../refinedmods/refinedstorage2/platform/api/storage/channel/PlatformStorageChannelType.java
@@ -4,6 +4,7 @@
 import com.refinedmods.refinedstorage2.api.resource.ResourceAmount;
 import com.refinedmods.refinedstorage2.api.storage.channel.StorageChannelType;
 import com.refinedmods.refinedstorage2.api.storage.tracked.TrackedResource;
+import com.refinedmods.refinedstorage2.platform.api.resource.filter.FilteredResource;
 
 import java.util.Optional;
 import java.util.function.BiConsumer;
@@ -16,16 +17,22 @@
 
 @API(status = API.Status.STABLE, since = "2.0.0-milestone.2.5")
 public interface PlatformStorageChannelType<T> extends StorageChannelType<T> {
+    CompoundTag toTag(T resource);
+
     CompoundTag toTag(T resource, TrackedResource trackedResource);
 
     void fromTag(CompoundTag tag, BiConsumer<T, TrackedResource> acceptor);
 
+    Optional<T> fromTag(CompoundTag tag);
+
     void toBuffer(T resource, FriendlyByteBuf buf);
 
     T fromBuffer(FriendlyByteBuf buf);
 
     Optional<GridResource> toGridResource(ResourceAmount<?> resourceAmount);
 
+    Optional<FilteredResource<T>> toFilteredResource(ResourceAmount<?> resourceAmount);
+
     boolean isGridResourceBelonging(GridResource gridResource);
 
     MutableComponent getTitle();

diff --git a/...src/main/java/com/refinedmods/refinedstorage2/platform/common/AbstractModInitializer.java b/...src/main/java/com/refinedmods/refinedstorage2/platform/common/AbstractModInitializer.java
@@ -7,7 +7,7 @@
 import com.refinedmods.refinedstorage2.api.network.impl.component.StorageNetworkComponentImpl;
 import com.refinedmods.refinedstorage2.platform.api.PlatformApi;
 import com.refinedmods.refinedstorage2.platform.api.PlatformApiProxy;
-import com.refinedmods.refinedstorage2.platform.common.internal.resource.filter.fluid.FluidResourceType;
+import com.refinedmods.refinedstorage2.platform.common.internal.resource.filter.fluid.FluidFilteredResourceFactory;
 import com.refinedmods.refinedstorage2.platform.common.internal.storage.channel.StorageChannelTypes;
 import com.refinedmods.refinedstorage2.platform.common.internal.storage.type.FluidStorageType;
 import com.refinedmods.refinedstorage2.platform.common.internal.upgrade.UpgradeDestinations;
@@ -43,6 +43,10 @@ protected void registerAdditionalStorageChannelTypes() {
         );
     }
 
+    protected void registerAdditionalFilteredResourceFactories() {
+        PlatformApi.INSTANCE.addFilteredResourceFactory(new FluidFilteredResourceFactory());
+    }
+
     protected void registerNetworkComponents() {
         PlatformApi.INSTANCE.getNetworkComponentMapFactory().addFactory(
             EnergyNetworkComponent.class,
@@ -58,13 +62,6 @@ protected void registerNetworkComponents() {
         );
     }
 
-    protected void registerAdditionalResourceTypes() {
-        PlatformApi.INSTANCE.getResourceTypeRegistry().register(
-            createIdentifier(FLUID_REGISTRY_KEY),
-            FluidResourceType.INSTANCE
-        );
-    }
-
     protected void addApplicableUpgrades(final Supplier<Item> speedUpgrade,
                                          final Supplier<Item> stackUpgrade) {
         PlatformApi.INSTANCE.getUpgradeRegistry().addApplicableUpgrade(

diff --git a/...common/src/main/java/com/refinedmods/refinedstorage2/platform/common/PlatformApiImpl.java b/...common/src/main/java/com/refinedmods/refinedstorage2/platform/common/PlatformApiImpl.java
@@ -26,7 +26,7 @@
 import com.refinedmods.refinedstorage2.platform.api.network.node.externalstorage.PlatformExternalStorageProviderFactory;
 import com.refinedmods.refinedstorage2.platform.api.network.node.importer.ImporterTransferStrategyFactory;
 import com.refinedmods.refinedstorage2.platform.api.resource.ItemResource;
-import com.refinedmods.refinedstorage2.platform.api.resource.filter.ResourceType;
+import com.refinedmods.refinedstorage2.platform.api.resource.filter.FilteredResourceFactory;
 import com.refinedmods.refinedstorage2.platform.api.storage.StorageRepository;
 import com.refinedmods.refinedstorage2.platform.api.storage.channel.PlatformStorageChannelType;
 import com.refinedmods.refinedstorage2.platform.api.storage.type.StorageType;
@@ -38,7 +38,8 @@
 import com.refinedmods.refinedstorage2.platform.common.internal.grid.PlatformGridServiceFactoryImpl;
 import com.refinedmods.refinedstorage2.platform.common.internal.item.StorageContainerHelperImpl;
 import com.refinedmods.refinedstorage2.platform.common.internal.network.LevelConnectionProvider;
-import com.refinedmods.refinedstorage2.platform.common.internal.resource.filter.item.ItemResourceType;
+import com.refinedmods.refinedstorage2.platform.common.internal.resource.filter.CompositeFilteredResourceFactory;
+import com.refinedmods.refinedstorage2.platform.common.internal.resource.filter.item.ItemFilteredResourceFactory;
 import com.refinedmods.refinedstorage2.platform.common.internal.storage.ClientStorageRepository;
 import com.refinedmods.refinedstorage2.platform.common.internal.storage.StorageRepositoryImpl;
 import com.refinedmods.refinedstorage2.platform.common.internal.storage.channel.StorageChannelTypes;
@@ -72,8 +73,6 @@ public class PlatformApiImpl implements PlatformApi {
 
     private final StorageRepository clientStorageRepository =
         new ClientStorageRepository(Platform.INSTANCE.getClientToServerCommunications()::sendStorageInfoRequest);
-    private final OrderedRegistry<ResourceLocation, ResourceType> resourceTypeRegistry =
-        new OrderedRegistryImpl<>(createIdentifier(ITEM_REGISTRY_KEY), ItemResourceType.INSTANCE);
     private final ComponentMapFactory<NetworkComponent, Network> networkComponentMapFactory =
         new ComponentMapFactory<>();
     private final NetworkBuilder networkBuilder =
@@ -97,6 +96,9 @@ public class PlatformApiImpl implements PlatformApi {
     private final List<GridInsertionStrategyFactory> gridInsertionStrategyFactories = new ArrayList<>();
     private final List<GridExtractionStrategyFactory> gridExtractionStrategyFactories = new ArrayList<>();
     private final List<GridScrollingStrategyFactory> gridScrollingStrategyFactories = new ArrayList<>();
+    private final CompositeFilteredResourceFactory filteredResourceFactory = new CompositeFilteredResourceFactory(
+        new ItemFilteredResourceFactory()
+    );
 
     @Override
     public OrderedRegistry<ResourceLocation, StorageType<?>> getStorageTypeRegistry() {
@@ -173,11 +175,6 @@ public MutableComponent createTranslation(final String category, final String va
         return IdentifierUtil.createTranslation(category, value, args);
     }
 
-    @Override
-    public OrderedRegistry<ResourceLocation, ResourceType> getResourceTypeRegistry() {
-        return resourceTypeRegistry;
-    }
-
     @Override
     public ComponentMapFactory<NetworkComponent, Network> getNetworkComponentMapFactory() {
         return networkComponentMapFactory;
@@ -281,4 +278,14 @@ public GridScrollingStrategy createGridScrollingStrategy(final AbstractContainer
     public void addGridScrollingStrategyFactory(final GridScrollingStrategyFactory scrollingStrategyFactory) {
         gridScrollingStrategyFactories.add(scrollingStrategyFactory);
     }
+
+    @Override
+    public void addFilteredResourceFactory(final FilteredResourceFactory factory) {
+        filteredResourceFactory.addAlternativeFactory(factory);
+    }
+
+    @Override
+    public FilteredResourceFactory getFilteredResourceFactory() {
+        return filteredResourceFactory;
+    }
 }
diff --git a/...ava/com/refinedmods/refinedstorage2/platform/common/block/entity/FilterWithFuzzyMode.java b/...ava/com/refinedmods/refinedstorage2/platform/common/block/entity/FilterWithFuzzyMode.java
@@ -1,8 +1,7 @@
 package com.refinedmods.refinedstorage2.platform.common.block.entity;
 
-import com.refinedmods.refinedstorage2.platform.api.PlatformApi;
 import com.refinedmods.refinedstorage2.platform.api.resource.FuzzyModeNormalizer;
-import com.refinedmods.refinedstorage2.platform.api.resource.filter.ResourceType;
+import com.refinedmods.refinedstorage2.platform.api.storage.channel.PlatformStorageChannelType;
 import com.refinedmods.refinedstorage2.platform.common.internal.resource.filter.FilteredResourceFilterContainer;
 import com.refinedmods.refinedstorage2.platform.common.internal.resource.filter.ResourceFilterContainer;
 
@@ -24,32 +23,30 @@ public final class FilterWithFuzzyMode {
 
     private boolean fuzzyMode;
 
-    public FilterWithFuzzyMode(final ResourceType resourceType,
+    public FilterWithFuzzyMode(final PlatformStorageChannelType<?> storageChannelType,
                                final Runnable listener,
                                final Consumer<Set<Object>> templatesAcceptor,
                                final Consumer<List<Object>> orderedTemplatesAcceptor) {
         this.filterContainer = new FilteredResourceFilterContainer(
-            PlatformApi.INSTANCE.getResourceTypeRegistry(),
             9,
             this::filterContainerChanged,
-            resourceType
+            storageChannelType
         );
         this.listener = listener;
         this.templatesAcceptor = templatesAcceptor;
         this.orderedTemplatesAcceptor = orderedTemplatesAcceptor;
     }
 
-    public FilterWithFuzzyMode(final ResourceType resourceType,
+    public FilterWithFuzzyMode(final PlatformStorageChannelType<?> storageChannelType,
                                final Runnable listener,
                                final Consumer<Set<Object>> templatesAcceptor,
                                final Consumer<List<Object>> orderedTemplatesAcceptor,
                                final int size,
                                final long maxAmount) {
         this.filterContainer = new FilteredResourceFilterContainer(
-            PlatformApi.INSTANCE.getResourceTypeRegistry(),
             size,
             this::filterContainerChanged,
-            resourceType,
+            storageChannelType,
             maxAmount
         );
         this.listener = listener;
@@ -60,11 +57,7 @@ public FilterWithFuzzyMode(final ResourceType resourceType,
     public FilterWithFuzzyMode(final Runnable listener,
                                final Consumer<Set<Object>> templatesAcceptor,
                                final Consumer<List<Object>> orderedTemplatesAcceptor) {
-        this.filterContainer = new ResourceFilterContainer(
-            PlatformApi.INSTANCE.getResourceTypeRegistry(),
-            9,
-            this::filterContainerChanged
-        );
+        this.filterContainer = new ResourceFilterContainer(9, this::filterContainerChanged);
         this.listener = listener;
         this.templatesAcceptor = templatesAcceptor;
         this.orderedTemplatesAcceptor = orderedTemplatesAcceptor;
@@ -91,7 +84,7 @@ public void setFuzzyMode(final boolean fuzzyMode) {
 
     public void load(final CompoundTag tag) {
         if (tag.contains(TAG_RESOURCE_FILTER)) {
-            filterContainer.load(tag.getCompound(TAG_RESOURCE_FILTER));
+            filterContainer.fromTag(tag.getCompound(TAG_RESOURCE_FILTER));
         }
         if (tag.contains(TAG_FUZZY_MODE)) {
             fuzzyMode = tag.getBoolean(TAG_FUZZY_MODE);