Fluid API rework (#5983)

- Moved forge fluids into FluidAttributes companion object to the vanilla Fluid. By gigaherz
- Redesigned the Fluid API to be closer to the Items API. By King Lemming
Co-authored-by: King Lemming <[email protected]>
This commit is contained in:
David Quintana committed 2019-08-29 03:18:41 +02:00
1 parent e784a7f606
commit b7e1cc5f6b
48 files changed
+1077 -2193

No files matched your search

@@ -32,7 +32,7 @@ public class FluidContainerColorer implements IItemColor
{
if (tintIndex != 1) return 0xFFFFFFFF;
return FluidUtil.getFluidContained(stack)
.map(fstack -> fstack.getFluid().getColor(fstack))
.map(fstack -> fstack.getFluid().getAttributes().getColor(fstack))
.orElse(0xFFFFFFFF);
}
}
@@ -1,50 +0,0 @@
/*
* Minecraft Forge
* Copyright (c) 2016-2019.
*
* 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.client;
import net.minecraftforge.client.event.ColorHandlerEvent;
import net.minecraftforge.client.event.ModelRegistryEvent;
import net.minecraftforge.client.model.ModelLoader;
import net.minecraftforge.common.ForgeMod;
import net.minecraftforge.eventbus.api.SubscribeEvent;
import net.minecraftforge.fluids.FluidRegistry;
public class ForgeClientHandler
{
@SubscribeEvent
public static void registerModels(ModelRegistryEvent event)
{
// register model for the universal bucket, if it exists
if (FluidRegistry.isUniversalBucketEnabled())
{
// TODO no more mesh definitions, this should be implemented with overrides
// ModelLoader.setBucketModelDefinition(ForgeMod.getInstance().universalBucket);
}
}
@SubscribeEvent
public static void registerItemHandlers(ColorHandlerEvent.Item event)
{
if (FluidRegistry.isUniversalBucketEnabled())
{
event.getItemColors().register(new FluidContainerColorer(), ForgeMod.getInstance().universalBucket);
}
}
}
@@ -560,6 +560,15 @@ public class ForgeHooksClient
}
}
public static TextureAtlasSprite[] getFluidSprites(IEnviromentBlockReader world, BlockPos pos, IFluidState fluidStateIn)
{
AtlasTexture atlas = Minecraft.getInstance().getTextureMap();
return new TextureAtlasSprite[] {
atlas.getSprite(fluidStateIn.getFluid().getAttributes().getStill(world, pos)),
atlas.getSprite(fluidStateIn.getFluid().getAttributes().getFlowing(world, pos)),
};
}
private static class LightGatheringTransformer extends QuadGatheringTransformer {
private static final VertexFormat FORMAT = new VertexFormat().addElement(DefaultVertexFormats.TEX_2F).addElement(DefaultVertexFormats.TEX_2S);
@@ -37,6 +37,7 @@ import net.minecraft.client.renderer.texture.AtlasTexture;
import net.minecraft.client.renderer.vertex.VertexFormat;
import net.minecraft.client.resources.data.AnimationMetadataSection;
import net.minecraft.entity.LivingEntity;
import net.minecraft.fluid.Fluid;
import net.minecraft.item.ItemStack;
import net.minecraft.resources.IResource;
import net.minecraft.resources.IResourceManager;
@@ -46,7 +47,6 @@ import net.minecraft.world.World;
import net.minecraftforge.versions.forge.ForgeVersion;
import net.minecraftforge.common.model.IModelState;
import net.minecraftforge.common.model.TRSRTransformation;
import net.minecraftforge.fluids.Fluid;
import net.minecraftforge.fluids.FluidUtil;
import java.util.function.Function;
@@ -113,7 +113,7 @@ public final class ModelDynBucket implements IUnbakedModel
if (coverLocation != null)
builder.add(coverLocation);
if (fluid != null)
builder.add(fluid.getStill());
builder.add(fluid.getAttributes().getStillTexture());
return builder.build();
}
@@ -132,7 +132,7 @@ public final class ModelDynBucket implements IUnbakedModel
ImmutableMap<TransformType, TRSRTransformation> transformMap = PerspectiveMapWrapper.getTransforms(state);
// if the fluid is lighter than air, will manipulate the initial state to be rotated 180° to turn it upside down
if (flipGas && fluid != null && fluid.isLighterThanAir())
if (flipGas && fluid != null && fluid.getAttributes().isLighterThanAir())
{
sprite = new ModelStateComposition(state, TRSRTransformation.blockCenterToCorner(new TRSRTransformation(null, new Quat4f(0, 0, 1, 0), null, null)));
state = sprite.getState();
@@ -144,7 +144,7 @@ public final class ModelDynBucket implements IUnbakedModel
ImmutableList.Builder<BakedQuad> builder = ImmutableList.builder();
if(fluid != null) {
fluidSprite = spriteGetter.apply(fluid.getStill());
fluidSprite = spriteGetter.apply(fluid.getAttributes().getStillTexture());
}
Random random = new Random();
@@ -160,8 +160,8 @@ public final class ModelDynBucket implements IUnbakedModel
{
TextureAtlasSprite liquid = spriteGetter.apply(liquidLocation);
// build liquid layer (inside)
builder.addAll(ItemTextureQuadConverter.convertTexture(format, transform, liquid, fluidSprite, NORTH_Z_FLUID, Direction.NORTH, tint ? fluid.getColor() : 0xFFFFFFFF, 1));
builder.addAll(ItemTextureQuadConverter.convertTexture(format, transform, liquid, fluidSprite, SOUTH_Z_FLUID, Direction.SOUTH, tint ? fluid.getColor() : 0xFFFFFFFF, 1));
builder.addAll(ItemTextureQuadConverter.convertTexture(format, transform, liquid, fluidSprite, NORTH_Z_FLUID, Direction.NORTH, tint ? fluid.getAttributes().getColor() : 0xFFFFFFFF, 1));
builder.addAll(ItemTextureQuadConverter.convertTexture(format, transform, liquid, fluidSprite, SOUTH_Z_FLUID, Direction.SOUTH, tint ? fluid.getAttributes().getColor() : 0xFFFFFFFF, 1));
particleSprite = fluidSprite;
}
if (coverLocation != null)
@@ -441,7 +441,7 @@ public final class ModelDynBucket implements IUnbakedModel
BakedDynBucket model = (BakedDynBucket)originalModel;
Fluid fluid = fluidStack.getFluid();
String name = fluid.getName();
String name = fluid.getAttributes().getName();
if (!model.cache.containsKey(name))
{
@@ -37,6 +37,7 @@ import net.minecraft.client.renderer.model.ItemCameraTransforms.TransformType;
import net.minecraft.client.renderer.texture.ISprite;
import net.minecraft.client.renderer.texture.TextureAtlasSprite;
import net.minecraft.client.renderer.vertex.VertexFormat;
import net.minecraft.fluid.Fluid;
import net.minecraft.resources.IResourceManager;
import net.minecraft.util.Direction;
import net.minecraft.util.ResourceLocation;
@@ -45,10 +46,9 @@ import net.minecraftforge.client.model.data.IModelData;
import net.minecraftforge.client.model.pipeline.IVertexConsumer;
import net.minecraftforge.client.model.pipeline.TRSRTransformer;
import net.minecraftforge.client.model.pipeline.UnpackedBakedQuad;
import net.minecraftforge.fluids.FluidAttributes;
import net.minecraftforge.versions.forge.ForgeVersion;
import net.minecraftforge.common.model.IModelState;
import net.minecraftforge.common.model.TRSRTransformation;
import net.minecraftforge.fluids.Fluid;
import org.apache.commons.lang3.tuple.Pair;
import org.apache.logging.log4j.LogManager;
@@ -79,9 +79,10 @@ public final class ModelFluid implements IUnbakedModel
@Override
public Collection<ResourceLocation> getTextures(Function<ResourceLocation, IUnbakedModel> modelGetter, Set<String> missingTextureErrors)
{
return fluid.getOverlay() != null
? ImmutableSet.of(fluid.getStill(), fluid.getFlowing(), fluid.getOverlay())
: ImmutableSet.of(fluid.getStill(), fluid.getFlowing());
FluidAttributes attrs = fluid.getAttributes();
return attrs.getOverlayTexture() != null
? ImmutableSet.of(attrs.getStillTexture(), attrs.getFlowingTexture(), attrs.getOverlayTexture())
: ImmutableSet.of(attrs.getStillTexture(), attrs.getFlowingTexture());
}
@Override
@@ -93,15 +94,16 @@ public final class ModelFluid implements IUnbakedModel
@Override
public IBakedModel bake(ModelBakery bakery, Function<ResourceLocation, TextureAtlasSprite> spriteGetter, ISprite sprite, VertexFormat format)
{
FluidAttributes attrs = fluid.getAttributes();
return new CachingBakedFluid(
sprite.getState().apply(Optional.empty()),
PerspectiveMapWrapper.getTransforms(sprite.getState()),
format,
fluid.getColor(),
spriteGetter.apply(fluid.getStill()),
spriteGetter.apply(fluid.getFlowing()),
Optional.ofNullable(fluid.getOverlay()).map(spriteGetter),
fluid.isLighterThanAir(),
attrs.getColor(),
spriteGetter.apply(attrs.getStillTexture()),
spriteGetter.apply(attrs.getFlowingTexture()),
Optional.ofNullable(attrs.getOverlayTexture()).map(spriteGetter),
attrs.isLighterThanAir(),
null
);
}
@@ -85,7 +85,6 @@ import net.minecraftforge.common.model.Models;
import net.minecraftforge.common.model.TRSRTransformation;
import net.minecraftforge.common.model.animation.IClip;
import net.minecraftforge.common.property.Properties;
import net.minecraftforge.fluids.FluidRegistry;
import net.minecraftforge.fml.client.ClientModLoader;
import net.minecraftforge.logging.ModelLoaderErrorMessage;
import net.minecraftforge.registries.IRegistryDelegate;