JEI Category Improvements (#34)

Various code cleanups and adjustments to JEI category displays to make them better.

See #34 for full details and commit history.

Author: Exaxxion

src/main/java/gregtech/api/recipes/RecipeMap.java

@@ -68,7 +68,7 @@ public class RecipeMap<R extends RecipeBuilder<R>> implements SoundEmitter<Recip
     protected SoundEvent sound;
 
     private final Map<FluidKey, Collection<Recipe>> recipeFluidMap = new HashMap<>();
-    private final Collection<Recipe> recipeList = new ArrayList<>();
+    private final List<Recipe> recipeList = new ArrayList<>();
 
     public RecipeMap(String unlocalizedName,
                      int minInputs, int maxInputs, int minOutputs, int maxOutputs,
@@ -528,4 +528,10 @@ public interface IChanceFunction {
          */
         int chanceFor(int chance, int boostPerTier, int boostTier);
     }
+
+    // sort standard recipes by EU/t
+    public static void sort() {
+        for(var map : RECIPE_MAPS)
+            map.recipeList.sort(Comparator.comparingInt(Recipe::getEUt));
+    }
 }

src/main/java/gregtech/api/recipes/machines/FuelRecipeMap.java

@@ -109,4 +109,10 @@ public FuelRecipeMap setSound(SoundEvent event) {
         this.sound = event;
         return this;
     }
+
+    // Sort fuels by energy density
+    public static void sort() {
+        for(var map : RECIPE_MAPS)
+            map.recipeList.sort(Comparator.comparingDouble(FuelRecipe::getEnergyDensity));
+    }
 }

src/main/java/gregtech/api/recipes/recipes/FuelRecipe.java

@@ -18,11 +18,13 @@ public class FuelRecipe {
     private final FluidStack recipeFluid;
     private final int duration;
     private final long minVoltage;
+    private final double energyDensity;
 
     public FuelRecipe(FluidStack recipeFluid, int duration, long minVoltage) {
         this.recipeFluid = recipeFluid.copy();
         this.duration = duration;
         this.minVoltage = minVoltage;
+        this.energyDensity = (duration * minVoltage) / (double) recipeFluid.amount;
     }
 
     @ZenMethod("create")
@@ -54,4 +56,9 @@ public boolean matches(long maxVoltage, FluidStack inputFluid) {
     public ILiquidStack ctGetFluid() {
         return new MCLiquidStack(getRecipeFluid());
     }
+
+    public double getEnergyDensity() {
+        return energyDensity;
+    }
+
 }

src/main/java/gregtech/common/CommonProxy.java

@@ -5,7 +5,9 @@
 import gregtech.api.block.machines.MachineItemBlock;
 import gregtech.api.enchants.EnchantmentEnderDamage;
 import gregtech.api.items.metaitem.MetaItem;
+import gregtech.api.recipes.RecipeMap;
 import gregtech.api.recipes.crafttweaker.MetaItemBracketHandler;
+import gregtech.api.recipes.machines.FuelRecipeMap;
 import gregtech.api.recipes.recipeproperties.BlastTemperatureProperty;
 import gregtech.api.unification.material.type.DustMaterial;
 import gregtech.api.unification.material.type.Material;
@@ -265,6 +267,8 @@ public void onLoad() {
 
     public void onPostLoad() {
         WoodMachineRecipes.postInit();
+        RecipeMap.sort();
+        FuelRecipeMap.sort();
     }
 
 }

src/main/java/gregtech/integration/jei/GTOreCategory.java

@@ -16,6 +16,7 @@
 import net.minecraft.client.gui.FontRenderer;
 import net.minecraft.world.DimensionType;
 import net.minecraftforge.common.DimensionManager;
+import org.jetbrains.annotations.NotNull;
 
 import java.util.*;
 import java.util.function.Supplier;
@@ -35,7 +36,7 @@ public class GTOreCategory extends PrimitiveRecipeCategory<GTOreInfo, GTOreInfo>
     protected List<Integer> dimensionIDs;
     protected final int FONT_HEIGHT = Minecraft.getMinecraft().fontRenderer.FONT_HEIGHT;
     protected final Map<Integer, String> namedDimensions = WorldGenRegistry.getNamedDimensions();
-    private Supplier<List<Integer>> dimension = this::getAllRegisteredDimensions;
+    private final Supplier<List<Integer>> dimension = this::getAllRegisteredDimensions;
     private final int NUM_OF_SLOTS = 5;
     private final int SLOT_WIDTH = 18;
     private final int SLOT_HEIGHT = 18;
@@ -46,12 +47,13 @@ public GTOreCategory(IGuiHelper guiHelper) {
             guiHelper.createBlankDrawable(176, 166),
             guiHelper);
 
-        this.slot = guiHelper.createDrawable(GuiTextures.SLOT.imageLocation, 0, 0, 18, 18, 18, 18);
+        this.slot = guiHelper.drawableBuilder(GuiTextures.SLOT.imageLocation, 0, 0, 18, 18)
+                             .setTextureSize(18, 18).build();
     }
 
 
     @Override
