From c0aa8dd8081c27b7b565d0f001513424a0a8f4df Mon Sep 17 00:00:00 2001 From: LexManos Date: Wed, 17 Aug 2022 15:06:35 -0700 Subject: [PATCH] Add ability to Auto register capabilities via annotation (#8972) --- .../LowCodeModLanguageProvider.java | 2 +- .../world/entity/LivingEntity.java.patch | 2 +- .../animal/horse/AbstractHorse.java.patch | 2 +- .../world/entity/player/Player.java.patch | 2 +- .../AbstractMinecartContainer.java.patch | 2 +- .../world/entity/vehicle/ChestBoat.java.patch | 2 +- .../AbstractFurnaceBlockEntity.java.patch | 2 +- .../BaseContainerBlockEntity.java.patch | 2 +- .../entity/BrewingStandBlockEntity.java.patch | 2 +- .../block/entity/ChestBlockEntity.java.patch | 2 +- .../net/minecraftforge/common/ForgeMod.java | 12 ++------- .../capabilities/AutoRegisterCapability.java | 18 +++++++++++++ .../capabilities/CapabilityManager.java | 18 ++++++++++++- .../capabilities/CapabilityProvider.java | 1 + .../capabilities/ForgeCapabilities.java | 26 +++++++++++++++++++ .../capabilities/ICapabilityProviderImpl.java | 2 ++ .../energy/CapabilityEnergy.java | 13 +++++----- .../minecraftforge/energy/IEnergyStorage.java | 3 +++ .../net/minecraftforge/fluids/FluidUtil.java | 11 +++----- .../capability/CapabilityFluidHandler.java | 23 ++++++++++------ .../capability/FluidHandlerBlockEntity.java | 3 ++- .../fluids/capability/IFluidHandler.java | 2 ++ .../fluids/capability/IFluidHandlerItem.java | 3 +++ .../templates/FluidHandlerItemStack.java | 4 +-- .../FluidHandlerItemStackSimple.java | 4 +-- .../wrappers/FluidBucketWrapper.java | 4 +-- .../items/CapabilityItemHandler.java | 13 ++++++---- .../minecraftforge/items/IItemHandler.java | 2 ++ .../items/VanillaInventoryCodeHooks.java | 3 ++- .../debug/misc/GameTestTest.java | 7 ++--- 30 files changed, 134 insertions(+), 58 deletions(-) create mode 100644 src/main/java/net/minecraftforge/common/capabilities/AutoRegisterCapability.java create mode 100644 src/main/java/net/minecraftforge/common/capabilities/ForgeCapabilities.java diff --git a/lowcodelanguage/src/main/java/net/minecraftforge/fml/lowcodemod/LowCodeModLanguageProvider.java b/lowcodelanguage/src/main/java/net/minecraftforge/fml/lowcodemod/LowCodeModLanguageProvider.java index 075c82fb8e..0f5dcb950f 100644 --- a/lowcodelanguage/src/main/java/net/minecraftforge/fml/lowcodemod/LowCodeModLanguageProvider.java +++ b/lowcodelanguage/src/main/java/net/minecraftforge/fml/lowcodemod/LowCodeModLanguageProvider.java @@ -51,7 +51,7 @@ public class LowCodeModLanguageProvider implements IModLanguageProvider throw new ModLoadingException(info, ModLoadingStage.CONSTRUCT, "fml.modloading.failedtoloadmodclass", e); } } catch (NoSuchMethodException | ClassNotFoundException | InstantiationException | IllegalAccessException e) { - LOGGER.fatal(LOADING, "Unable to load FMLModContainer, wut?", e); + LOGGER.fatal(LOADING, "Unable to load LowCodeModContainer, wut?", e); final Class mle = (Class) LamdbaExceptionUtils.uncheck(() -> Class.forName("net.minecraftforge.fml.ModLoadingException", true, Thread.currentThread().getContextClassLoader())); final Class mls = (Class) LamdbaExceptionUtils.uncheck(() -> Class.forName("net.minecraftforge.fml.ModLoadingStage", true, Thread.currentThread().getContextClassLoader())); throw LamdbaExceptionUtils.uncheck(() -> LamdbaExceptionUtils.uncheck(() -> mle.getConstructor(IModInfo.class, mls, String.class, Throwable.class)).newInstance(info, Enum.valueOf(mls, "CONSTRUCT"), "fml.modloading.failedtoloadmodclass", e)); diff --git a/patches/minecraft/net/minecraft/world/entity/LivingEntity.java.patch b/patches/minecraft/net/minecraft/world/entity/LivingEntity.java.patch index 678020eb59..35e083844e 100644 --- a/patches/minecraft/net/minecraft/world/entity/LivingEntity.java.patch +++ b/patches/minecraft/net/minecraft/world/entity/LivingEntity.java.patch @@ -699,7 +699,7 @@ + + @Override + public net.minecraftforge.common.util.LazyOptional getCapability(net.minecraftforge.common.capabilities.Capability capability, @Nullable Direction facing) { -+ if (this.m_6084_() && capability == net.minecraftforge.items.CapabilityItemHandler.ITEM_HANDLER_CAPABILITY) { ++ if (this.m_6084_() && capability == net.minecraftforge.common.capabilities.ForgeCapabilities.ITEM_HANDLER) { + if (facing == null) return handlers[2].cast(); + else if (facing.m_122434_().m_122478_()) return handlers[0].cast(); + else if (facing.m_122434_().m_122479_()) return handlers[1].cast(); diff --git a/patches/minecraft/net/minecraft/world/entity/animal/horse/AbstractHorse.java.patch b/patches/minecraft/net/minecraft/world/entity/animal/horse/AbstractHorse.java.patch index ca25d3a411..fa3acdaa51 100644 --- a/patches/minecraft/net/minecraft/world/entity/animal/horse/AbstractHorse.java.patch +++ b/patches/minecraft/net/minecraft/world/entity/animal/horse/AbstractHorse.java.patch @@ -38,7 +38,7 @@ + + @Override + public net.minecraftforge.common.util.LazyOptional getCapability(net.minecraftforge.common.capabilities.Capability capability, @Nullable net.minecraft.core.Direction facing) { -+ if (this.m_6084_() && capability == net.minecraftforge.items.CapabilityItemHandler.ITEM_HANDLER_CAPABILITY && itemHandler != null) ++ if (this.m_6084_() && capability == net.minecraftforge.common.capabilities.ForgeCapabilities.ITEM_HANDLER && itemHandler != null) + return itemHandler.cast(); + return super.getCapability(capability, facing); + } diff --git a/patches/minecraft/net/minecraft/world/entity/player/Player.java.patch b/patches/minecraft/net/minecraft/world/entity/player/Player.java.patch index c99577bd35..a0575844a3 100644 --- a/patches/minecraft/net/minecraft/world/entity/player/Player.java.patch +++ b/patches/minecraft/net/minecraft/world/entity/player/Player.java.patch @@ -431,7 +431,7 @@ + + @Override + public net.minecraftforge.common.util.LazyOptional getCapability(net.minecraftforge.common.capabilities.Capability capability, @Nullable Direction facing) { -+ if (this.m_6084_() && capability == net.minecraftforge.items.CapabilityItemHandler.ITEM_HANDLER_CAPABILITY) { ++ if (this.m_6084_() && capability == net.minecraftforge.common.capabilities.ForgeCapabilities.ITEM_HANDLER) { + if (facing == null) return playerJoinedHandler.cast(); + else if (facing.m_122434_().m_122478_()) return playerMainHandler.cast(); + else if (facing.m_122434_().m_122479_()) return playerEquipmentHandler.cast(); diff --git a/patches/minecraft/net/minecraft/world/entity/vehicle/AbstractMinecartContainer.java.patch b/patches/minecraft/net/minecraft/world/entity/vehicle/AbstractMinecartContainer.java.patch index 557a55b1cf..6f9162be26 100644 --- a/patches/minecraft/net/minecraft/world/entity/vehicle/AbstractMinecartContainer.java.patch +++ b/patches/minecraft/net/minecraft/world/entity/vehicle/AbstractMinecartContainer.java.patch @@ -19,7 +19,7 @@ + + @Override + public net.minecraftforge.common.util.LazyOptional getCapability(net.minecraftforge.common.capabilities.Capability capability, @Nullable net.minecraft.core.Direction facing) { -+ if (this.m_6084_() && capability == net.minecraftforge.items.CapabilityItemHandler.ITEM_HANDLER_CAPABILITY) ++ if (this.m_6084_() && capability == net.minecraftforge.common.capabilities.ForgeCapabilities.ITEM_HANDLER) + return itemHandler.cast(); + return super.getCapability(capability, facing); + } diff --git a/patches/minecraft/net/minecraft/world/entity/vehicle/ChestBoat.java.patch b/patches/minecraft/net/minecraft/world/entity/vehicle/ChestBoat.java.patch index 94c1f914c5..a37c3e2974 100644 --- a/patches/minecraft/net/minecraft/world/entity/vehicle/ChestBoat.java.patch +++ b/patches/minecraft/net/minecraft/world/entity/vehicle/ChestBoat.java.patch @@ -10,7 +10,7 @@ + + @Override + public net.minecraftforge.common.util.LazyOptional getCapability(net.minecraftforge.common.capabilities.Capability capability, @Nullable net.minecraft.core.Direction facing) { -+ if (this.m_6084_() && capability == net.minecraftforge.items.CapabilityItemHandler.ITEM_HANDLER_CAPABILITY) ++ if (this.m_6084_() && capability == net.minecraftforge.common.capabilities.ForgeCapabilities.ITEM_HANDLER) + return itemHandler.cast(); + return super.getCapability(capability, facing); + } diff --git a/patches/minecraft/net/minecraft/world/level/block/entity/AbstractFurnaceBlockEntity.java.patch b/patches/minecraft/net/minecraft/world/level/block/entity/AbstractFurnaceBlockEntity.java.patch index af7fa25e9f..b3e8e84a23 100644 --- a/patches/minecraft/net/minecraft/world/level/block/entity/AbstractFurnaceBlockEntity.java.patch +++ b/patches/minecraft/net/minecraft/world/level/block/entity/AbstractFurnaceBlockEntity.java.patch @@ -164,7 +164,7 @@ + + @Override + public net.minecraftforge.common.util.LazyOptional getCapability(net.minecraftforge.common.capabilities.Capability capability, @Nullable Direction facing) { -+ if (!this.f_58859_ && facing != null && capability == net.minecraftforge.items.CapabilityItemHandler.ITEM_HANDLER_CAPABILITY) { ++ if (!this.f_58859_ && facing != null && capability == net.minecraftforge.common.capabilities.ForgeCapabilities.ITEM_HANDLER) { + if (facing == Direction.UP) + return handlers[0].cast(); + else if (facing == Direction.DOWN) diff --git a/patches/minecraft/net/minecraft/world/level/block/entity/BaseContainerBlockEntity.java.patch b/patches/minecraft/net/minecraft/world/level/block/entity/BaseContainerBlockEntity.java.patch index 2ef92dd4d8..da70404338 100644 --- a/patches/minecraft/net/minecraft/world/level/block/entity/BaseContainerBlockEntity.java.patch +++ b/patches/minecraft/net/minecraft/world/level/block/entity/BaseContainerBlockEntity.java.patch @@ -11,7 +11,7 @@ + } + + public net.minecraftforge.common.util.LazyOptional getCapability(net.minecraftforge.common.capabilities.Capability cap, @org.jetbrains.annotations.Nullable net.minecraft.core.Direction side) { -+ if (!this.f_58859_ && cap == net.minecraftforge.items.CapabilityItemHandler.ITEM_HANDLER_CAPABILITY ) ++ if (!this.f_58859_ && cap == net.minecraftforge.common.capabilities.ForgeCapabilities.ITEM_HANDLER) + return itemHandler.cast(); + return super.getCapability(cap, side); + } diff --git a/patches/minecraft/net/minecraft/world/level/block/entity/BrewingStandBlockEntity.java.patch b/patches/minecraft/net/minecraft/world/level/block/entity/BrewingStandBlockEntity.java.patch index 8b82456551..99dce97a99 100644 --- a/patches/minecraft/net/minecraft/world/level/block/entity/BrewingStandBlockEntity.java.patch +++ b/patches/minecraft/net/minecraft/world/level/block/entity/BrewingStandBlockEntity.java.patch @@ -62,7 +62,7 @@ + + @Override + public net.minecraftforge.common.util.LazyOptional getCapability(net.minecraftforge.common.capabilities.Capability capability, @Nullable Direction facing) { -+ if (!this.f_58859_ && facing != null && capability == net.minecraftforge.items.CapabilityItemHandler.ITEM_HANDLER_CAPABILITY) { ++ if (!this.f_58859_ && facing != null && capability == net.minecraftforge.common.capabilities.ForgeCapabilities.ITEM_HANDLER) { + if (facing == Direction.UP) + return handlers[0].cast(); + else if (facing == Direction.DOWN) diff --git a/patches/minecraft/net/minecraft/world/level/block/entity/ChestBlockEntity.java.patch b/patches/minecraft/net/minecraft/world/level/block/entity/ChestBlockEntity.java.patch index 73a737fdfe..b42737779e 100644 --- a/patches/minecraft/net/minecraft/world/level/block/entity/ChestBlockEntity.java.patch +++ b/patches/minecraft/net/minecraft/world/level/block/entity/ChestBlockEntity.java.patch @@ -17,7 +17,7 @@ + + @Override + public net.minecraftforge.common.util.LazyOptional getCapability(net.minecraftforge.common.capabilities.Capability cap, Direction side) { -+ if (!this.f_58859_ && cap == net.minecraftforge.items.CapabilityItemHandler.ITEM_HANDLER_CAPABILITY) { ++ if (!this.f_58859_ && cap == net.minecraftforge.common.capabilities.ForgeCapabilities.ITEM_HANDLER) { + if (this.chestHandler == null) + this.chestHandler = net.minecraftforge.common.util.LazyOptional.of(this::createHandler); + return this.chestHandler.cast(); diff --git a/src/main/java/net/minecraftforge/common/ForgeMod.java b/src/main/java/net/minecraftforge/common/ForgeMod.java index 62a47fe340..5c49893e5e 100644 --- a/src/main/java/net/minecraftforge/common/ForgeMod.java +++ b/src/main/java/net/minecraftforge/common/ForgeMod.java @@ -226,7 +226,7 @@ public class ForgeMod * Stock holder set type that represents any/all values in a registry. Can be used in a holderset object with {@code { "type": "forge:any" }} */ public static final RegistryObject ANY_HOLDER_SET = HOLDER_SET_TYPES.register("any", () -> AnyHolderSet::codec); - + /** * Stock holder set type that represents an intersection of other holdersets. Can be used in a holderset object with {@code { "type": "forge:and", "values": [list of holdersets] }} */ @@ -242,7 +242,7 @@ public class ForgeMod * Can be used in a holderset object with {@code { "type": "forge:not", "value": holderset }}

*/ public static final RegistryObject NOT_HOLDER_SET = HOLDER_SET_TYPES.register("not", () -> NotHolderSet::codec); - + private static final DeferredRegister VANILLA_FLUID_TYPES = DeferredRegister.create(ForgeRegistries.Keys.FLUID_TYPES, "minecraft"); public static final RegistryObject EMPTY_TYPE = VANILLA_FLUID_TYPES.register("empty", () -> @@ -437,7 +437,6 @@ public class ForgeMod CrashReportCallables.registerCrashCallable("Forge", ()->ForgeVersion.getGroup()+":"+ForgeVersion.getVersion()); final IEventBus modEventBus = FMLJavaModLoadingContext.get().getModEventBus(); - modEventBus.addListener(this::registerCapabilities); modEventBus.addListener(this::preInit); modEventBus.addListener(this::gatherData); modEventBus.addListener(this::loadComplete); @@ -470,13 +469,6 @@ public class ForgeMod ForgeRegistries.ITEMS.tags().addOptionalTagDefaults(Tags.Items.ENCHANTING_FUELS, Set.of(ForgeRegistries.ITEMS.getDelegateOrThrow(Items.LAPIS_LAZULI))); } - public void registerCapabilities(RegisterCapabilitiesEvent event) - { - CapabilityItemHandler.register(event); - CapabilityFluidHandler.register(event); - CapabilityEnergy.register(event); - } - public void preInit(FMLCommonSetupEvent evt) { VersionChecker.startVersionCheck(); diff --git a/src/main/java/net/minecraftforge/common/capabilities/AutoRegisterCapability.java b/src/main/java/net/minecraftforge/common/capabilities/AutoRegisterCapability.java new file mode 100644 index 0000000000..512f97da9b --- /dev/null +++ b/src/main/java/net/minecraftforge/common/capabilities/AutoRegisterCapability.java @@ -0,0 +1,18 @@ +/* + * Copyright (c) Forge Development LLC and contributors + * SPDX-License-Identifier: LGPL-2.1-only + */ + +package net.minecraftforge.common.capabilities; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +/** + * Marks a class to be automatically registered in Forge's {@link CapabilityManager} + */ +@Retention(RetentionPolicy.RUNTIME) +@Target(ElementType.TYPE) +public @interface AutoRegisterCapability {} diff --git a/src/main/java/net/minecraftforge/common/capabilities/CapabilityManager.java b/src/main/java/net/minecraftforge/common/capabilities/CapabilityManager.java index 840f7f6b06..a2469ebd5a 100644 --- a/src/main/java/net/minecraftforge/common/capabilities/CapabilityManager.java +++ b/src/main/java/net/minecraftforge/common/capabilities/CapabilityManager.java @@ -9,7 +9,9 @@ import net.minecraftforge.fml.ModLoader; import net.minecraftforge.forgespi.language.ModFileScanData; import org.apache.logging.log4j.LogManager; import org.apache.logging.log4j.Logger; +import org.objectweb.asm.Type; +import java.util.Comparator; import java.util.IdentityHashMap; import java.util.List; @@ -35,7 +37,6 @@ public enum CapabilityManager { realName = realName.intern(); cap = (Capability)providers.computeIfAbsent(realName, Capability::new); - } @@ -59,9 +60,24 @@ public enum CapabilityManager } // INTERNAL + private static final Type AUTO_REGISTER = Type.getType(AutoRegisterCapability.class); private final IdentityHashMap> providers = new IdentityHashMap<>(); public void injectCapabilities(List data) { + var autos = data.stream() + .flatMap(e -> e.getAnnotations().stream()) + .filter(a -> AUTO_REGISTER.equals(a.annotationType())) + .map(a -> a.clazz()) + .distinct() + .sorted(Comparator.comparing(Type::toString)) + .toList(); + + for (var auto : autos) + { + LOGGER.debug(CAPABILITIES, "Attempting to automatically register: " + auto); + get(auto.getInternalName(), true); + } + var event = new RegisterCapabilitiesEvent(); ModLoader.get().postEvent(event); } diff --git a/src/main/java/net/minecraftforge/common/capabilities/CapabilityProvider.java b/src/main/java/net/minecraftforge/common/capabilities/CapabilityProvider.java index adc734c53f..3b94292ec9 100644 --- a/src/main/java/net/minecraftforge/common/capabilities/CapabilityProvider.java +++ b/src/main/java/net/minecraftforge/common/capabilities/CapabilityProvider.java @@ -73,6 +73,7 @@ public abstract class CapabilityProvider> i this.initialized = true; } + @SuppressWarnings("unchecked") @NotNull B getProvider() { diff --git a/src/main/java/net/minecraftforge/common/capabilities/ForgeCapabilities.java b/src/main/java/net/minecraftforge/common/capabilities/ForgeCapabilities.java new file mode 100644 index 0000000000..dd381708e4 --- /dev/null +++ b/src/main/java/net/minecraftforge/common/capabilities/ForgeCapabilities.java @@ -0,0 +1,26 @@ +/* + * Copyright (c) Forge Development LLC and contributors + * SPDX-License-Identifier: LGPL-2.1-only + */ + +package net.minecraftforge.common.capabilities; + +import net.minecraftforge.energy.IEnergyStorage; +import net.minecraftforge.fluids.capability.IFluidHandler; +import net.minecraftforge.fluids.capability.IFluidHandlerItem; +import net.minecraftforge.items.IItemHandler; + +import static net.minecraftforge.common.capabilities.CapabilityManager.get; + +/* + * References to Forge's built in capabilities. + * Modders are recommended to use their own CapabilityTokens for 3rd party caps to maintain soft dependencies. + * However, since nobody has a soft dependency on Forge, we expose this as API. + */ +public class ForgeCapabilities +{ + public static final Capability ENERGY = get(new CapabilityToken<>(){}); + public static final Capability FLUID_HANDLER = get(new CapabilityToken<>(){}); + public static final Capability FLUID_HANDLER_ITEM = get(new CapabilityToken<>(){}); + public static final Capability ITEM_HANDLER = get(new CapabilityToken<>(){}); +} diff --git a/src/main/java/net/minecraftforge/common/capabilities/ICapabilityProviderImpl.java b/src/main/java/net/minecraftforge/common/capabilities/ICapabilityProviderImpl.java index ffbd3d6cc1..0633731794 100644 --- a/src/main/java/net/minecraftforge/common/capabilities/ICapabilityProviderImpl.java +++ b/src/main/java/net/minecraftforge/common/capabilities/ICapabilityProviderImpl.java @@ -5,8 +5,10 @@ package net.minecraftforge.common.capabilities; +import org.jetbrains.annotations.ApiStatus; import org.jetbrains.annotations.Nullable; +@ApiStatus.Internal // Modders should use ICapabilityProvider, this is for Forge public interface ICapabilityProviderImpl> extends ICapabilityProvider { boolean areCapsCompatible(CapabilityProvider other); diff --git a/src/main/java/net/minecraftforge/energy/CapabilityEnergy.java b/src/main/java/net/minecraftforge/energy/CapabilityEnergy.java index 31885e9f2f..5d4a49ff14 100644 --- a/src/main/java/net/minecraftforge/energy/CapabilityEnergy.java +++ b/src/main/java/net/minecraftforge/energy/CapabilityEnergy.java @@ -7,12 +7,13 @@ package net.minecraftforge.energy; import net.minecraftforge.common.capabilities.*; +@Deprecated(forRemoval = true, since = "1.19.2") public class CapabilityEnergy { - public static final Capability ENERGY = CapabilityManager.get(new CapabilityToken<>(){});; - - public static void register(RegisterCapabilitiesEvent event) - { - event.register(IEnergyStorage.class); - } + /** + * @deprecated Create your own reference using {@link CapabilityManager#get(CapabilityToken)}, or use {@link ForgeCapabilities#ENERGY}. + */ + @Deprecated(forRemoval = true, since = "1.19.2") + public static final Capability ENERGY = ForgeCapabilities.ENERGY; + public static void register(RegisterCapabilitiesEvent event){} } diff --git a/src/main/java/net/minecraftforge/energy/IEnergyStorage.java b/src/main/java/net/minecraftforge/energy/IEnergyStorage.java index 2a17ec36f8..7eedbcb15d 100644 --- a/src/main/java/net/minecraftforge/energy/IEnergyStorage.java +++ b/src/main/java/net/minecraftforge/energy/IEnergyStorage.java @@ -5,6 +5,8 @@ package net.minecraftforge.energy; +import net.minecraftforge.common.capabilities.AutoRegisterCapability; + /** * An energy storage is the unit of interaction with Energy inventories. *

@@ -14,6 +16,7 @@ package net.minecraftforge.energy; * Created with consent and permission of King Lemming and Team CoFH. Released with permission under LGPL 2.1 when bundled with Forge. * */ +@AutoRegisterCapability public interface IEnergyStorage { /** diff --git a/src/main/java/net/minecraftforge/fluids/FluidUtil.java b/src/main/java/net/minecraftforge/fluids/FluidUtil.java index 5f63ae3fd9..7784443672 100644 --- a/src/main/java/net/minecraftforge/fluids/FluidUtil.java +++ b/src/main/java/net/minecraftforge/fluids/FluidUtil.java @@ -24,14 +24,13 @@ import net.minecraft.world.phys.BlockHitResult; import net.minecraft.world.phys.Vec3; import net.minecraft.world.level.Level; import net.minecraftforge.common.SoundActions; +import net.minecraftforge.common.capabilities.ForgeCapabilities; import net.minecraftforge.common.util.LazyOptional; -import net.minecraftforge.fluids.capability.CapabilityFluidHandler; import net.minecraftforge.fluids.capability.IFluidHandler; import net.minecraftforge.fluids.capability.IFluidHandlerItem; import net.minecraftforge.fluids.capability.wrappers.BlockWrapper; import net.minecraftforge.fluids.capability.wrappers.BucketPickupHandlerWrapper; import net.minecraftforge.fluids.capability.wrappers.FluidBlockWrapper; -import net.minecraftforge.items.CapabilityItemHandler; import net.minecraftforge.items.IItemHandler; import net.minecraftforge.items.ItemHandlerHelper; @@ -91,7 +90,7 @@ public class FluidUtil ItemStack heldItem = player.getItemInHand(hand); if (!heldItem.isEmpty()) { - return player.getCapability(CapabilityItemHandler.ITEM_HANDLER_CAPABILITY) + return player.getCapability(ForgeCapabilities.ITEM_HANDLER) .map(playerInventory -> { FluidActionResult fluidActionResult = tryFillContainerAndStow(heldItem, handler, playerInventory, Integer.MAX_VALUE, player, true); @@ -418,7 +417,7 @@ public class FluidUtil */ public static LazyOptional getFluidHandler(@NotNull ItemStack itemStack) { - return itemStack.getCapability(CapabilityFluidHandler.FLUID_HANDLER_ITEM_CAPABILITY); + return itemStack.getCapability(ForgeCapabilities.FLUID_HANDLER_ITEM); } /** @@ -445,14 +444,12 @@ public class FluidUtil public static LazyOptional getFluidHandler(Level level, BlockPos blockPos, @Nullable Direction side) { BlockState state = level.getBlockState(blockPos); - Block block = state.getBlock(); - if (state.hasBlockEntity()) { BlockEntity blockEntity = level.getBlockEntity(blockPos); if (blockEntity != null) { - return blockEntity.getCapability(CapabilityFluidHandler.FLUID_HANDLER_CAPABILITY, side); + return blockEntity.getCapability(ForgeCapabilities.FLUID_HANDLER, side); } } return LazyOptional.empty(); diff --git a/src/main/java/net/minecraftforge/fluids/capability/CapabilityFluidHandler.java b/src/main/java/net/minecraftforge/fluids/capability/CapabilityFluidHandler.java index b0ee883baf..c458ed93ca 100644 --- a/src/main/java/net/minecraftforge/fluids/capability/CapabilityFluidHandler.java +++ b/src/main/java/net/minecraftforge/fluids/capability/CapabilityFluidHandler.java @@ -8,17 +8,24 @@ package net.minecraftforge.fluids.capability; import net.minecraftforge.common.capabilities.Capability; import net.minecraftforge.common.capabilities.CapabilityManager; import net.minecraftforge.common.capabilities.CapabilityToken; +import net.minecraftforge.common.capabilities.ForgeCapabilities; import net.minecraftforge.common.capabilities.RegisterCapabilitiesEvent; +@Deprecated(forRemoval = true, since = "1.19.2") public class CapabilityFluidHandler { - public static Capability FLUID_HANDLER_CAPABILITY = CapabilityManager.get(new CapabilityToken<>(){}); - public static Capability FLUID_HANDLER_ITEM_CAPABILITY = CapabilityManager.get(new CapabilityToken<>(){}); + /** + * @deprecated Create your own reference using {@link CapabilityManager#get(CapabilityToken)}, or use + * {@link ForgeCapabilities#FLUID_HANDLER}. + */ + @Deprecated(forRemoval = true, since = "1.19.2") + public static Capability FLUID_HANDLER_CAPABILITY = ForgeCapabilities.FLUID_HANDLER; + /** + * @deprecated Create your own reference using {@link CapabilityManager#get(CapabilityToken)}, or use + * {@link ForgeCapabilities#FLUID_HANDLER_ITEM}. + */ + @Deprecated(forRemoval = true, since = "1.19.2") + public static Capability FLUID_HANDLER_ITEM_CAPABILITY = ForgeCapabilities.FLUID_HANDLER_ITEM; - public static void register(RegisterCapabilitiesEvent event) - { - event.register(IFluidHandler.class); - - event.register(IFluidHandlerItem.class); - } + public static void register(RegisterCapabilitiesEvent event){} } diff --git a/src/main/java/net/minecraftforge/fluids/capability/FluidHandlerBlockEntity.java b/src/main/java/net/minecraftforge/fluids/capability/FluidHandlerBlockEntity.java index 309f937580..9f8b964fc2 100644 --- a/src/main/java/net/minecraftforge/fluids/capability/FluidHandlerBlockEntity.java +++ b/src/main/java/net/minecraftforge/fluids/capability/FluidHandlerBlockEntity.java @@ -12,6 +12,7 @@ import net.minecraft.world.level.block.entity.BlockEntity; import net.minecraft.world.level.block.entity.BlockEntityType; import net.minecraft.core.Direction; import net.minecraftforge.common.capabilities.Capability; +import net.minecraftforge.common.capabilities.ForgeCapabilities; import net.minecraftforge.common.util.LazyOptional; import net.minecraftforge.fluids.FluidType; import net.minecraftforge.fluids.capability.templates.FluidTank; @@ -47,7 +48,7 @@ public class FluidHandlerBlockEntity extends BlockEntity @NotNull public LazyOptional getCapability(@NotNull Capability capability, @Nullable Direction facing) { - if (capability == CapabilityFluidHandler.FLUID_HANDLER_CAPABILITY) + if (capability == ForgeCapabilities.FLUID_HANDLER) return holder.cast(); return super.getCapability(capability, facing); } diff --git a/src/main/java/net/minecraftforge/fluids/capability/IFluidHandler.java b/src/main/java/net/minecraftforge/fluids/capability/IFluidHandler.java index 83f7c86589..5beda9701f 100644 --- a/src/main/java/net/minecraftforge/fluids/capability/IFluidHandler.java +++ b/src/main/java/net/minecraftforge/fluids/capability/IFluidHandler.java @@ -5,6 +5,7 @@ package net.minecraftforge.fluids.capability; +import net.minecraftforge.common.capabilities.AutoRegisterCapability; import net.minecraftforge.fluids.*; import org.jetbrains.annotations.NotNull; @@ -14,6 +15,7 @@ import org.jetbrains.annotations.NotNull; *

* A reference implementation is provided {@link TileFluidHandler}. */ +@AutoRegisterCapability public interface IFluidHandler { enum FluidAction { diff --git a/src/main/java/net/minecraftforge/fluids/capability/IFluidHandlerItem.java b/src/main/java/net/minecraftforge/fluids/capability/IFluidHandlerItem.java index 1f13b5dc8a..df6846129d 100644 --- a/src/main/java/net/minecraftforge/fluids/capability/IFluidHandlerItem.java +++ b/src/main/java/net/minecraftforge/fluids/capability/IFluidHandlerItem.java @@ -6,12 +6,15 @@ package net.minecraftforge.fluids.capability; import net.minecraft.world.item.ItemStack; +import net.minecraftforge.common.capabilities.AutoRegisterCapability; + import org.jetbrains.annotations.NotNull; /** * ItemStacks handled by an {@link IFluidHandler} may change, so this class allows * users of the fluid handler to get the container after it has been used. */ +@AutoRegisterCapability public interface IFluidHandlerItem extends IFluidHandler { /** diff --git a/src/main/java/net/minecraftforge/fluids/capability/templates/FluidHandlerItemStack.java b/src/main/java/net/minecraftforge/fluids/capability/templates/FluidHandlerItemStack.java index 2b75d1c511..431bf3461d 100644 --- a/src/main/java/net/minecraftforge/fluids/capability/templates/FluidHandlerItemStack.java +++ b/src/main/java/net/minecraftforge/fluids/capability/templates/FluidHandlerItemStack.java @@ -9,10 +9,10 @@ import net.minecraft.world.item.ItemStack; import net.minecraft.nbt.CompoundTag; import net.minecraft.core.Direction; import net.minecraftforge.common.capabilities.Capability; +import net.minecraftforge.common.capabilities.ForgeCapabilities; import net.minecraftforge.common.capabilities.ICapabilityProvider; import net.minecraftforge.common.util.LazyOptional; import net.minecraftforge.fluids.*; -import net.minecraftforge.fluids.capability.CapabilityFluidHandler; import net.minecraftforge.fluids.capability.IFluidHandlerItem; import org.jetbrains.annotations.NotNull; @@ -212,7 +212,7 @@ public class FluidHandlerItemStack implements IFluidHandlerItem, ICapabilityProv @NotNull public LazyOptional getCapability(@NotNull Capability capability, @Nullable Direction facing) { - return CapabilityFluidHandler.FLUID_HANDLER_ITEM_CAPABILITY.orEmpty(capability, holder); + return ForgeCapabilities.FLUID_HANDLER_ITEM.orEmpty(capability, holder); } /** diff --git a/src/main/java/net/minecraftforge/fluids/capability/templates/FluidHandlerItemStackSimple.java b/src/main/java/net/minecraftforge/fluids/capability/templates/FluidHandlerItemStackSimple.java index 598fde5159..4b6b6dc857 100644 --- a/src/main/java/net/minecraftforge/fluids/capability/templates/FluidHandlerItemStackSimple.java +++ b/src/main/java/net/minecraftforge/fluids/capability/templates/FluidHandlerItemStackSimple.java @@ -9,11 +9,11 @@ import net.minecraft.world.item.ItemStack; import net.minecraft.nbt.CompoundTag; import net.minecraft.core.Direction; import net.minecraftforge.common.capabilities.Capability; +import net.minecraftforge.common.capabilities.ForgeCapabilities; import net.minecraftforge.common.capabilities.ICapabilityProvider; import net.minecraftforge.common.util.LazyOptional; import net.minecraftforge.fluids.FluidStack; import net.minecraftforge.fluids.capability.IFluidHandlerItem; -import net.minecraftforge.fluids.capability.CapabilityFluidHandler; import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.Nullable; @@ -189,7 +189,7 @@ public class FluidHandlerItemStackSimple implements IFluidHandlerItem, ICapabili @NotNull public LazyOptional getCapability(@NotNull Capability capability, @Nullable Direction facing) { - return CapabilityFluidHandler.FLUID_HANDLER_ITEM_CAPABILITY.orEmpty(capability, holder); + return ForgeCapabilities.FLUID_HANDLER_ITEM.orEmpty(capability, holder); } /** diff --git a/src/main/java/net/minecraftforge/fluids/capability/wrappers/FluidBucketWrapper.java b/src/main/java/net/minecraftforge/fluids/capability/wrappers/FluidBucketWrapper.java index 007f272e24..3bf348b09d 100644 --- a/src/main/java/net/minecraftforge/fluids/capability/wrappers/FluidBucketWrapper.java +++ b/src/main/java/net/minecraftforge/fluids/capability/wrappers/FluidBucketWrapper.java @@ -9,13 +9,13 @@ import net.minecraft.world.level.material.Fluids; import net.minecraft.core.Direction; import net.minecraftforge.common.ForgeMod; import net.minecraftforge.common.capabilities.Capability; +import net.minecraftforge.common.capabilities.ForgeCapabilities; import net.minecraftforge.common.capabilities.ICapabilityProvider; import net.minecraftforge.common.util.LazyOptional; import net.minecraftforge.fluids.FluidStack; import net.minecraftforge.fluids.FluidType; import net.minecraftforge.fluids.FluidUtil; import net.minecraftforge.fluids.capability.IFluidHandlerItem; -import net.minecraftforge.fluids.capability.CapabilityFluidHandler; import net.minecraft.world.item.BucketItem; import net.minecraft.world.item.Item; @@ -172,6 +172,6 @@ public class FluidBucketWrapper implements IFluidHandlerItem, ICapabilityProvide @NotNull public LazyOptional getCapability(@NotNull Capability capability, @Nullable Direction facing) { - return CapabilityFluidHandler.FLUID_HANDLER_ITEM_CAPABILITY.orEmpty(capability, holder); + return ForgeCapabilities.FLUID_HANDLER_ITEM.orEmpty(capability, holder); } } diff --git a/src/main/java/net/minecraftforge/items/CapabilityItemHandler.java b/src/main/java/net/minecraftforge/items/CapabilityItemHandler.java index 67fcb010e7..dbc9e915fd 100644 --- a/src/main/java/net/minecraftforge/items/CapabilityItemHandler.java +++ b/src/main/java/net/minecraftforge/items/CapabilityItemHandler.java @@ -8,15 +8,18 @@ package net.minecraftforge.items; import net.minecraftforge.common.capabilities.Capability; import net.minecraftforge.common.capabilities.CapabilityManager; import net.minecraftforge.common.capabilities.CapabilityToken; +import net.minecraftforge.common.capabilities.ForgeCapabilities; import net.minecraftforge.common.capabilities.RegisterCapabilitiesEvent; +@Deprecated(forRemoval = true, since = "1.19.2") public class CapabilityItemHandler { - public static final Capability ITEM_HANDLER_CAPABILITY = CapabilityManager.get(new CapabilityToken<>(){}); + /** + * @deprecated Create your own reference using {@link CapabilityManager#get(CapabilityToken)}, or use {@link ForgeCapabilities#ITEM_HANDLER}. + */ + @Deprecated(forRemoval = true, since = "1.19.2") + public static final Capability ITEM_HANDLER_CAPABILITY = ForgeCapabilities.ITEM_HANDLER; - public static void register(RegisterCapabilitiesEvent event) - { - event.register(IItemHandler.class); - } + public static void register(RegisterCapabilitiesEvent event){} } diff --git a/src/main/java/net/minecraftforge/items/IItemHandler.java b/src/main/java/net/minecraftforge/items/IItemHandler.java index f9a7fdd94a..f208bacf32 100644 --- a/src/main/java/net/minecraftforge/items/IItemHandler.java +++ b/src/main/java/net/minecraftforge/items/IItemHandler.java @@ -7,10 +7,12 @@ package net.minecraftforge.items; import net.minecraft.world.Container; import net.minecraft.world.item.ItemStack; +import net.minecraftforge.common.capabilities.AutoRegisterCapability; import net.minecraftforge.fluids.FluidStack; import net.minecraftforge.fluids.capability.IFluidHandler; import org.jetbrains.annotations.NotNull; +@AutoRegisterCapability public interface IItemHandler { /** diff --git a/src/main/java/net/minecraftforge/items/VanillaInventoryCodeHooks.java b/src/main/java/net/minecraftforge/items/VanillaInventoryCodeHooks.java index 27b80af5c1..1b75dfb09d 100644 --- a/src/main/java/net/minecraftforge/items/VanillaInventoryCodeHooks.java +++ b/src/main/java/net/minecraftforge/items/VanillaInventoryCodeHooks.java @@ -12,6 +12,7 @@ import net.minecraft.world.level.block.entity.Hopper; import net.minecraft.world.level.block.entity.BlockEntity; import net.minecraft.world.level.block.entity.DispenserBlockEntity; import net.minecraft.world.level.block.entity.HopperBlockEntity; +import net.minecraftforge.common.capabilities.ForgeCapabilities; import net.minecraft.core.Direction; import net.minecraft.core.BlockPos; import net.minecraft.util.Mth; @@ -242,7 +243,7 @@ public class VanillaInventoryCodeHooks BlockEntity blockEntity = worldIn.getBlockEntity(blockpos); if (blockEntity != null) { - return blockEntity.getCapability(CapabilityItemHandler.ITEM_HANDLER_CAPABILITY, side) + return blockEntity.getCapability(ForgeCapabilities.ITEM_HANDLER, side) .map(capability -> ImmutablePair.of(capability, blockEntity)); } } diff --git a/src/test/java/net/minecraftforge/debug/misc/GameTestTest.java b/src/test/java/net/minecraftforge/debug/misc/GameTestTest.java index 9d08ab6d56..e6126d1734 100644 --- a/src/test/java/net/minecraftforge/debug/misc/GameTestTest.java +++ b/src/test/java/net/minecraftforge/debug/misc/GameTestTest.java @@ -27,8 +27,8 @@ import net.minecraft.world.level.block.state.BlockState; import net.minecraft.world.level.material.Material; import net.minecraft.world.level.material.MaterialColor; import net.minecraftforge.common.capabilities.Capability; +import net.minecraftforge.common.capabilities.ForgeCapabilities; import net.minecraftforge.common.util.LazyOptional; -import net.minecraftforge.energy.CapabilityEnergy; import net.minecraftforge.energy.EnergyStorage; import net.minecraftforge.energy.IEnergyStorage; import net.minecraftforge.event.RegisterGameTestsEvent; @@ -55,6 +55,7 @@ public class GameTestTest private static final DeferredRegister> BLOCK_ENTITIES = DeferredRegister.create(ForgeRegistries.BLOCK_ENTITY_TYPES, MODID); private static final RegistryObject ENERGY_BLOCK = BLOCKS.register("energy_block", () -> new EnergyBlock(Properties.of(Material.STONE, MaterialColor.STONE))); + @SuppressWarnings("unused") private static final RegistryObject ENERGY_BLOCK_ITEM = ITEMS.register("energy_block", () -> new BlockItem(ENERGY_BLOCK.get(), new Item.Properties().tab(CreativeModeTab.TAB_MISC))); private static final RegistryObject> ENERGY_BLOCK_ENTITY = BLOCK_ENTITIES.register("energy", @@ -167,7 +168,7 @@ public class GameTestTest helper.setBlock(energyPos, ENERGY_BLOCK.get()); // Queries the energy capability - LazyOptional energyHolder = helper.getBlockEntity(energyPos).getCapability(CapabilityEnergy.ENERGY); + LazyOptional energyHolder = helper.getBlockEntity(energyPos).getCapability(ForgeCapabilities.ENERGY); // Adds 2000 FE, but our energy storage can only hold 1000 FE energyHolder.ifPresent(energyStorage -> energyStorage.receiveEnergy(2000, false)); @@ -212,7 +213,7 @@ public class GameTestTest @Override public LazyOptional getCapability(@NotNull Capability capability, @Nullable Direction facing) { - if (capability == CapabilityEnergy.ENERGY) + if (capability == ForgeCapabilities.ENERGY) return energyHolder.cast(); return super.getCapability(capability, facing);