net.neoforged.cliutils.progress

Interface ProgressManager

All Known Implementing Classes:

ProgressReporter

public interface ProgressManager

A manager that changes the progress of a progress bar, to indicate the current progress to users.

Method Summary

Modifier and Type	Method and Description
void	setIndeterminate(boolean indeterminate) Sets whether the max progress is known or not.
void	setMaxProgress(int maxProgress) Sets the max progress of the manager.
void	setPercentageProgress(double progress) Sets progress of the manager, based on a fractional value.
void	setProgress(int progress) Sets the current progress of the manager.
void	setStep(java.lang.String name) Sets the current step to be shown to the user.

Method Detail

setMaxProgress

void setMaxProgress(int maxProgress)

Sets the max progress of the manager.

setProgress

void setProgress(int progress)

Sets the current progress of the manager.

setPercentageProgress

void setPercentageProgress(double progress)

Sets progress of the manager, based on a fractional value.
Note: this also sets the setMaxProgress(int) to 100.

setStep

void setStep(java.lang.String name)

Sets the current step to be shown to the user.

setIndeterminate

void setIndeterminate(boolean indeterminate)

Sets whether the max progress is known or not. If not, the loading bar will load 'forever'.