Improve furnace fuel handling (#4083)

src/main/java/net/minecraftforge/event/ForgeEventFactory.java

@@ -37,6 +37,7 @@ import net.minecraft.entity.passive.EntityAnimal;
 import net.minecraft.entity.player.EntityPlayer;
 import net.minecraft.entity.player.EntityPlayer.SleepResult;
 import net.minecraft.init.Blocks;
+import net.minecraft.item.Item;
 import net.minecraft.item.ItemStack;
 import net.minecraft.tileentity.TileEntity;
 import net.minecraft.util.ActionResult;
@@ -103,6 +104,7 @@ import net.minecraftforge.event.entity.player.PlayerSleepInBedEvent;
 import net.minecraftforge.event.entity.player.PlayerWakeUpEvent;
 import net.minecraftforge.event.entity.player.SleepingLocationCheckEvent;
 import net.minecraftforge.event.entity.player.UseHoeEvent;
+import net.minecraftforge.event.furnace.FurnaceFuelBurnTimeEvent;
 import net.minecraftforge.event.terraingen.ChunkGeneratorEvent;
 import net.minecraftforge.event.terraingen.PopulateChunkEvent;
 import net.minecraftforge.event.world.BlockEvent;
@@ -115,6 +117,7 @@ import net.minecraftforge.event.world.WorldEvent;
 import net.minecraftforge.fml.common.ObfuscationReflectionHelper;
 import net.minecraftforge.fml.common.eventhandler.Event;
 import net.minecraftforge.fml.common.eventhandler.Event.Result;
+import net.minecraftforge.fml.common.registry.GameRegistry;
 
 import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
@@ -207,6 +210,24 @@ public class ForgeEventFactory
         return event.getResult();
     }
 
+    public static int getItemBurnTime(@Nonnull ItemStack itemStack)
+    {
+        Item item = itemStack.getItem();
+        int burnTime = item.getItemBurnTime(itemStack);
+        FurnaceFuelBurnTimeEvent event = new FurnaceFuelBurnTimeEvent(itemStack, burnTime);
+        MinecraftForge.EVENT_BUS.post(event);
+        if (event.getBurnTime() < 0)
+        {
+            // legacy handling
+            int fuelValue = GameRegistry.getFuelValueLegacy(itemStack);
+            if (fuelValue > 0)
+            {
+                return fuelValue;
+            }
+        }
+        return event.getBurnTime();
+    }
+
     public static int getExperienceDrop(EntityLivingBase entity, EntityPlayer attackingPlayer, int originalExperience)
     {
        LivingExperienceDropEvent event = new LivingExperienceDropEvent(entity, attackingPlayer, originalExperience);

src/main/java/net/minecraftforge/event/furnace/FurnaceFuelBurnTimeEvent.java

@@ -0,0 +1,86 @@
+/*
+ * Minecraft Forge
+ * Copyright (c) 2016.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation version 2.1
+ * of the License.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ */
+
+package net.minecraftforge.event.furnace;
+
+import javax.annotation.Nonnull;
+
+import net.minecraft.item.Item;
+import net.minecraft.item.ItemStack;
+import net.minecraftforge.common.MinecraftForge;
+import net.minecraftforge.event.ForgeEventFactory;
+import net.minecraftforge.fml.common.eventhandler.Cancelable;
+import net.minecraftforge.fml.common.eventhandler.Event;
+
+/**
+ * {@link FurnaceFuelBurnTimeEvent} is fired when determining the fuel value for an ItemStack. <br>
+ * <br>
+ * To set the burn time of your own item, use {@link Item#getItemBurnTime(ItemStack)} instead.<br>
+ * <br>
+ * This event is fired from {@link ForgeEventFactory#getItemBurnTime(ItemStack)}.<br>
+ * <br>
+ * This event is {@link Cancelable} to prevent later handlers from changing the value.<br>
+ * <br>
+ * This event does not have a result. {@link HasResult}<br>
+ * <br>
+ * This event is fired on the {@link MinecraftForge#EVENT_BUS}.
+ **/
+@Cancelable
+public class FurnaceFuelBurnTimeEvent extends Event
+{
+    @Nonnull
+    private final ItemStack itemStack;
+    private int burnTime;
+
+    public FurnaceFuelBurnTimeEvent(@Nonnull ItemStack itemStack, int burnTime)
+    {
+        this.itemStack = itemStack;
+        this.burnTime = burnTime;
+    }
+
+    /**
+     * Get the ItemStack "fuel" in question.
+     */
+    @Nonnull
+    public ItemStack getItemStack()
+    {
+        return itemStack;
+    }
+
+    /**
+     * Set the burn time for the given ItemStack.
+     * Setting it to 0 will prevent the item from being used as fuel, overriding vanilla's decision.
+     * Setting it to -1 will let vanilla decide on the fuel value, this is the default.
+     */
+    public void setBurnTime(int burnTime)
+    {
+        this.burnTime = burnTime;
+        setCanceled(true);
+    }
+
+    /**
+     * The resulting value of this event, the burn time for the ItemStack.
+     * A value of 0 will prevent the item from being used as fuel, overriding vanilla's decision.
+     * A value of -1 will let vanilla decide on the fuel value, this is the default for {@link Item#getItemBurnTime(ItemStack)}.
+     */
+    public int getBurnTime()
+    {
+        return burnTime;
+    }
+}

src/main/java/net/minecraftforge/fml/common/IFuelHandler.java

@@ -19,8 +19,14 @@
 
 package net.minecraftforge.fml.common;
 
+import net.minecraft.item.Item;
 import net.minecraft.item.ItemStack;
+import net.minecraftforge.event.furnace.FurnaceFuelBurnTimeEvent;
 
+/**
+ * @deprecated set your item's {@link Item#getItemBurnTime(ItemStack)} or subscribe to {@link FurnaceFuelBurnTimeEvent} instead.
+ */
+@Deprecated
 public interface IFuelHandler
 {
     int getBurnTime(ItemStack fuel);

src/main/java/net/minecraftforge/fml/common/registry/GameRegistry.java

@@ -37,7 +37,6 @@ import net.minecraft.command.EntitySelector;
 import net.minecraft.command.ICommandSender;
 import net.minecraft.entity.Entity;
 import net.minecraft.item.Item;
-import net.minecraft.item.ItemBlock;
 import net.minecraft.item.ItemStack;
 import net.minecraft.item.crafting.FurnaceRecipes;
 import net.minecraft.item.crafting.Ingredient;
@@ -56,6 +55,8 @@ import net.minecraft.world.chunk.IChunkProvider;
 import net.minecraft.world.gen.IChunkGenerator;
 import net.minecraftforge.common.crafting.CraftingHelper;
 import net.minecraftforge.common.crafting.CraftingHelper.ShapedPrimer;
+import net.minecraftforge.event.ForgeEventFactory;
+import net.minecraftforge.event.furnace.FurnaceFuelBurnTimeEvent;
 import net.minecraftforge.fml.common.FMLLog;
 import net.minecraftforge.fml.common.IFuelHandler;
 import net.minecraftforge.fml.common.IWorldGenerator;
@@ -65,8 +66,6 @@ import net.minecraftforge.registries.IForgeRegistryEntry;
 import net.minecraftforge.registries.RegistryManager;
 import net.minecraftforge.fml.common.IEntitySelectorFactory;
 
-import org.apache.logging.log4j.Level;
-
 import com.google.common.base.Strings;
 import com.google.common.base.Throwables;
 import com.google.common.collect.ImmutableList;
@@ -237,12 +236,29 @@ public class GameRegistry
         TileEntity.register(key, tileEntityClass);
     }
 
+    /**
+     * @deprecated set your item's {@link Item#getItemBurnTime(ItemStack)} or subscribe to {@link FurnaceFuelBurnTimeEvent} instead.
+     */
+    @Deprecated
     public static void registerFuelHandler(IFuelHandler handler)
     {
         fuelHandlers.add(handler);
     }
 
+    /**
+     * @deprecated use {@link ForgeEventFactory#getItemBurnTime(ItemStack)}
+     */
+    @Deprecated
     public static int getFuelValue(@Nonnull ItemStack itemStack)
+    {
+        return ForgeEventFactory.getItemBurnTime(itemStack);
+    }
+
+    /**
+     * @deprecated use {@link ForgeEventFactory#getItemBurnTime(ItemStack)}
+     */
+    @Deprecated
+    public static int getFuelValueLegacy(@Nonnull ItemStack itemStack)
     {
         int fuelValue = 0;
         for (IFuelHandler handler : fuelHandlers)