Class ItemStats

java.lang.Object

com.thecsdev.commonmc.api.stats.util.SubjectStats<net.minecraft.world.item.Item>

com.thecsdev.commonmc.api.stats.util.ItemStats

public final class ItemStats
extends SubjectStats<net.minecraft.world.item.Item>

SubjectStats utility implementation for reading statistics about a given Item.

Constructor Summary

Constructors

Constructor	Description
ItemStats(@NotNull net.minecraft.world.item.Item subject, @NotNull IStatsProvider statsProvider)

Method Summary

Modifier and Type	Method	Description
final @NotNull BlockStats	getBlockStats()	Returns the BlockStats of the SubjectStats.getSubject()'s corresponding Block.
static final Collection<ItemStats>	getItemStats(@NotNull IStatsProvider statsProvider, @Nullable Predicate<ItemStats> predicate, @Nullable Comparator<ItemStats> comparator)	Obtains a list of all ItemStats.
final @NotNull net.minecraft.network.chat.Component	getSubjectDisplayName()	Returns the in-game display name of the SubjectStats.getSubject().
final int	getTimesBroken()	Returns the value of Stats.ITEM_BROKEN.
final int	getTimesCrafted()	Returns the value of Stats.ITEM_CRAFTED.
final int	getTimesDropped()	Returns the value of Stats.ITEM_DROPPED.
final int	getTimesPickedUp()	Returns the value of Stats.ITEM_PICKED_UP.
final int	getTimesUsed()	Returns the value of Stats.ITEM_USED.
final @NotNull LinkedHashMap<net.minecraft.stats.Stat<net.minecraft.world.item.Item>, Integer>	getValues()	Returns all the statistics about the SubjectStats.getSubject().

Methods inherited from class SubjectStats

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

Methods inherited from class Object

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

Constructor Details

ItemStats

public ItemStats(@NotNull
 @NotNull net.minecraft.world.item.Item 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.world.item.Item>

getValues

@NotNull
public final @NotNull LinkedHashMap<net.minecraft.stats.Stat<net.minecraft.world.item.Item>, Integer> getValues()

Description copied from class: SubjectStats

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

Specified by:

getValues in class SubjectStats<net.minecraft.world.item.Item>

getBlockStats

@NotNull
public final @NotNull BlockStats getBlockStats()

Returns the BlockStats of the SubjectStats.getSubject()'s corresponding Block.

getTimesBroken

public final int getTimesBroken()

Returns the value of Stats.ITEM_BROKEN.

getTimesCrafted

public final int getTimesCrafted()

Returns the value of Stats.ITEM_CRAFTED.

getTimesDropped

public final int getTimesDropped()

Returns the value of Stats.ITEM_DROPPED.

getTimesUsed

public final int getTimesUsed()

Returns the value of Stats.ITEM_USED.

getTimesPickedUp

public final int getTimesPickedUp()

Returns the value of Stats.ITEM_PICKED_UP.

getItemStats

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

Obtains a list of all ItemStats.

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.