Package mcp.mobius.waila.api.data

Class ProgressData

java.lang.Object

mcp.mobius.waila.api.data.ProgressData

All Implemented Interfaces:

IData

@NonExtendable
public abstract class ProgressData
extends Object
implements IData

Adds a crafting progress information to an object.

Nested Class Summary

Nested classes/interfaces inherited from interface mcp.mobius.waila.api.IData

IData.Type<D extends IData>

Field Summary

Fields

Modifier and Type	Field	Description
static final ResourceLocation	CONFIG_BAR_HEIGHT
static final ResourceLocation	CONFIG_REPLACE_ITEMS
static final ResourceLocation	CONFIG_TIME
static final ResourceLocation	ID
static final IData.Type<ProgressData>	TYPE

Constructor Summary

Constructors

Constructor	Description
ProgressData()

Method Summary

Modifier and Type	Method	Description
ProgressData	ensureInputSpace(int length)	Ensure the internal list has empty space for the specified amount.
ProgressData	ensureOutputSpace(int length)	Ensure the internal list has empty space for the specified amount.
ProgressData	input(int slot)	Adds an item stack from the specified slot to the input list.
ProgressData	input(int... slots)	Adds an item stack from the specified slots to the input list.
ProgressData	input(Collection<ItemStack> stacks)	Adds item stacks to the input list.
ProgressData	input(ItemStack stack)	Adds an item stack to the input list.
ProgressData	input(ItemStack... stacks)	Adds item stacks to the input list.
ProgressData	itemGetter(IntFunction<ItemStack> getter)	Specify a slot to item stack getter to be used with input(int) and output(int).
ProgressData	output(int slot)	Adds an item stack from the specified slot to the output list.
ProgressData	output(int... slots)	Adds an item stack from the specified slots to the output list.
ProgressData	output(Collection<ItemStack> stacks)	Adds item stacks to the output list.
ProgressData	output(ItemStack stack)	Adds an item stack to the output list.
ProgressData	output(ItemStack... stacks)	Adds item stacks to the output list.
static ProgressData	ratio(float ratio)	Creates a progress data.
static ProgressData	tick(int current, int total)	Creates a progress data.

Methods inherited from class java.lang.Object

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

Methods inherited from interface mcp.mobius.waila.api.IData

type

Field Details

ID

public static final ResourceLocation ID

TYPE

public static final IData.Type<ProgressData> TYPE

CONFIG_TIME

public static final ResourceLocation CONFIG_TIME

CONFIG_BAR_HEIGHT

public static final ResourceLocation CONFIG_BAR_HEIGHT

CONFIG_REPLACE_ITEMS

public static final ResourceLocation CONFIG_REPLACE_ITEMS

Constructor Details

ProgressData

public ProgressData()

Method Details

ratio

public static ProgressData ratio(float ratio)

Creates a progress data.

Prefer tick(int, int) if the information present.

Do NOT add a data if the current progress is zero.

Parameters:

ratio - the ratio of the progress ranging from 0.0f to 1.0f

tick

public static ProgressData tick(int current,
 int total)

Creates a progress data.

Unlike ratio(float), this version also adds an estimated time to finish on the tooltip.

Do NOT add a data if the current progress is zero.

Parameters:

current - the current tick progress for the process

total - the estimated total tick for the process

input

public ProgressData input(ItemStack stack)

Adds an item stack to the input list.

input

public ProgressData input(ItemStack... stacks)

Adds item stacks to the input list.

input

public ProgressData input(Collection<ItemStack> stacks)

Adds item stacks to the input list.

input

public ProgressData input(int slot)

Adds an item stack from the specified slot to the input list.

A stack getter needs to be specified with itemGetter(IntFunction).

input

public ProgressData input(int... slots)

Adds an item stack from the specified slots to the input list.

A stack getter needs to be specified with itemGetter(IntFunction).

output

public ProgressData output(ItemStack stack)

Adds an item stack to the output list.

output

public ProgressData output(ItemStack... stacks)

Adds item stacks to the output list.

output

public ProgressData output(Collection<ItemStack> stacks)

Adds item stacks to the output list.

output

public ProgressData output(int slot)

Adds an item stack from the specified slot to the output list.

A stack getter needs to be specified with itemGetter(IntFunction).

output

public ProgressData output(int... slots)

Adds an item stack from the specified slots to the output list.

A stack getter needs to be specified with itemGetter(IntFunction).

itemGetter

public ProgressData itemGetter(IntFunction<ItemStack> getter)

Specify a slot to item stack getter to be used with input(int) and output(int).

ensureInputSpace

public ProgressData ensureInputSpace(int length)

Ensure the internal list has empty space for the specified amount.

ensureOutputSpace

public ProgressData ensureOutputSpace(int length)

Ensure the internal list has empty space for the specified amount.