Package codechicken.lib.gui.modular.elements

Class GuiFluidTank

java.lang.Object

codechicken.lib.gui.modular.lib.geometry.ConstrainedGeometry<GuiFluidTank>

codechicken.lib.gui.modular.elements.GuiElement<GuiFluidTank>

codechicken.lib.gui.modular.elements.GuiFluidTank

All Implemented Interfaces:

BackgroundRender, ElementEvents, GuiParent<GuiFluidTank>, TooltipHandler<GuiFluidTank>

public class GuiFluidTank
extends GuiElement<GuiFluidTank>
implements BackgroundRender

When implementing this tank, you must specify the tank capacity in mb, And then you have two options for specifying the tank contents. You can set the fluid and the amount stored, Or you can provide a FluidStack

Created by brandon3055 on 11/09/2023

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	GuiFluidTank.FluidTank

Field Summary

Fields

Modifier and Type	Field	Description
static final Material	DEFAULT_WINDOW

Fields inherited from class codechicken.lib.gui.modular.elements.GuiElement

hoverTime, initialized

Constructor Summary

Constructors

Constructor	Description
GuiFluidTank(@NotNull GuiParent<?> parent)

Method Summary

Modifier and Type	Method	Description
static BiFunction<net.neoforged.neoforge.fluids.FluidStack,Long,List<net.minecraft.network.chat.Component>>	defaultFormatter()
Long	getCapacity()
static int	getColour(net.minecraft.world.level.material.Fluid fluid)
static int	getColour(net.neoforged.neoforge.fluids.FluidStack fluidStack)
net.neoforged.neoforge.fluids.FluidStack	getFluidStack()
static @Nullable net.minecraft.client.renderer.texture.TextureAtlasSprite	getStillTexture(net.minecraft.world.level.material.Fluid fluid)
static @Nullable net.minecraft.client.renderer.texture.TextureAtlasSprite	getStillTexture(net.neoforged.neoforge.fluids.FluidStack stack)
void	renderBackground(GuiRender render, double mouseX, double mouseY, float partialTicks)	Used to render content behind this elements child elements.
GuiFluidTank	setCapacity(long capacity)	Sets the capacity of this tank in milli-buckets.
GuiFluidTank	setCapacity(Supplier<Long> capacity)	Supply the capacity of this tank in milli-buckets.
GuiFluidTank	setDrawGauge(boolean drawGauge)	Enable the built-in fluid gauge lines.
GuiFluidTank	setFluidStack(Supplier<net.neoforged.neoforge.fluids.FluidStack> fluidStack)	Allows you to supply the current stored fluid stack.
GuiFluidTank	setFluidStack(net.neoforged.neoforge.fluids.FluidStack fluidStack)	Allows you to set the current stored fluid stack.
GuiFluidTank	setGaugeColour(int gaugeColour)	Sets the colour of the built-in fluid gauge lines
GuiFluidTank	setToolTipFormatter(BiFunction<net.neoforged.neoforge.fluids.FluidStack,Long,List<net.minecraft.network.chat.Component>> toolTipFormatter)	Install a custom formatter to control how the fluid tool tip renders.
GuiFluidTank	setWindow(@Nullable Material window)	Sets the tank window texture, Will be tiled to fit the tank size.
static GuiFluidTank.FluidTank	simpleTank(@NotNull GuiParent<?> parent)	Creates a simple tank using a simple slot as a background to make it look nice.

Methods inherited from class codechicken.lib.gui.modular.elements.GuiElement

addChild, addJeiDropTargets, addJeiExclusions, adoptChild, applyQueuedChildUpdates, blockMouseEvents, blockMouseOver, bringChildToForeground, font, getChildren, getCombinedElementDepth, getJeiDropConsumer, getModularGui, getParent, getTooltip, getTooltipDelay, hoverTime, initElement, isDescendantOf, isEnabled, isJeiDropTarget, isJeiExcluded, isMouseOver, isOpaque, isRemoved, isTooltipEnabled, jeiExclude, mc, onScreenInit, removeChild, render, renderChild, renderOverlay, scaledScreenHeight, scaledScreenWidth, sendChildToBackground, sendChildToIndex, setEnabled, setEnabled, setEnableToolTip, setJeiDropTarget, setJeiExcluded, setOpaque, setRenderCull, setTooltip, setTooltipDelay, setZStacking, showToolTip, tick, toString, updateMouseOver, updateScreenData, zStacking

