Class McbsGoal

java.lang.Object

com.thecsdev.betterstats.api.mcbs.model.goal.McbsGoal

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

McbsSivGoal

public abstract class McbsGoal
extends Object
implements Cloneable

Represents a goal that a user seeks to accomplish for a given McbsFile.

Each goal has a progress value that ranges from 0 to 1, where 1 indicates that the goal is completed.

The progress of a goal is determined by the implementation of the getProgress(McbsFile) method.

Field Summary

Fields

Modifier and Type	Field	Description
static final com.mojang.serialization.Codec<? extends McbsGoal>	CODEC	Codec instance for handling McbsGoal serialization.

Constructor Summary

Constructors

Constructor	Description
McbsGoal(@NotNull McbsGoalType<?> type)	Creates an McbsGoal instance.

Method Summary

Modifier and Type	Method	Description
@NotNull McbsGoal	clone()
@NotNull net.minecraft.network.chat.Component	getObjectiveText()	Returns the user-friendy display text for what the goal's "objective" is. For example "Mine 100 Stone" or "Kill 30 Zombie" or "Travel 500 meters".
abstract double	getProgress(@NotNull McbsFile mcbsFile)	Returns a value ranging from 0 to 1, that indicates current progress towards completing the goal.
abstract @NotNull net.minecraft.network.chat.Component	getProgressText(@NotNull McbsFile mcbsFile)	Returns visual user-friendly text that indicates current progress towards completing the goal.
final @NotNull McbsGoalType<?>	getType()	Returns the McbsGoalType of this McbsGoal.
final boolean	isDone(@NotNull McbsFile mcbsFile)	Returns true only if getProgress(McbsFile) is >= 1.0.

Methods inherited from class Object

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

Field Details

CODEC

public static final com.mojang.serialization.Codec<? extends McbsGoal> CODEC

Codec instance for handling McbsGoal serialization.

Constructor Details

McbsGoal

public McbsGoal(@NotNull
 @NotNull McbsGoalType<?> type)
         throws NullPointerException,
IllegalArgumentException

Creates an McbsGoal instance.

Parameters:

type - The corresponding McbsGoalType instance.

Throws:

NullPointerException - If the argument is null.

IllegalArgumentException - If McbsGoalType.getBaseClass() does not match this.Object.getClass().

Method Details

clone

@Virtual
@NotNull
public @NotNull McbsGoal clone()
                        throws IllegalStateException

Overrides:

clone in class Object

Throws:

IllegalStateException

getType

@NotNull
public final @NotNull McbsGoalType<?> getType()

Returns the McbsGoalType of this McbsGoal.

getProgress

@Contract(pure=true)
public abstract double getProgress(@NotNull
 @NotNull McbsFile mcbsFile)
                            throws NullPointerException

Returns a value ranging from 0 to 1, that indicates current progress towards completing the goal. A value of 1 indicates that the goal is completed.

Parameters:

mcbsFile - The McbsFile to check the progress for.

Throws:

NullPointerException - If the argument is null.

getProgressText

@Contract(pure=true)
@NotNull
public abstract @NotNull net.minecraft.network.chat.Component getProgressText(@NotNull
 @NotNull McbsFile mcbsFile)
                                                                       throws NullPointerException

Returns visual user-friendly text that indicates current progress towards completing the goal. For example "15 / 25" or "1 / 3" and so on.

Parameters:

mcbsFile - The McbsFile to get the progress text for.

Throws:

NullPointerException - If the argument is null.

isDone

@Contract(pure=true)
public final boolean isDone(@NotNull
 @NotNull McbsFile mcbsFile)

Returns true only if getProgress(McbsFile) is >= 1.0.

Parameters:

mcbsFile - The McbsFile to check the progress for.

getObjectiveText

@Contract(pure=true)
@Virtual
@NotNull
public @NotNull net.minecraft.network.chat.Component getObjectiveText()

Returns the user-friendy display text for what the goal's "objective" is.
For example "Mine 100 Stone" or "Kill 30 Zombie" or "Travel 500 meters".

This differs from McbsGoalType.getName() in the fact that goal type name is a generic name that applies to all corresponding McbsGoal instances.

See Also:

• McbsGoalType.getName()