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

Class FluidUnit

java.lang.Object

alexiil.mc.lib.attributes.fluid.volume.FluidUnitBase

alexiil.mc.lib.attributes.fluid.volume.FluidUnit

All Implemented Interfaces:

Comparable<FluidUnit>

public final class FluidUnit
extends FluidUnitBase
implements Comparable<FluidUnit>

A single unit that a FluidVolume may be expressed as, for example a bucket or a bottle.

Units are localised according to the key given, prefixed with LOCALE_KEY_PREFIX ("libblockattributes.fluid_unit."), and suffixed with either LOCALE_KEY_SUFFIX_SINGLE (".singular"), LOCALE_KEY_SUFFIX_MULTIPLE (".plural"), or LOCALE_KEY_SUFFIX_SYMBOL (".symbol").

Their are several methods for localising fluid amounts, summarised here:

Name	Description	Example (long names)
FluidUnitBase.localizeAmount(FluidAmount)	Unit name and amount together. The plural name will be used if the amount doesn't equal the unit.	15 Buckets
FluidUnitBase.localizeAmount(FluidAmount, boolean)	Similar to the above, but allows you to force the usage of the singular name.	1 Buckets
FluidUnitBase.localizeEmptyTank(FluidAmount)	A tank with no fluid contained.	Empty 10 Bucket Tank
FluidUnitBase.localizeFullTank(FluidAmount)	A tank which is completely full.	Full 10 Bucket Tank
FluidUnitBase.localizeTank(FluidAmount, FluidAmount)	General-purpose method for all tanks. (If the amount is zero then this delegates to FluidUnitBase.localizeEmptyTank(FluidAmount), and if the amount is equal to the capacity then this delegates to FluidUnitBase.localizeFullTank(FluidAmount)).	3 Buckets in a 10 Bucket Tank
FluidUnitBase.localizeFlowRate(FluidAmount)	Flow rate of a fluid, in ticks. (This may use seconds if this has been configured to do so, but the passed amount should always be in ticks, or a 1/20 of a second).	3 Buckets per second

