Class DescriptiveProgressiveTask<T>
java.lang.Object
io.github.thecsdev.tcdcommons.api.util.thread.ProgressiveTask<T>
io.github.thecsdev.tcdcommons.api.util.thread.DescriptiveProgressiveTask<T>
A
ProgressiveTask
that also provides descriptions on "what is
currently happening as the task is executing".-
Nested Class Summary
Nested classes/interfaces inherited from class io.github.thecsdev.tcdcommons.api.util.thread.ProgressiveTask
ProgressiveTask.PtFinished, ProgressiveTask.PtPc
-
Field Summary
Modifier and TypeFieldDescriptionATEvent
that is invoked wheneversetProgressDescription(Text)
is called.Fields inherited from class io.github.thecsdev.tcdcommons.api.util.thread.ProgressiveTask
eFinished, eProgressChanged
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal @Nullable net.minecraft.text.Text
Returns a user-friendlyText
that describes what is currently going on as the task is executing.protected final void
setProgressDescription
(@Nullable net.minecraft.text.Text description) Sets the user-friendlyText
that describes what is currently going on as the task is executing.Methods inherited from class io.github.thecsdev.tcdcommons.api.util.thread.ProgressiveTask
clearFlags, executeSync, getError, getProgress, getResult, isFinished, isRunning, onExecuteTask, setProgress
-
Field Details
-
eProgressDescriptionChanged
ATEvent
that is invoked wheneversetProgressDescription(Text)
is called.
-
-
Constructor Details
-
DescriptiveProgressiveTask
public DescriptiveProgressiveTask()
-
-
Method Details
-
getProgressDescription
@Nullable public final @Nullable net.minecraft.text.Text getProgressDescription()Returns a user-friendlyText
that describes what is currently going on as the task is executing. -
setProgressDescription
protected final void setProgressDescription(@Nullable @Nullable net.minecraft.text.Text description) Sets the user-friendlyText
that describes what is currently going on as the task is executing.- Parameters:
description
- TheText
.
-