net.minecraftforge.fml.common.progress

Class ProgressBar

java.lang.Object

net.minecraftforge.fml.common.progress.ProgressBar

All Implemented Interfaces:

java.lang.AutoCloseable

public final class ProgressBar
extends java.lang.Object
implements java.lang.AutoCloseable

Not a fully fleshed out API, may change in future MC versions. However feel free to use and suggest additions.

Constructor Summary

Constructors

Constructor and Description
ProgressBar(java.lang.String title, int totalSteps, java.util.function.Function<java.lang.String,java.lang.String> stripChars, IProgressBarTracker tracker)

Method Summary

Modifier and Type	Method and Description
void	close()
org.apache.commons.lang3.tuple.Pair<java.lang.Integer,java.lang.String>	getStepAndMessage() Get the current step and message.
java.lang.String	getTitle() Get the current title.
int	getTotalSteps() Get the total number of steps.
void	step(java.lang.Class<?> classToName, java.lang.String... extra)
void	step(java.lang.String newMessage)

Methods inherited from class java.lang.Object

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

Constructor Detail

ProgressBar

public ProgressBar(java.lang.String title,
                   int totalSteps,
                   java.util.function.Function<java.lang.String,java.lang.String> stripChars,
                   IProgressBarTracker tracker)

Method Detail

step

public void step(java.lang.Class<?> classToName,
                 java.lang.String... extra)

step

public void step(java.lang.String newMessage)

getStepAndMessage

public org.apache.commons.lang3.tuple.Pair<java.lang.Integer,java.lang.String> getStepAndMessage()

Get the current step and message.

getTotalSteps

public int getTotalSteps()

Get the total number of steps.

getTitle

public java.lang.String getTitle()

Get the current title.

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable