aboutsummaryrefslogtreecommitdiff
path: root/src/main/java/gregtech/api/interfaces/fluid/IGTRegisteredFluid.java
diff options
context:
space:
mode:
Diffstat (limited to 'src/main/java/gregtech/api/interfaces/fluid/IGTRegisteredFluid.java')
-rw-r--r--src/main/java/gregtech/api/interfaces/fluid/IGTRegisteredFluid.java60
1 files changed, 60 insertions, 0 deletions
diff --git a/src/main/java/gregtech/api/interfaces/fluid/IGTRegisteredFluid.java b/src/main/java/gregtech/api/interfaces/fluid/IGTRegisteredFluid.java
new file mode 100644
index 0000000000..b2796ed3f7
--- /dev/null
+++ b/src/main/java/gregtech/api/interfaces/fluid/IGTRegisteredFluid.java
@@ -0,0 +1,60 @@
+package gregtech.api.interfaces.fluid;
+
+import net.minecraft.item.ItemStack;
+import net.minecraftforge.fluids.Fluid;
+import net.minecraftforge.fluids.FluidContainerRegistry;
+
+import gregtech.api.enums.FluidState;
+import gregtech.api.enums.Materials;
+
+public interface IGTRegisteredFluid {
+
+ /**
+ * Registers the containers in the {@link FluidContainerRegistry} for this {@link IGTRegisteredFluid}
+ *
+ * @param fullContainer The full fluid container
+ * @param emptyContainer The empty fluid container
+ * @param containerSize The size of the container
+ * @return The {@link IGTRegisteredFluid} for call chaining
+ */
+ @SuppressWarnings("UnusedReturnValue") // Last call in chain, may not use this returned value
+ IGTRegisteredFluid registerContainers(final ItemStack fullContainer, final ItemStack emptyContainer,
+ final int containerSize);
+
+ /**
+ * Registers the bucket-sized 1000L containers in the {@link FluidContainerRegistry} for this
+ * {@link IGTRegisteredFluid}
+ *
+ * @param fullContainer The full container to associate with this {@link IGTRegisteredFluid}
+ * @param emptyContainer The empty container associate with this {@link IGTRegisteredFluid}
+ * @return {@link IGTRegisteredFluid} for call chaining
+ */
+ @SuppressWarnings("UnusedReturnValue") // Last call in chain, may not use this returned value
+ IGTRegisteredFluid registerBContainers(final ItemStack fullContainer, final ItemStack emptyContainer);
+
+ /**
+ * Registers the potion-sized 250L containers in the {@link FluidContainerRegistry} for this
+ * {@link IGTRegisteredFluid}
+ *
+ * @param fullContainer The full container to associate with this {@link IGTRegisteredFluid}
+ * @param emptyContainer The empty container associate with this {@link IGTRegisteredFluid}
+ * @return {@link IGTRegisteredFluid} self for call chaining
+ */
+ @SuppressWarnings("UnusedReturnValue") // Last call in chain, may not use this returned value
+ IGTRegisteredFluid registerPContainers(final ItemStack fullContainer, final ItemStack emptyContainer);
+
+ /**
+ * Updates the {@link Materials}'s fluids from this {@link IGTRegisteredFluid}'s state
+ *
+ * @param material the {@link Materials} to configure based on this {@link IGTRegisteredFluid} and
+ * {@link FluidState}
+ * @return The {@link IGTRegisteredFluid} for call chaining
+ */
+ @SuppressWarnings("UnusedReturnValue") // Last call in chain, may not use this returned value
+ IGTRegisteredFluid configureMaterials(final Materials material);
+
+ /**
+ * @return this {@link IGTRegisteredFluid} cast to {@link Fluid}
+ */
+ Fluid asFluid();
+}