Methods inherited from class codechicken.lib.gui.modular.lib.geometry.ConstrainedGeometry

addBoundsToRect, clearConstraints, clearGeometryCache, constrain, get, getChildBounds, getEnclosingRect, getParent, getPosition, getRectangle, placeInside, placeInside, placeOutside, placeOutside, setHeight, setPos, setSize, setWidth, setXPos, setYPos, strictMode, validate, xCenter, xMax, xMin, xSize, yCenter, yMax, yMin, ySize

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface codechicken.lib.gui.modular.lib.BackgroundRender

getBackgroundDepth

Methods inherited from interface codechicken.lib.gui.modular.lib.ElementEvents

charTyped, charTyped, keyPressed, keyPressed, keyReleased, keyReleased, mouseClicked, mouseClicked, mouseMoved, mouseReleased, mouseReleased, mouseScrolled, mouseScrolled

Methods inherited from interface codechicken.lib.gui.modular.lib.geometry.GuiParent

addChild, getValue

Methods inherited from interface codechicken.lib.gui.modular.lib.TooltipHandler

renderTooltip, setTooltip, setTooltip, setTooltip, setTooltipSingle, setTooltipSingle

Field Details

DEFAULT_WINDOW

public static final Material DEFAULT_WINDOW

Constructor Details

GuiFluidTank

public GuiFluidTank(@NotNull
 @NotNull GuiParent<?> parent)

Method Details

simpleTank

public static GuiFluidTank.FluidTank simpleTank(@NotNull
 @NotNull GuiParent<?> parent)

Creates a simple tank using a simple slot as a background to make it look nice.

setCapacity

public GuiFluidTank setCapacity(long capacity)

Sets the capacity of this tank in milli-buckets.

setCapacity

public GuiFluidTank setCapacity(Supplier<Long> capacity)

Supply the capacity of this tank in milli-buckets.

setFluidStack

public GuiFluidTank setFluidStack(net.neoforged.neoforge.fluids.FluidStack fluidStack)

Allows you to set the current stored fluid stack.

setFluidStack

public GuiFluidTank setFluidStack(Supplier<net.neoforged.neoforge.fluids.FluidStack> fluidStack)

Allows you to supply the current stored fluid stack.

setToolTipFormatter

public GuiFluidTank setToolTipFormatter(BiFunction<net.neoforged.neoforge.fluids.FluidStack,Long,List<net.minecraft.network.chat.Component>> toolTipFormatter)

Install a custom formatter to control how the fluid tool tip renders.

setWindow

public GuiFluidTank setWindow(@Nullable
 @Nullable Material window)

Sets the tank window texture, Will be tiled to fit the tank size.

Parameters:

window - New window texture or null for no window texture.

setDrawGauge

public GuiFluidTank setDrawGauge(boolean drawGauge)

Enable the built-in fluid gauge lines.

setGaugeColour

public GuiFluidTank setGaugeColour(int gaugeColour)

Sets the colour of the built-in fluid gauge lines

getCapacity

public Long getCapacity()

getFluidStack

public net.neoforged.neoforge.fluids.FluidStack getFluidStack()

renderBackground

public void renderBackground(GuiRender render,
 double mouseX,
 double mouseY,
 float partialTicks)

Description copied from interface: BackgroundRender

Used to render content behind this elements child elements. When rendering element content, always use the PoseStack available via the provided GuiRender Where applicable, always use push/pop to ensure the stack is returned to its original state after your rendering is complete.

Specified by:

renderBackground in interface BackgroundRender

Parameters:

render - Contains gui context information as well as essential render methods/utils including the PoseStack.

defaultFormatter

public static BiFunction<net.neoforged.neoforge.fluids.FluidStack,Long,List<net.minecraft.network.chat.Component>> defaultFormatter()

getColour

public static int getColour(net.neoforged.neoforge.fluids.FluidStack fluidStack)

getColour

public static int getColour(net.minecraft.world.level.material.Fluid fluid)

getStillTexture

@Nullable
public static @Nullable net.minecraft.client.renderer.texture.TextureAtlasSprite getStillTexture(net.neoforged.neoforge.fluids.FluidStack stack)

getStillTexture

@Nullable
public static @Nullable net.minecraft.client.renderer.texture.TextureAtlasSprite getStillTexture(net.minecraft.world.level.material.Fluid fluid)