There is also a Text based version of every method above. (For each of the 2 method variants there's also one for each which takes a 1620 fixed-fraction integer-based value (old LBA style)).

Field Summary

Fields

Modifier and Type	Field	Description
static FluidUnit	BOTTLE
static FluidUnit	BUCKET
static String	LOCALE_KEY_PREFIX
static String	LOCALE_KEY_SUFFIX_MULTIPLE
static String	LOCALE_KEY_SUFFIX_SINGLE
static String	LOCALE_KEY_SUFFIX_SYMBOL

Constructor Summary

Constructors

Constructor	Description
FluidUnit(int unitAmount, String key)	Deprecated, for removal: This API element is subject to removal in a future version. Replaced by FluidUnit(FluidAmount, String).
FluidUnit(FluidAmount unitAmount, String key)

Method Summary

Modifier and Type	Method	Description
int	compareTo(FluidUnit o)
net.minecraft.text.Text	getAmount(FluidAmount amount, boolean forceSingular, net.minecraft.text.Text fluidName, FluidTooltipContext ctx)
net.minecraft.text.Text	getEmptyTank(FluidAmount capacity, FluidTooltipContext ctx)
net.minecraft.text.Text	getFlowRate(FluidAmount amountPerTick, net.minecraft.text.Text fluidName, FluidTooltipContext ctx)
net.minecraft.text.Text	getFullTank(FluidAmount capacity, net.minecraft.text.Text fluidName, FluidTooltipContext ctx)
net.minecraft.text.Text	getPartialTank(FluidAmount amount, FluidAmount capacity, net.minecraft.text.Text fluidName, FluidTooltipContext ctx)
String	localizeAmount(FluidAmount amount, boolean forceSingular, net.minecraft.text.Text fluidName, FluidTooltipContext ctx)
String	localizeEmptyTank(FluidAmount capacity, FluidTooltipContext ctx)
String	localizeFlowRate(FluidAmount amountPerTick, net.minecraft.text.Text fluidName, FluidTooltipContext ctx)
String	localizeFullTank(FluidAmount capacity, net.minecraft.text.Text fluidName, FluidTooltipContext ctx)
String	localizePartialTank(FluidAmount amount, FluidAmount capacity, net.minecraft.text.Text fluidName, FluidTooltipContext ctx)

Methods inherited from class alexiil.mc.lib.attributes.fluid.volume.FluidUnitBase

getAmount, getAmount, getAmount, getAmount, getAmount, getAmount, getAmount, getEmptyTank, getFlowRate, getFlowRate, getFlowRate, getFullTank, getFullTank, getFullTank, getPartialTank, getPartialTank, getPartialTank, getTank, getTank, getTank, getTank, localizeAmount, localizeAmount, localizeAmount, localizeAmount, localizeAmount, localizeAmount, localizeAmount, localizeEmptyTank, localizeFlowRate, localizeFlowRate, localizeFlowRate, localizeFullTank, localizeFullTank, localizeFullTank, localizePartialTank, localizePartialTank, localizePartialTank, localizeTank, localizeTank, localizeTank, localizeTank

Methods inherited from class java.lang.Object

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

Field Details

LOCALE_KEY_PREFIX

public static final String LOCALE_KEY_PREFIX

See Also:

Constant Field Values

LOCALE_KEY_SUFFIX_SINGLE

public static final String LOCALE_KEY_SUFFIX_SINGLE

See Also:

Constant Field Values

LOCALE_KEY_SUFFIX_MULTIPLE

public static final String LOCALE_KEY_SUFFIX_MULTIPLE

See Also:

Constant Field Values

LOCALE_KEY_SUFFIX_SYMBOL

public static final String LOCALE_KEY_SUFFIX_SYMBOL

See Also:

Constant Field Values

BUCKET

public static final FluidUnit BUCKET

BOTTLE

public static final FluidUnit BOTTLE

Constructor Details

FluidUnit

@Deprecated(since="0.6.4",
            forRemoval=true)
public FluidUnit(int unitAmount,
 String key)

Deprecated, for removal: This API element is subject to removal in a future version.

Replaced by FluidUnit(FluidAmount, String).

Parameters:

key - The name for this unit. (Please refer to FluidUnit(FluidAmount, String) for the full description of what language keys you need to add).

FluidUnit

public FluidUnit(FluidAmount unitAmount,
 String key)

Parameters:

key - The name for this unit. You should add 3 language keys to your language file for each separate key you make:

Name	Locale Key	Example for Buckets	Example for Ingots
Singular	"libblockattributes.fluid_unit.KEY.singular"	Bucket	Ingot
Plural	"libblockattributes.fluid_unit.KEY.plural"	Buckets	Ingots
Singular	"libblockattributes.fluid_unit.KEY.symbol"	B	I

(But replace "KEY" with the string you pass in here).

Method Details

localizeAmount

public String localizeAmount(FluidAmount amount,
 boolean forceSingular,
 @Nullable
 net.minecraft.text.Text fluidName,
 FluidTooltipContext ctx)

Specified by:

localizeAmount in class FluidUnitBase

getAmount

public net.minecraft.text.Text getAmount(FluidAmount amount,
 boolean forceSingular,
 @Nullable
 net.minecraft.text.Text fluidName,
 FluidTooltipContext ctx)

Specified by:

getAmount in class FluidUnitBase

localizeEmptyTank

public String localizeEmptyTank(FluidAmount capacity,
 FluidTooltipContext ctx)

Specified by:

localizeEmptyTank in class FluidUnitBase

getEmptyTank

public net.minecraft.text.Text getEmptyTank(FluidAmount capacity,
 FluidTooltipContext ctx)

Specified by:

getEmptyTank in class FluidUnitBase

localizeFullTank

public String localizeFullTank(FluidAmount capacity,
 @Nullable
 net.minecraft.text.Text fluidName,
 FluidTooltipContext ctx)

Specified by:

localizeFullTank in class FluidUnitBase

getFullTank

public net.minecraft.text.Text getFullTank(FluidAmount capacity,
 @Nullable
 net.minecraft.text.Text fluidName,
 FluidTooltipContext ctx)

Specified by:

getFullTank in class FluidUnitBase

localizePartialTank

public String localizePartialTank(FluidAmount amount,
 FluidAmount capacity,
 @Nullable
 net.minecraft.text.Text fluidName,
 FluidTooltipContext ctx)

Specified by:

localizePartialTank in class FluidUnitBase

getPartialTank

public net.minecraft.text.Text getPartialTank(FluidAmount amount,
 FluidAmount capacity,
 @Nullable
 net.minecraft.text.Text fluidName,
 FluidTooltipContext ctx)

Specified by:

getPartialTank in class FluidUnitBase

localizeFlowRate

public String localizeFlowRate(FluidAmount amountPerTick,
 @Nullable
 net.minecraft.text.Text fluidName,
 FluidTooltipContext ctx)

Specified by:

localizeFlowRate in class FluidUnitBase

getFlowRate

public net.minecraft.text.Text getFlowRate(FluidAmount amountPerTick,
 @Nullable
 net.minecraft.text.Text fluidName,
 FluidTooltipContext ctx)

Specified by:

getFlowRate in class FluidUnitBase

compareTo

public int compareTo(FluidUnit o)

Specified by:

compareTo in interface Comparable<FluidUnit>