Add ability to Auto register capabilities via annotation (#8972)

This commit is contained in:
LexManos authored and GitHub committed 2022-08-17 15:06:35 -07:00
1 parent 4f2f5c02a0
commit c0aa8dd808
30 files changed
+134 -58

No files matched your search

@@ -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<HolderSetType> 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 }}</p>
*/
public static final RegistryObject<HolderSetType> NOT_HOLDER_SET = HOLDER_SET_TYPES.register("not", () -> NotHolderSet::codec);
private static final DeferredRegister<FluidType> VANILLA_FLUID_TYPES = DeferredRegister.create(ForgeRegistries.Keys.FLUID_TYPES, "minecraft");
public static final RegistryObject<FluidType> 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();
@@ -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 {}
@@ -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<T>)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<String, Capability<?>> providers = new IdentityHashMap<>();
public void injectCapabilities(List<ModFileScanData> 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);
}
@@ -73,6 +73,7 @@ public abstract class CapabilityProvider<B extends ICapabilityProviderImpl<B>> i
this.initialized = true;
}
@SuppressWarnings("unchecked")
@NotNull
B getProvider()
{
@@ -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<IEnergyStorage> ENERGY = get(new CapabilityToken<>(){});
public static final Capability<IFluidHandler> FLUID_HANDLER = get(new CapabilityToken<>(){});
public static final Capability<IFluidHandlerItem> FLUID_HANDLER_ITEM = get(new CapabilityToken<>(){});
public static final Capability<IItemHandler> ITEM_HANDLER = get(new CapabilityToken<>(){});
}
@@ -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<B extends ICapabilityProviderImpl<B>> extends ICapabilityProvider
{
boolean areCapsCompatible(CapabilityProvider<B> other);
@@ -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<IEnergyStorage> 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<IEnergyStorage> ENERGY = ForgeCapabilities.ENERGY;
public static void register(RegisterCapabilitiesEvent event){}
}
@@ -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.
* <p>
@@ -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
{
/**
@@ -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<IFluidHandlerItem> 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<IFluidHandler> 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();
@@ -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<IFluidHandler> FLUID_HANDLER_CAPABILITY = CapabilityManager.get(new CapabilityToken<>(){});
public static Capability<IFluidHandlerItem> 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<IFluidHandler> 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<IFluidHandlerItem> 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){}
}
@@ -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 <T> LazyOptional<T> getCapability(@NotNull Capability<T> capability, @Nullable Direction facing)
{
if (capability == CapabilityFluidHandler.FLUID_HANDLER_CAPABILITY)
if (capability == ForgeCapabilities.FLUID_HANDLER)
return holder.cast();
return super.getCapability(capability, facing);
}
@@ -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;
* <p>
* A reference implementation is provided {@link TileFluidHandler}.
*/
@AutoRegisterCapability
public interface IFluidHandler
{
enum FluidAction {
@@ -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
{
/**
@@ -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 <T> LazyOptional<T> getCapability(@NotNull Capability<T> capability, @Nullable Direction facing)
{
return CapabilityFluidHandler.FLUID_HANDLER_ITEM_CAPABILITY.orEmpty(capability, holder);
return ForgeCapabilities.FLUID_HANDLER_ITEM.orEmpty(capability, holder);
}
/**
@@ -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 <T> LazyOptional<T> getCapability(@NotNull Capability<T> capability, @Nullable Direction facing)
{
return CapabilityFluidHandler.FLUID_HANDLER_ITEM_CAPABILITY.orEmpty(capability, holder);
return ForgeCapabilities.FLUID_HANDLER_ITEM.orEmpty(capability, holder);
}
/**
@@ -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 <T> LazyOptional<T> getCapability(@NotNull Capability<T> capability, @Nullable Direction facing)
{
return CapabilityFluidHandler.FLUID_HANDLER_ITEM_CAPABILITY.orEmpty(capability, holder);
return ForgeCapabilities.FLUID_HANDLER_ITEM.orEmpty(capability, holder);
}
}
@@ -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<IItemHandler> 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<IItemHandler> ITEM_HANDLER_CAPABILITY = ForgeCapabilities.ITEM_HANDLER;
public static void register(RegisterCapabilitiesEvent event)
{
event.register(IItemHandler.class);
}
public static void register(RegisterCapabilitiesEvent event){}
}
@@ -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
{
/**
@@ -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.<IItemHandler, Object>of(capability, blockEntity));
}
}