Class CustomStat

java.lang.Object

com.thecsdev.commonmc.api.stats.util.SubjectStats<net.minecraft.resources.Identifier>

com.thecsdev.commonmc.api.stats.util.CustomStat

public final class CustomStat
extends SubjectStats<net.minecraft.resources.Identifier>

SubjectStats utility implementation for reading statistics about a given "General" (also known as "Custom") stat.

Constructor Summary

Constructors

Constructor	Description
CustomStat(@NotNull net.minecraft.resources.Identifier subject, @NotNull IStatsProvider statsProvider)

Method Summary

Modifier and Type	Method	Description
static final Collection<CustomStat>	getCustomStats(@NotNull IStatsProvider statsProvider, @Nullable Predicate<CustomStat> predicate, @Nullable Comparator<CustomStat> comparator)	Obtains a list of all CustomStat.
final @NotNull net.minecraft.network.chat.Component	getSubjectDisplayName()	Returns the in-game display name of the SubjectStats.getSubject().
final int	getValue()	Returns the raw (unformatted) numeric value of the "General" stat.
final @NotNull String	getValueF()	Returns getValue() formatted using Stat.format(int).
final @NotNull String	getValueF(@Nullable StatFormatterOverride formatter)	Returns getValue() formatted using a custom formatter.
final @NotNull LinkedHashMap<net.minecraft.stats.Stat<net.minecraft.resources.Identifier>, Integer>	getValues()	Returns all the statistics about the SubjectStats.getSubject().
final boolean	isDistance()	Returns true if the StatFormatter of this CustomStat is StatFormatter.DISTANCE.
final boolean	isDivideBy10()	Returns true if the StatFormatter of this CustomStat is StatFormatter.DIVIDE_BY_TEN.
final boolean	isEmpty()	Returns true if all StatTypes for the given SubjectStats.getSubject() have the value 0.
final boolean	isTime()	Returns true if the StatFormatter of this CustomStat is StatFormatter.TIME.

Methods inherited from class SubjectStats

equals, getStatsProvider, getSubject, getSubjectID, getValuesF, getValuesF, hashCode, isSearchMatch

Methods inherited from class Object

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

Constructor Details

CustomStat

public CustomStat(@NotNull
 @NotNull net.minecraft.resources.Identifier subject,
 @NotNull
 @NotNull IStatsProvider statsProvider)
           throws NullPointerException,
IllegalStateException

Throws:

NullPointerException - If an argument is null.

IllegalStateException - If the subject is not properly registered in the game's registries.

Method Details

getSubjectDisplayName

@NotNull
public final @NotNull net.minecraft.network.chat.Component getSubjectDisplayName()

Description copied from class: SubjectStats

Returns the in-game display name of the SubjectStats.getSubject().

Specified by:

getSubjectDisplayName in class SubjectStats<net.minecraft.resources.Identifier>

getValues

@NotNull
public final @NotNull LinkedHashMap<net.minecraft.stats.Stat<net.minecraft.resources.Identifier>, Integer> getValues()

Description copied from class: SubjectStats

Returns all the statistics about the SubjectStats.getSubject().

Specified by:

getValues in class SubjectStats<net.minecraft.resources.Identifier>

isEmpty

public final boolean isEmpty()

Description copied from class: SubjectStats

Returns true if all StatTypes for the given SubjectStats.getSubject() have the value 0.

Overrides:

isEmpty in class SubjectStats<net.minecraft.resources.Identifier>

getValue

public final int getValue()

Returns the raw (unformatted) numeric value of the "General" stat.

getValueF

@NotNull
public final @NotNull String getValueF()

Returns getValue() formatted using Stat.format(int).

getValueF

@NotNull
public final @NotNull String getValueF(@Nullable
 @Nullable StatFormatterOverride formatter)

Returns getValue() formatted using a custom formatter.

Parameters:

formatter - The StatFormatterOverride to use. If null, the default one is used.

isDistance

public final boolean isDistance()

Returns true if the StatFormatter of this CustomStat is StatFormatter.DISTANCE.

isTime

public final boolean isTime()

Returns true if the StatFormatter of this CustomStat is StatFormatter.TIME.

isDivideBy10

public final boolean isDivideBy10()

Returns true if the StatFormatter of this CustomStat is StatFormatter.DIVIDE_BY_TEN.

getCustomStats

public static final Collection<CustomStat> getCustomStats(@NotNull
 @NotNull IStatsProvider statsProvider,
 @Nullable
 @Nullable Predicate<CustomStat> predicate,
 @Nullable
 @Nullable Comparator<CustomStat> comparator)
                                                   throws NullPointerException

Obtains a list of all CustomStat.

Parameters:

statsProvider - The IStatsProvider instance.

predicate - An optional Predicate for filtering the stats.

comparator - An optional Comparator for sorting the list.

Throws:

NullPointerException - If a NotNull argument is null.