(1.20.1) Adds Capability for Mods to Register Custom Brewing Fuels #10123
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| package net.minecraftforge.common; | ||
|
|
||
| import it.unimi.dsi.fastutil.objects.Object2IntMap; | ||
| import it.unimi.dsi.fastutil.objects.Object2IntOpenHashMap; | ||
| import net.minecraft.world.item.Item; | ||
|
|
||
| /** | ||
| * Stores a map of items to integers representing the fuel value of the items | ||
| * when used in a brewing stand. If a fuel is not assigned a value, it will use | ||
| * the fuel value of blaze power. Once added, items cannot be removed from the | ||
| * fuel values table. | ||
| */ | ||
| public class BrewingFuelValues { | ||
|
|
||
| /** | ||
| * The value of the only vanilla fuel, blaze powder. | ||
| */ | ||
| public static final int VANILLA_FUEL_TIME = 20; | ||
| private Object2IntMap<Item> fuelTimes; | ||
|
|
||
| public BrewingFuelValues() | ||
| { | ||
| this.fuelTimes = new Object2IntOpenHashMap<>(); | ||
|
There was a problem hiding this comment. As this takes no values from the constructor it can be done in the field initializer. |
||
| } | ||
|
|
||
| /** | ||
| * Adds the given item as a fuel for blaze rods, and assigns it the given fuel | ||
| * value. | ||
| */ | ||
| public void add(Item fuel, int fuelTime) | ||
| { | ||
| this.fuelTimes.put(fuel, fuelTime); | ||
| } | ||
|
|
||
| /** | ||
| * Adds the given item as a fuel for brewing stands, and assigns the default | ||
| * fuel value of blaze powder. | ||
| */ | ||
| public void add(Item fuel) | ||
| { | ||
| this.add(fuel, VANILLA_FUEL_TIME); | ||
| } | ||
|
|
||
| /** | ||
| * Retrieves the brewing stand fuel value of the given item. If the item is not | ||
| * in the map, this function returns the fuel value of blaze powder. | ||
| */ | ||
| public int get(Item fuel) | ||
| { | ||
| return this.fuelTimes.getOrDefault(fuel, VANILLA_FUEL_TIME); | ||
|
There was a problem hiding this comment. This would make any item not registered return the default. I dont think this is good api... There was a problem hiding this comment. The idea was that items tagged as brewing stand fuel would be whatever the default is, and can be overriden via this method. There was a problem hiding this comment. Yes, but that is not what this method does, thats what the add(Item) overload does. There was a problem hiding this comment. Understood, I'll fix that. Thank you for your input. |
||
| } | ||
|
|
||
| /** | ||
| * Returns true if and only if this object's map has the given item as a fuel. | ||
| * Note that this map will not hold blaze powder by default. | ||
| */ | ||
| public boolean hasFuel(Item fuel) | ||
| { | ||
| return this.fuelTimes.containsKey(fuel); | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| package net.minecraftforge.event.brewing; | ||
|
|
||
| import net.minecraft.world.item.Item; | ||
| import net.minecraftforge.common.BrewingFuelValues; | ||
|
|
||
| public class RegisterBrewingFuelEvent extends net.minecraftforge.eventbus.api.Event | ||
| { | ||
|
|
||
|
There was a problem hiding this comment. Our new code style is to have braces on the same line, so please do that. There was a problem hiding this comment. Understood. I was wondering if the "how to contribute to forge" document I found might be a little out of date... guess so. It's here if you want to take a look. |
||
| private BrewingFuelValues brewingFuelValues; | ||
|
|
||
| public RegisterBrewingFuelEvent() | ||
| { | ||
| super(); | ||
| this.brewingFuelValues = new BrewingFuelValues(); | ||
| } | ||
|
|
||
| public void register(Item fuel, int fuelValue) | ||
| { | ||
| this.brewingFuelValues.add(fuel, fuelValue); | ||
| } | ||
|
|
||
| /** | ||
| * Is this unsafe? Should we allow outside access to the values? | ||
| * This could result in unexpected changes, which might cause problems. | ||
| */ | ||
| public BrewingFuelValues getBrewingFuelValues() { | ||
| return this.brewingFuelValues; | ||
| } | ||
|
|
||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| package net.minecraftforge.debug; | ||
|
|
||
| import net.minecraft.world.item.Item; | ||
| import net.minecraft.world.item.Items; | ||
| import net.minecraft.world.item.Rarity; | ||
| import net.minecraftforge.event.brewing.RegisterBrewingFuelEvent; | ||
| import net.minecraftforge.eventbus.api.IEventBus; | ||
| import net.minecraftforge.eventbus.api.SubscribeEvent; | ||
| import net.minecraftforge.fml.common.Mod; | ||
| import net.minecraftforge.fml.javafmlmod.FMLJavaModLoadingContext; | ||
| import net.minecraftforge.registries.DeferredRegister; | ||
| import net.minecraftforge.registries.ForgeRegistries; | ||
| import net.minecraftforge.registries.RegistryObject; | ||
|
|
||
| @Mod(BrewingFuelTest.MOD_ID) | ||
| @Mod.EventBusSubscriber(modid=BrewingFuelTest.MOD_ID) | ||
| public class BrewingFuelTest | ||
| { | ||
| static final String MOD_ID = "brewing_fuel_test"; | ||
|
|
||
| private static final DeferredRegister<Item> ITEMS = DeferredRegister.create(ForgeRegistries.ITEMS, MOD_ID); | ||
|
|
||
| private static final RegistryObject<Item> TEST_BREWING_FUEL = ITEMS.register("test_brewing_fuel", | ||
| () -> new Item(new Item.Properties().rarity(Rarity.UNCOMMON))); | ||
|
|
||
| private static final boolean ENABLED = true; | ||
|
|
||
| public BrewingFuelTest() | ||
| { | ||
| if (ENABLED) { | ||
| final IEventBus modEventBus = FMLJavaModLoadingContext.get().getModEventBus(); | ||
| ITEMS.register(modEventBus); | ||
| } | ||
| } | ||
|
|
||
| @SubscribeEvent | ||
| public static void addBrewingFuel(RegisterBrewingFuelEvent event) | ||
| { | ||
| if (ENABLED) | ||
| { | ||
| // Register vanilla item as fuel. | ||
| event.register(Items.COAL, 5); | ||
| // Register custom item as fuel. | ||
| event.register(TEST_BREWING_FUEL.get(), 10); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| { | ||
| "item.brewing_fuel_test.test_brewing_fuel": "Brewing Fuel" | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| { | ||
| "parent": "minecraft:item/generated", | ||
| "textures": { | ||
| "layer0": "brewing_fuel_test:item/test_brewing_fuel" | ||
| } | ||
| } |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This fires the event during the static initializer of the brewing stand menu, this is not a good place for that. A better place would be to make it part of the registry events, Or perhaps instead of making it a custom registry implementation. It could be data driven and use the syncing mechanics of the custom data registries?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll look into those and see if I can find a better way. One thing, though: you mentioned on Discord that using tags would not be the best idea - wouldn't making it data driven have the same problems with vanilla server/Forge client?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Quite possibly, it would need testing and a way to verify that connecting to vanilla servers behaves fine.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm having trouble figuring out how to use the custom data registries. Are there any existing examples I could take a look at?
Since I've been so far unable to figure that part out, I've been working on a different approach. I reworked the brewing fuel values class to pattern it off of the
BrewingRecipeRegistryclass; thus, instead of having its own event, mods can add values to a static map in theFMLCommonSetupEvent. This version does not require adding an event, requires only minimal changes to other Forge classes, and matches the existing way of adding behaviors to the brewing stand.