-    public void setRecipe(IRecipeLayout recipeLayout, GTOreInfo recipeWrapper, IIngredients ingredients) {
+    public void setRecipe(IRecipeLayout recipeLayout, GTOreInfo recipeWrapper, @NotNull IIngredients ingredients) {
 
         IGuiItemStackGroup itemStackGroup = recipeLayout.getItemStacks();
         int baseYPos = 19;
@@ -69,7 +71,7 @@ public void setRecipe(IRecipeLayout recipeLayout, GTOreInfo recipeWrapper, IIngr
             itemStackGroup.init(i + 2, false, xPos, yPos);
         }
 
-        itemStackGroup.addTooltipCallback(recipeWrapper::addTooltip);
+        itemStackGroup.addTooltipCallback(recipeWrapper);
         itemStackGroup.set(ingredients);
         veinName = recipeWrapper.getVeinName();
         minHeight = recipeWrapper.getMinHeight();
@@ -80,12 +82,13 @@ public void setRecipe(IRecipeLayout recipeLayout, GTOreInfo recipeWrapper, IIngr
     }
 
     @Override
-    public IRecipeWrapper getRecipeWrapper(GTOreInfo recipe) {
+    @NotNull
+    public IRecipeWrapper getRecipeWrapper(@NotNull GTOreInfo recipe) {
         return recipe;
     }
 
     @Override
-    public void drawExtras(Minecraft minecraft) {
+    public void drawExtras(@NotNull Minecraft minecraft) {
 
         int baseXPos = 70;
         int baseYPos = 19;

src/main/java/gregtech/integration/jei/GTOreInfo.java

@@ -9,7 +9,9 @@
 import gregtech.api.worldgen.populator.IVeinPopulator;
 import gregtech.api.worldgen.populator.SurfaceBlockPopulator;
 import gregtech.api.worldgen.populator.SurfaceRockPopulator;
+import mezz.jei.api.gui.ITooltipCallback;
 import mezz.jei.api.ingredients.IIngredients;
+import mezz.jei.api.ingredients.VanillaTypes;
 import mezz.jei.api.recipe.IRecipeWrapper;
 import net.minecraft.block.Block;
 import net.minecraft.block.state.IBlockState;
@@ -19,6 +21,7 @@
 import net.minecraft.world.biome.Biome;
 import net.minecraftforge.fluids.*;
 import org.apache.commons.lang3.tuple.Pair;
+import org.jetbrains.annotations.NotNull;
 
 import java.nio.file.FileSystem;
 import java.nio.file.FileSystems;
@@ -28,7 +31,7 @@
 
 import static gregtech.api.GTValues.*;
 
-public class GTOreInfo implements IRecipeWrapper {
+public class GTOreInfo implements IRecipeWrapper, ITooltipCallback<ItemStack> {
 
     private final OreDepositDefinition definition;
     private final int maxHeight;
@@ -38,8 +41,8 @@ public class GTOreInfo implements IRecipeWrapper {
     private final int weight;
     private final IVeinPopulator veinPopulator;
     private final BlockFiller blockFiller;
-    private List<List<ItemStack>> groupedInputsAsItemStacks = new ArrayList<>();
-    private List<List<ItemStack>> groupedOutputsAsItemStacks = new ArrayList<>();
+    private final List<List<ItemStack>> groupedInputsAsItemStacks = new ArrayList<>();
+    private final List<List<ItemStack>> groupedOutputsAsItemStacks;
     private final Function<Biome, Integer> biomeFunction;
 
     public GTOreInfo(OreDepositDefinition definition) {
@@ -90,8 +93,8 @@ public GTOreInfo(OreDepositDefinition definition) {
 
     @Override
     public void getIngredients(IIngredients ingredients) {
-        ingredients.setInputLists(ItemStack.class, groupedInputsAsItemStacks);
-        ingredients.setOutputLists(ItemStack.class, groupedOutputsAsItemStacks);
+        ingredients.setInputLists(VanillaTypes.ITEM, groupedInputsAsItemStacks);
+        ingredients.setOutputLists(VanillaTypes.ITEM, groupedOutputsAsItemStacks);
     }
 
     //Finds the possible blocks from the Filler definition, and returns them as ItemStacks
@@ -136,14 +139,12 @@ public List<List<ItemStack>> findUniqueBlocksAsItemStack(List<ItemStack> itemLis
         List<List<ItemStack>> groupedItems = new ArrayList<>();
         int entries = itemList.size();
 
-
         //return early for Fluid Generation
         if(veinPopulator instanceof FluidSpringPopulator) {
             groupedItems.add(new ArrayList<>(itemList));
             return groupedItems;
         }
 
-
         ItemStack firstItem = itemList.get(0);
         List<ItemStack> oreList = new ArrayList<>();
         oreList.add(firstItem);
@@ -226,7 +227,7 @@ public String makePrettyName(String name) {
     }
 
     //Creates a tooltip based on the specific slots
-    public void addTooltip(int slotIndex, boolean input, Object ingredient, List<String> tooltip) {
+    public void onTooltip(int slotIndex, boolean input, @NotNull ItemStack ingredient, @NotNull List<String> tooltip) {
 
         //Only add the Biome Information to the selected Ore
         if(slotIndex == 0) {

src/main/java/gregtech/integration/jei/multiblock/MultiblockInfoCategory.java

@@ -14,8 +14,9 @@
 import mezz.jei.api.recipe.IRecipeCategory;
 import mezz.jei.gui.recipes.RecipeLayout;
 import net.minecraft.client.resources.I18n;
+import org.jetbrains.annotations.NotNull;
 
-import java.util.HashMap;
+import java.util.LinkedHashMap;
 import java.util.Map;
 
 public class MultiblockInfoCategory implements IRecipeCategory<MultiblockInfoRecipeWrapper> {
@@ -30,46 +31,52 @@ public MultiblockInfoCategory(IJeiHelpers helpers) {
         this.icon = guiHelper.drawableBuilder(GuiTextures.MULTIBLOCK_CATEGORY.imageLocation, 0, 0, 18, 18).setTextureSize(18, 18).build();
     }
 
-    public static final Map<String, MultiblockInfoRecipeWrapper> multiblockRecipes = new HashMap<String, MultiblockInfoRecipeWrapper>() {{
-        put("primitive_blast_furnace", new MultiblockInfoRecipeWrapper(new PrimitiveBlastFurnaceInfo()));
-        put("coke_oven", new MultiblockInfoRecipeWrapper(new CokeOvenInfo()));
-        put("vacuum_freezer", new MultiblockInfoRecipeWrapper(new VacuumFreezerInfo()));
-        put("implosion_compressor", new MultiblockInfoRecipeWrapper(new ImplosionCompressorInfo()));
-        put("pyrolyze_oven", new MultiblockInfoRecipeWrapper(new PyrolyzeOvenInfo()));
-        put("cracker_unit", new MultiblockInfoRecipeWrapper(new CrackerUnitInfo()));
-        put("diesel_engine", new MultiblockInfoRecipeWrapper(new DieselEngineInfo()));
-        put("distillation_tower", new MultiblockInfoRecipeWrapper(new DistillationTowerInfo()));
-        put("electric_blast_furnace", new MultiblockInfoRecipeWrapper(new ElectricBlastFurnaceInfo()));
-        put("multi_smelter", new MultiblockInfoRecipeWrapper(new MultiSmelterInfo()));
-        put("large_bronze_boiler", new MultiblockInfoRecipeWrapper(new LargeBoilerInfo(MetaTileEntities.LARGE_BRONZE_BOILER)));
-        put("large_steel_boiler", new MultiblockInfoRecipeWrapper(new LargeBoilerInfo(MetaTileEntities.LARGE_STEEL_BOILER)));
-        put("large_titanium_boiler", new MultiblockInfoRecipeWrapper(new LargeBoilerInfo(MetaTileEntities.LARGE_TITANIUM_BOILER)));
-        put("large_tungstensteel_boiler", new MultiblockInfoRecipeWrapper(new LargeBoilerInfo(MetaTileEntities.LARGE_TUNGSTENSTEEL_BOILER)));
-        put("large_steam_turbine", new MultiblockInfoRecipeWrapper(new LargeTurbineInfo(MetaTileEntities.LARGE_STEAM_TURBINE)));
-        put("large_gas_turbine", new MultiblockInfoRecipeWrapper(new LargeTurbineInfo(MetaTileEntities.LARGE_GAS_TURBINE)));
-        put("large_plasma_turbine", new MultiblockInfoRecipeWrapper(new LargeTurbineInfo(MetaTileEntities.LARGE_PLASMA_TURBINE)));
-    }};
+    public static final Map<String, MultiblockInfoRecipeWrapper> multiblockRecipes = new LinkedHashMap<>();
+    static {
+        var map = multiblockRecipes;
+        map.put("primitive_blast_furnace", new MultiblockInfoRecipeWrapper(new PrimitiveBlastFurnaceInfo()));
+        map.put("coke_oven", new MultiblockInfoRecipeWrapper(new CokeOvenInfo()));
+        map.put("vacuum_freezer", new MultiblockInfoRecipeWrapper(new VacuumFreezerInfo()));
+        map.put("implosion_compressor", new MultiblockInfoRecipeWrapper(new ImplosionCompressorInfo()));
+        map.put("pyrolyze_oven", new MultiblockInfoRecipeWrapper(new PyrolyzeOvenInfo()));
+        map.put("cracker_unit", new MultiblockInfoRecipeWrapper(new CrackerUnitInfo()));
+        map.put("diesel_engine", new MultiblockInfoRecipeWrapper(new DieselEngineInfo()));
+        map.put("distillation_tower", new MultiblockInfoRecipeWrapper(new DistillationTowerInfo()));
+        map.put("electric_blast_furnace", new MultiblockInfoRecipeWrapper(new ElectricBlastFurnaceInfo()));
+        map.put("multi_smelter", new MultiblockInfoRecipeWrapper(new MultiSmelterInfo()));
+        map.put("large_bronze_boiler", new MultiblockInfoRecipeWrapper(new LargeBoilerInfo(MetaTileEntities.LARGE_BRONZE_BOILER)));
+        map.put("large_steel_boiler", new MultiblockInfoRecipeWrapper(new LargeBoilerInfo(MetaTileEntities.LARGE_STEEL_BOILER)));
+        map.put("large_titanium_boiler", new MultiblockInfoRecipeWrapper(new LargeBoilerInfo(MetaTileEntities.LARGE_TITANIUM_BOILER)));
+        map.put("large_tungstensteel_boiler", new MultiblockInfoRecipeWrapper(new LargeBoilerInfo(MetaTileEntities.LARGE_TUNGSTENSTEEL_BOILER)));
+        map.put("large_steam_turbine", new MultiblockInfoRecipeWrapper(new LargeTurbineInfo(MetaTileEntities.LARGE_STEAM_TURBINE)));
+        map.put("large_gas_turbine", new MultiblockInfoRecipeWrapper(new LargeTurbineInfo(MetaTileEntities.LARGE_GAS_TURBINE)));
+        map.put("large_plasma_turbine", new MultiblockInfoRecipeWrapper(new LargeTurbineInfo(MetaTileEntities.LARGE_PLASMA_TURBINE)));
+    }
 
     public static void registerRecipes(IModRegistry registry) {
         registry.addRecipes(multiblockRecipes.values(), "gregtech:multiblock_info");
     }
 
     @Override
+    @NotNull
     public String getUid() {
         return "gregtech:multiblock_info";
     }
 
     @Override
+    @NotNull
     public String getTitle() {
         return I18n.format("gregtech.multiblock.title");
     }
 
     @Override
+    @NotNull
     public String getModName() {
         return GTValues.MODID;
     }
 
     @Override
+    @NotNull
     public IDrawable getBackground() {
         return background;
     }
@@ -80,10 +87,13 @@ public IDrawable getIcon() {
     }
 
     @Override
-    public void setRecipe(IRecipeLayout recipeLayout, MultiblockInfoRecipeWrapper recipeWrapper, IIngredients ingredients) {
+    public void setRecipe(IRecipeLayout recipeLayout,
+                          MultiblockInfoRecipeWrapper recipeWrapper,
+                          @NotNull IIngredients ingredients)
+    {
         recipeWrapper.setRecipeLayout((RecipeLayout) recipeLayout, this.guiHelper);
 
         IGuiItemStackGroup itemStackGroup = recipeLayout.getItemStacks();
-        itemStackGroup.addTooltipCallback(recipeWrapper::addBlockTooltips);
+        itemStackGroup.addTooltipCallback(recipeWrapper);
     }
 }

src/main/java/gregtech/integration/jei/multiblock/MultiblockInfoPage.java

@@ -21,7 +21,7 @@ public abstract class MultiblockInfoPage {
 
     private final Hash.Strategy<ItemStack> strategy = ItemStackHashStrategy.comparingAllButCount();
 
-    private Map<ItemStack, List<ITextComponent>> blockTooltips = new Object2ObjectOpenCustomHashMap<>(strategy);
+    private final Map<ItemStack, List<ITextComponent>> blockTooltips = new Object2ObjectOpenCustomHashMap<>(strategy);
 
     private static final ITextComponent defaultText = new TextComponentTranslation("gregtech.multiblock.preview.any_hatch").setStyle(new Style().setColor(TextFormatting.GREEN));