mirror of
https://github.com/MinecraftForge/MinecraftForge.git
synced 2026-11-22 05:02:18 +00:00
Implement fluid item capabilities without item swapping
This commit is contained in:
1 parent
6f1a44a405
commit
eb6b3ea228
15 files changed
+437
-227
No files matched your search
@@ -19,6 +19,10 @@
|
||||
|
||||
package net.minecraftforge.fluids.capability;
|
||||
|
||||
import java.util.concurrent.Callable;
|
||||
|
||||
import net.minecraft.init.Items;
|
||||
import net.minecraft.item.ItemStack;
|
||||
import net.minecraft.nbt.NBTBase;
|
||||
import net.minecraft.nbt.NBTTagCompound;
|
||||
import net.minecraft.util.EnumFacing;
|
||||
@@ -29,49 +33,18 @@ import net.minecraftforge.fluids.Fluid;
|
||||
import net.minecraftforge.fluids.FluidStack;
|
||||
import net.minecraftforge.fluids.FluidTank;
|
||||
import net.minecraftforge.fluids.IFluidTank;
|
||||
|
||||
import java.util.concurrent.Callable;
|
||||
import net.minecraftforge.fluids.capability.templates.FluidHandlerItemStack;
|
||||
|
||||
public class CapabilityFluidHandler
|
||||
{
|
||||
@CapabilityInject(IFluidHandler.class)
|
||||
public static Capability<IFluidHandler> FLUID_HANDLER_CAPABILITY = null;
|
||||
@CapabilityInject(IFluidHandlerItem.class)
|
||||
public static Capability<IFluidHandlerItem> FLUID_HANDLER_ITEM_CAPABILITY = null;
|
||||
|
||||
public static void register()
|
||||
{
|
||||
CapabilityManager.INSTANCE.register(IFluidHandler.class, new Capability.IStorage<IFluidHandler>()
|
||||
{
|
||||
@Override
|
||||
public NBTBase writeNBT(Capability<IFluidHandler> capability, IFluidHandler instance, EnumFacing side)
|
||||
{
|
||||
if (!(instance instanceof IFluidTank))
|
||||
throw new RuntimeException("IFluidHandler instance does not implement IFluidTank");
|
||||
NBTTagCompound nbt = new NBTTagCompound();
|
||||
IFluidTank tank = (IFluidTank) instance;
|
||||
FluidStack fluid = tank.getFluid();
|
||||
if (fluid != null)
|
||||
{
|
||||
fluid.writeToNBT(nbt);
|
||||
}
|
||||
else
|
||||
{
|
||||
nbt.setString("Empty", "");
|
||||
}
|
||||
nbt.setInteger("Capacity", tank.getCapacity());
|
||||
return nbt;
|
||||
}
|
||||
|
||||
@Override
|
||||
public void readNBT(Capability<IFluidHandler> capability, IFluidHandler instance, EnumFacing side, NBTBase nbt)
|
||||
{
|
||||
if (!(instance instanceof IFluidTank))
|
||||
throw new RuntimeException("IFluidHandler instance is not instance of FluidTank");
|
||||
NBTTagCompound tags = (NBTTagCompound) nbt;
|
||||
FluidTank tank = (FluidTank) instance;
|
||||
tank.setCapacity(tags.getInteger("Capacity"));
|
||||
tank.readFromNBT(tags);
|
||||
}
|
||||
}, new Callable<IFluidHandler>()
|
||||
CapabilityManager.INSTANCE.register(IFluidHandler.class, new DefaultFluidHandlerStorage<IFluidHandler>(), new Callable<IFluidHandler>()
|
||||
{
|
||||
@Override
|
||||
public IFluidHandler call() throws Exception
|
||||
@@ -79,6 +52,46 @@ public class CapabilityFluidHandler
|
||||
return new FluidTank(Fluid.BUCKET_VOLUME);
|
||||
}
|
||||
});
|
||||
|
||||
CapabilityManager.INSTANCE.register(IFluidHandlerItem.class, new DefaultFluidHandlerStorage<IFluidHandlerItem>(), new Callable<IFluidHandlerItem>() {
|
||||
@Override
|
||||
public IFluidHandlerItem call() throws Exception
|
||||
{
|
||||
return new FluidHandlerItemStack(new ItemStack(Items.BUCKET), Fluid.BUCKET_VOLUME);
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
private static class DefaultFluidHandlerStorage<T extends IFluidHandler> implements Capability.IStorage<T> {
|
||||
@Override
|
||||
public NBTBase writeNBT(Capability<T> capability, T instance, EnumFacing side)
|
||||
{
|
||||
if (!(instance instanceof IFluidTank))
|
||||
throw new RuntimeException("IFluidHandler instance does not implement IFluidTank");
|
||||
NBTTagCompound nbt = new NBTTagCompound();
|
||||
IFluidTank tank = (IFluidTank) instance;
|
||||
FluidStack fluid = tank.getFluid();
|
||||
if (fluid != null)
|
||||
{
|
||||
fluid.writeToNBT(nbt);
|
||||
}
|
||||
else
|
||||
{
|
||||
nbt.setString("Empty", "");
|
||||
}
|
||||
nbt.setInteger("Capacity", tank.getCapacity());
|
||||
return nbt;
|
||||
}
|
||||
|
||||
@Override
|
||||
public void readNBT(Capability<T> capability, T instance, EnumFacing side, NBTBase nbt)
|
||||
{
|
||||
if (!(instance instanceof IFluidTank))
|
||||
throw new RuntimeException("IFluidHandler instance is not instance of FluidTank");
|
||||
NBTTagCompound tags = (NBTTagCompound) nbt;
|
||||
FluidTank tank = (FluidTank) instance;
|
||||
tank.setCapacity(tags.getInteger("Capacity"));
|
||||
tank.readFromNBT(tags);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,41 @@
|
||||
/*
|
||||
* 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.fluids.capability;
|
||||
|
||||
import javax.annotation.Nonnull;
|
||||
import javax.annotation.Nullable;
|
||||
|
||||
import net.minecraft.item.ItemStack;
|
||||
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
public interface IFluidHandlerItem extends IFluidHandler
|
||||
{
|
||||
/**
|
||||
* Get the container currently acted on by this fluid handler.
|
||||
* The ItemStack may be different from its initial state, in the case of fluid containers that have different items
|
||||
* for their filled and empty states.
|
||||
* May be an empty item if the container was drained and is consumable.
|
||||
*/
|
||||
@Nonnull
|
||||
ItemStack getContainer();
|
||||
}
|
||||
@@ -25,6 +25,9 @@ import net.minecraft.nbt.NBTTagCompound;
|
||||
import net.minecraftforge.common.capabilities.ICapabilityProvider;
|
||||
import net.minecraftforge.fluids.capability.templates.FluidHandlerItemStack;
|
||||
|
||||
import javax.annotation.Nonnull;
|
||||
import javax.annotation.Nullable;
|
||||
|
||||
/**
|
||||
* A simple fluid container, to replace the functionality of the old FluidContainerRegistry and IFluidContainerItem.
|
||||
* This fluid container may be set so that is can only completely filled or empty. (binary)
|
||||
@@ -43,7 +46,7 @@ public class ItemFluidContainer extends Item
|
||||
}
|
||||
|
||||
@Override
|
||||
public ICapabilityProvider initCapabilities(ItemStack stack, NBTTagCompound nbt)
|
||||
public ICapabilityProvider initCapabilities(@Nonnull ItemStack stack, @Nullable NBTTagCompound nbt)
|
||||
{
|
||||
return new FluidHandlerItemStack(stack, capacity);
|
||||
}
|
||||
|
||||
+18
-10
@@ -19,6 +19,7 @@
|
||||
|
||||
package net.minecraftforge.fluids.capability.templates;
|
||||
|
||||
import javax.annotation.Nonnull;
|
||||
import javax.annotation.Nullable;
|
||||
|
||||
import net.minecraft.item.ItemStack;
|
||||
@@ -29,7 +30,7 @@ import net.minecraftforge.common.capabilities.ICapabilityProvider;
|
||||
import net.minecraftforge.fluids.*;
|
||||
import net.minecraftforge.fluids.capability.CapabilityFluidHandler;
|
||||
import net.minecraftforge.fluids.capability.FluidTankProperties;
|
||||
import net.minecraftforge.fluids.capability.IFluidHandler;
|
||||
import net.minecraftforge.fluids.capability.IFluidHandlerItem;
|
||||
import net.minecraftforge.fluids.capability.IFluidTankProperties;
|
||||
|
||||
/**
|
||||
@@ -41,23 +42,31 @@ import net.minecraftforge.fluids.capability.IFluidTankProperties;
|
||||
* Additional examples are provided to enable consumable fluid containers (see {@link Consumable}),
|
||||
* fluid containers with different empty and full items (see {@link SwapEmpty},
|
||||
*/
|
||||
public class FluidHandlerItemStack implements IFluidHandler, ICapabilityProvider
|
||||
public class FluidHandlerItemStack implements IFluidHandlerItem, ICapabilityProvider
|
||||
{
|
||||
public static final String FLUID_NBT_KEY = "Fluid";
|
||||
|
||||
protected final ItemStack container;
|
||||
protected final int capacity;
|
||||
@Nonnull
|
||||
protected ItemStack container;
|
||||
protected int capacity;
|
||||
|
||||
/**
|
||||
* @param container The container itemStack, data is stored on it directly as NBT.
|
||||
* @param capacity The maximum capacity of this fluid tank.
|
||||
*/
|
||||
public FluidHandlerItemStack(ItemStack container, int capacity)
|
||||
public FluidHandlerItemStack(@Nonnull ItemStack container, int capacity)
|
||||
{
|
||||
this.container = container;
|
||||
this.capacity = capacity;
|
||||
}
|
||||
|
||||
@Nonnull
|
||||
@Override
|
||||
public ItemStack getContainer()
|
||||
{
|
||||
return container;
|
||||
}
|
||||
|
||||
@Nullable
|
||||
public FluidStack getFluid()
|
||||
{
|
||||
@@ -184,8 +193,7 @@ public class FluidHandlerItemStack implements IFluidHandler, ICapabilityProvider
|
||||
|
||||
/**
|
||||
* Override this method for special handling.
|
||||
* Can be used to swap out the container's item for a different one with "container.setItem".
|
||||
* Can be used to destroy the container with "container.stackSize--"
|
||||
* Can be used to swap out or destroy the container.
|
||||
*/
|
||||
protected void setContainerToEmpty()
|
||||
{
|
||||
@@ -195,14 +203,14 @@ public class FluidHandlerItemStack implements IFluidHandler, ICapabilityProvider
|
||||
@Override
|
||||
public boolean hasCapability(Capability<?> capability, EnumFacing facing)
|
||||
{
|
||||
return capability == CapabilityFluidHandler.FLUID_HANDLER_CAPABILITY;
|
||||
return capability == CapabilityFluidHandler.FLUID_HANDLER_ITEM_CAPABILITY;
|
||||
}
|
||||
|
||||
@SuppressWarnings("unchecked")
|
||||
@Override
|
||||
public <T> T getCapability(Capability<T> capability, EnumFacing facing)
|
||||
{
|
||||
return capability == CapabilityFluidHandler.FLUID_HANDLER_CAPABILITY ? (T) this : null;
|
||||
return capability == CapabilityFluidHandler.FLUID_HANDLER_ITEM_CAPABILITY ? (T) this : null;
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -240,7 +248,7 @@ public class FluidHandlerItemStack implements IFluidHandler, ICapabilityProvider
|
||||
protected void setContainerToEmpty()
|
||||
{
|
||||
super.setContainerToEmpty();
|
||||
container.deserializeNBT(emptyContainer.serializeNBT());
|
||||
container = emptyContainer;
|
||||
}
|
||||
}
|
||||
}
|
||||
+18
-9
@@ -19,6 +19,7 @@
|
||||
|
||||
package net.minecraftforge.fluids.capability.templates;
|
||||
|
||||
import javax.annotation.Nonnull;
|
||||
import javax.annotation.Nullable;
|
||||
|
||||
import net.minecraft.item.ItemStack;
|
||||
@@ -28,33 +29,41 @@ import net.minecraftforge.common.capabilities.Capability;
|
||||
import net.minecraftforge.common.capabilities.ICapabilityProvider;
|
||||
import net.minecraftforge.fluids.FluidStack;
|
||||
import net.minecraftforge.fluids.capability.FluidTankProperties;
|
||||
import net.minecraftforge.fluids.capability.IFluidHandlerItem;
|
||||
import net.minecraftforge.fluids.capability.IFluidTankProperties;
|
||||
import net.minecraftforge.fluids.capability.CapabilityFluidHandler;
|
||||
import net.minecraftforge.fluids.capability.IFluidHandler;
|
||||
|
||||
/**
|
||||
* FluidHandlerItemStackSimple is a template capability provider for ItemStacks.
|
||||
* Data is stored directly in the vanilla NBT, in the same way as the old deprecated {@link ItemFluidContainer}.
|
||||
* Data is stored directly in the vanilla NBT, in the same way as the old ItemFluidContainer.
|
||||
*
|
||||
* This implementation only allows item containers to be fully filled or emptied, similar to vanilla buckets.
|
||||
*/
|
||||
public class FluidHandlerItemStackSimple implements IFluidHandler, ICapabilityProvider
|
||||
public class FluidHandlerItemStackSimple implements IFluidHandlerItem, ICapabilityProvider
|
||||
{
|
||||
public static final String FLUID_NBT_KEY = "Fluid";
|
||||
|
||||
protected final ItemStack container;
|
||||
protected final int capacity;
|
||||
@Nonnull
|
||||
protected ItemStack container;
|
||||
protected int capacity;
|
||||
|
||||
/**
|
||||
* @param container The container itemStack, data is stored on it directly as NBT.
|
||||
* @param capacity The maximum capacity of this fluid tank.
|
||||
*/
|
||||
public FluidHandlerItemStackSimple(ItemStack container, int capacity)
|
||||
public FluidHandlerItemStackSimple(@Nonnull ItemStack container, int capacity)
|
||||
{
|
||||
this.container = container;
|
||||
this.capacity = capacity;
|
||||
}
|
||||
|
||||
@Nonnull
|
||||
@Override
|
||||
public ItemStack getContainer()
|
||||
{
|
||||
return container;
|
||||
}
|
||||
|
||||
@Nullable
|
||||
public FluidStack getFluid()
|
||||
{
|
||||
@@ -171,14 +180,14 @@ public class FluidHandlerItemStackSimple implements IFluidHandler, ICapabilityPr
|
||||
@Override
|
||||
public boolean hasCapability(Capability<?> capability, EnumFacing facing)
|
||||
{
|
||||
return capability == CapabilityFluidHandler.FLUID_HANDLER_CAPABILITY;
|
||||
return capability == CapabilityFluidHandler.FLUID_HANDLER_ITEM_CAPABILITY;
|
||||
}
|
||||
|
||||
@SuppressWarnings("unchecked")
|
||||
@Override
|
||||
public <T> T getCapability(Capability<T> capability, EnumFacing facing)
|
||||
{
|
||||
return capability == CapabilityFluidHandler.FLUID_HANDLER_CAPABILITY ? (T) this : null;
|
||||
return capability == CapabilityFluidHandler.FLUID_HANDLER_ITEM_CAPABILITY ? (T) this : null;
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -216,7 +225,7 @@ public class FluidHandlerItemStackSimple implements IFluidHandler, ICapabilityPr
|
||||
protected void setContainerToEmpty()
|
||||
{
|
||||
super.setContainerToEmpty();
|
||||
container.deserializeNBT(emptyContainer.serializeNBT());
|
||||
container = emptyContainer;
|
||||
}
|
||||
}
|
||||
}
|
||||
+21
-12
@@ -19,6 +19,7 @@
|
||||
|
||||
package net.minecraftforge.fluids.capability.wrappers;
|
||||
|
||||
import javax.annotation.Nonnull;
|
||||
import javax.annotation.Nullable;
|
||||
|
||||
import net.minecraft.init.Items;
|
||||
@@ -33,6 +34,7 @@ import net.minecraftforge.fluids.Fluid;
|
||||
import net.minecraftforge.fluids.FluidRegistry;
|
||||
import net.minecraftforge.fluids.FluidStack;
|
||||
import net.minecraftforge.fluids.capability.FluidTankProperties;
|
||||
import net.minecraftforge.fluids.capability.IFluidHandlerItem;
|
||||
import net.minecraftforge.fluids.capability.IFluidTankProperties;
|
||||
import net.minecraftforge.fluids.UniversalBucket;
|
||||
import net.minecraftforge.fluids.capability.CapabilityFluidHandler;
|
||||
@@ -42,15 +44,23 @@ import net.minecraftforge.fluids.capability.IFluidHandler;
|
||||
* Wrapper for vanilla and forge buckets.
|
||||
* Swaps between empty bucket and filled bucket of the correct type.
|
||||
*/
|
||||
public class FluidBucketWrapper implements IFluidHandler, ICapabilityProvider
|
||||
public class FluidBucketWrapper implements IFluidHandlerItem, ICapabilityProvider
|
||||
{
|
||||
protected final ItemStack container;
|
||||
@Nonnull
|
||||
protected ItemStack container;
|
||||
|
||||
public FluidBucketWrapper(ItemStack container)
|
||||
public FluidBucketWrapper(@Nonnull ItemStack container)
|
||||
{
|
||||
this.container = container;
|
||||
}
|
||||
|
||||
@Nonnull
|
||||
@Override
|
||||
public ItemStack getContainer()
|
||||
{
|
||||
return container;
|
||||
}
|
||||
|
||||
public boolean canFillFluidType(FluidStack fluid)
|
||||
{
|
||||
if (fluid.getFluid() == FluidRegistry.WATER || fluid.getFluid() == FluidRegistry.LAVA || fluid.getFluid().getName().equals("milk"))
|
||||
@@ -89,24 +99,23 @@ public class FluidBucketWrapper implements IFluidHandler, ICapabilityProvider
|
||||
protected void setFluid(Fluid fluid) {
|
||||
if (fluid == null)
|
||||
{
|
||||
container.deserializeNBT(new ItemStack(Items.BUCKET).serializeNBT());
|
||||
container = new ItemStack(Items.BUCKET);
|
||||
}
|
||||
else if (fluid == FluidRegistry.WATER)
|
||||
{
|
||||
container.deserializeNBT(new ItemStack(Items.WATER_BUCKET).serializeNBT());
|
||||
container = new ItemStack(Items.WATER_BUCKET);
|
||||
}
|
||||
else if (fluid == FluidRegistry.LAVA)
|
||||
{
|
||||
container.deserializeNBT(new ItemStack(Items.LAVA_BUCKET).serializeNBT());
|
||||
container = new ItemStack(Items.LAVA_BUCKET);
|
||||
}
|
||||
else if (fluid.getName().equals("milk"))
|
||||
{
|
||||
container.deserializeNBT(new ItemStack(Items.MILK_BUCKET).serializeNBT());
|
||||
container = new ItemStack(Items.MILK_BUCKET);
|
||||
}
|
||||
else if (FluidRegistry.isUniversalBucketEnabled() && FluidRegistry.getBucketFluids().contains(fluid))
|
||||
{
|
||||
ItemStack filledBucket = UniversalBucket.getFilledBucket(ForgeModContainer.getInstance().universalBucket, fluid);
|
||||
container.deserializeNBT(filledBucket.serializeNBT());
|
||||
container = UniversalBucket.getFilledBucket(ForgeModContainer.getInstance().universalBucket, fluid);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -179,15 +188,15 @@ public class FluidBucketWrapper implements IFluidHandler, ICapabilityProvider
|
||||
@Override
|
||||
public boolean hasCapability(Capability<?> capability, EnumFacing facing)
|
||||
{
|
||||
return capability == CapabilityFluidHandler.FLUID_HANDLER_CAPABILITY;
|
||||
return capability == CapabilityFluidHandler.FLUID_HANDLER_ITEM_CAPABILITY;
|
||||
}
|
||||
|
||||
@Override
|
||||
public <T> T getCapability(Capability<T> capability, EnumFacing facing)
|
||||
{
|
||||
if (capability == CapabilityFluidHandler.FLUID_HANDLER_CAPABILITY)
|
||||
if (capability == CapabilityFluidHandler.FLUID_HANDLER_ITEM_CAPABILITY)
|
||||
{
|
||||
return CapabilityFluidHandler.FLUID_HANDLER_CAPABILITY.cast(this);
|
||||
return CapabilityFluidHandler.FLUID_HANDLER_ITEM_CAPABILITY.cast(this);
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
Reference in new issue
Block a user