Package alexiil.mc.lib.attributes.fluid.volume

Class FluidTooltipContext

java.lang.Object

alexiil.mc.lib.attributes.fluid.volume.FluidTooltipContext

public final class FluidTooltipContext
extends Object

Stores various options for creating tooltips for fluids. This is meant to wrap a TooltipContext, but has a lot more options specific to fluids and isn't limited to the client side only.

Field Summary

Fields

Modifier and Type	Field	Description
static FluidTooltipContext	USE_CONFIG	The default context, that lets the user decide how they want to see tooltips.

Method Summary

Modifier and Type	Method	Description
FluidTooltipContext	forceAdvanced(boolean enable)
FluidTooltipContext	forceDisableEmphasisColours(boolean disable)
FluidTooltipContext	forceDisableFluidColours(boolean disable)
FluidTooltipContext	forceJoinedName(boolean enable)
FluidTooltipContext	forceShortDesc(boolean enable)
FluidTooltipContext	forceSymbols(boolean enable)
FluidTooltipContext	forceTicks(boolean enable)
static FluidTooltipContext	fromMinecraft(net.minecraft.client.item.TooltipContext ctx)
int	getTimeGap()
boolean	isAdvanced()
boolean	shouldDisableEmphasisColours()
boolean	shouldJoinNameWithAmount()
boolean	shouldStripFluidColours()
boolean	shouldUseShortDescription()
boolean	shouldUseSymbols()
boolean	shouldUseTicks()
net.minecraft.text.Text	stripFluidColours(net.minecraft.text.Text fluidName)	Strips any colours from the given name if shouldStripFluidColours() is true, otherwise returns the fluid name as-is.
FluidTooltipContext	usingConfigForEmphasisColours()
FluidTooltipContext	usingConfigForFluidColours()
FluidTooltipContext	usingConfigForJoinedName()
FluidTooltipContext	usingConfigForShortDesc()
FluidTooltipContext	usingConfigForSymbols()
FluidTooltipContext	usingConfigForTicks()
FluidTooltipContext	usingMcAdvanced()

Methods inherited from class java.lang.Object

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

Field Details

USE_CONFIG

public static final FluidTooltipContext USE_CONFIG

The default context, that lets the user decide how they want to see tooltips.

Method Details

fromMinecraft

public static FluidTooltipContext fromMinecraft(net.minecraft.client.item.TooltipContext ctx)

isAdvanced

public boolean isAdvanced()

Returns:

True to add advanced details, or false otherwise. Note that this returns GameOptions#advancedItemTooltips by default.

shouldUseSymbols

public boolean shouldUseSymbols()

shouldUseTicks

public boolean shouldUseTicks()

getTimeGap

public int getTimeGap()

Returns:

The number of ticks between each unit of time. (so 1 for ticks, and 20 for seconds).

shouldUseShortDescription

public boolean shouldUseShortDescription()

shouldStripFluidColours

public boolean shouldStripFluidColours()

shouldDisableEmphasisColours

public boolean shouldDisableEmphasisColours()

shouldJoinNameWithAmount

public boolean shouldJoinNameWithAmount()

usingMcAdvanced

public FluidTooltipContext usingMcAdvanced()

Returns:

A FluidTooltipContext which uses MinecraftClient.options.advancedItemTooltips for isAdvanced().

forceAdvanced

public FluidTooltipContext forceAdvanced(boolean enable)

Returns:

A FluidTooltipContext which uses the given value for isAdvanced().

usingConfigForSymbols

public FluidTooltipContext usingConfigForSymbols()

Returns:

A FluidTooltipContext which uses the LBA fluids config file for shouldUseSymbols().

forceSymbols

public FluidTooltipContext forceSymbols(boolean enable)

usingConfigForTicks

public FluidTooltipContext usingConfigForTicks()

Returns:

A FluidTooltipContext which uses the LBA fluids config file for shouldUseTicks().

forceTicks

public FluidTooltipContext forceTicks(boolean enable)

usingConfigForShortDesc

public FluidTooltipContext usingConfigForShortDesc()

Returns:

A FluidTooltipContext which uses the LBA fluids config file for shouldUseTicks().

forceShortDesc

public FluidTooltipContext forceShortDesc(boolean enable)

usingConfigForFluidColours

public FluidTooltipContext usingConfigForFluidColours()

Returns:

A FluidTooltipContext which uses the LBA fluids config file for shouldStripFluidColours().

forceDisableFluidColours

public FluidTooltipContext forceDisableFluidColours(boolean disable)

usingConfigForEmphasisColours

public FluidTooltipContext usingConfigForEmphasisColours()

Returns:

A FluidTooltipContext which uses the LBA fluids config file for shouldDisableEmphasisColours().

forceDisableEmphasisColours

public FluidTooltipContext forceDisableEmphasisColours(boolean disable)

usingConfigForJoinedName

public FluidTooltipContext usingConfigForJoinedName()

Returns:

A FluidTooltipContext which uses the LBA fluids config file for shouldJoinNameWithAmount().

forceJoinedName

public FluidTooltipContext forceJoinedName(boolean enable)

stripFluidColours

public net.minecraft.text.Text stripFluidColours(net.minecraft.text.Text fluidName)

Strips any colours from the given name if shouldStripFluidColours() is true, otherwise returns the fluid name as-is.