IGuiFluidStackGroup.java

package mezz.jei.api.gui;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import java.util.Collection;

import net.minecraftforge.fluids.FluidStack;

/**
 * IGuiFluidStackGroup displays FluidStacks in a gui.
 *
 * If multiple FluidStacks are set, they will be displayed in rotation.
 */
public interface IGuiFluidStackGroup extends IGuiIngredientGroup<FluidStack> {
	/**
	 * Initialize the fluid at slotIndex.
	 *
	 * @param slotIndex    the slot index of this fluid
	 * @param input        whether this slot is an input
	 * @param xPosition    x position relative to the recipe background
	 * @param yPosition    y position relative to the recipe background
	 * @param width        width of this fluid
	 * @param height       height of this fluid
	 * @param capacityMb   maximum amount of fluid that this "tank" can hold in milli-buckets
	 * @param showCapacity show the capacity in the tooltip
	 * @param overlay      optional overlay to display over the tank.
	 *                     Typically the overlay is fluid level lines, but it could also be a mask to shape the tank.
	 */
	void init(int slotIndex, boolean input, int xPosition, int yPosition, int width, int height, int capacityMb, boolean showCapacity, @Nullable IDrawable overlay);

	@Override
	void set(int slotIndex, @Nonnull Collection<FluidStack> fluidStacks);

	@Override
	void set(int slotIndex, @Nonnull FluidStack fluidStack);

	@Override
	void addTooltipCallback(@Nonnull ITooltipCallback<FluidStack> tooltipCallback);
}