Package io.github.thecsdev.betterstats.api.util.stats

Class SUItemStat

java.lang.Object

io.github.thecsdev.betterstats.api.util.stats.SUStat<net.minecraft.item.Item>

io.github.thecsdev.betterstats.api.util.stats.SUItemStat

public final class SUItemStat
extends SUStat<net.minecraft.item.Item>

Field Summary

Fields

Modifier and Type	Field	Description
protected final @Nullable net.minecraft.block.Block	block
final int	broken
final int	crafted
final int	dropped
protected final boolean	isEmpty
protected final net.minecraft.item.Item	item
final int	mined
final int	pickedUp
final int	used

Fields inherited from class io.github.thecsdev.betterstats.api.util.stats.SUStat

ID_NULL, statId, statIdSQ, statLabel, statLabelSQ, statsProvider

Constructor Summary

Constructors

Constructor	Description
SUItemStat(IStatsProvider statsProvider, net.minecraft.item.Item item)

Method Summary

Modifier and Type	Method	Description
final @Nullable net.minecraft.block.Block	getBlock()	Returns the Block that corresponds with getItem(), or null if the Item does not have a corresponding Block.
final net.minecraft.item.Item	getItem()	Returns the Item corresponding with this SUItemStat.
static List<SUItemStat>	getItemStats(IStatsProvider statsProvider, @Nullable Predicate<SUItemStat> filter)	Obtains all Item Stats in form of SUItemStat.
static Map<net.minecraft.item.ItemGroup,List<SUItemStat>>	getItemStatsByItemGroups(IStatsProvider statsProvider, @Nullable Predicate<SUItemStat> filter)	Obtains all Item Stats in form of SUItemStat, grouped into ItemGroups using a Map.
static Map<net.minecraft.text.Text,List<SUItemStat>>	getItemStatsByItemGroupsB(IStatsProvider statsProvider, @Nullable Predicate<SUItemStat> filter)	Deprecated, for removal: This API element is subject to removal in a future version.
static Map<String,List<SUItemStat>>	getItemStatsByModGroups(IStatsProvider statsProvider, @Nullable Predicate<SUItemStat> filter)	Obtains all Item Stats in form of SUItemStat, grouped into "mod groups" using a Map.
static Map<net.minecraft.text.Text,List<SUItemStat>>	getItemStatsByModGroupsB(IStatsProvider statsProvider, @Nullable Predicate<SUItemStat> filter)	Deprecated, for removal: This API element is subject to removal in a future version.
static net.minecraft.text.Text	getItemStatText(net.minecraft.item.Item item)	Returns the Text that should correspond to a given SUItemStat.
final boolean	isEmpty()	Returns true if the sum of all the Stat values associated with this SUStat is 0.

Methods inherited from class io.github.thecsdev.betterstats.api.util.stats.SUStat

getStatID, getStatLabel, getStatsProvider, matchesSearchQuery

Methods inherited from class java.lang.Object

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

Field Details

item

protected final net.minecraft.item.Item item

block

@Nullable
protected final @Nullable net.minecraft.block.Block block

isEmpty

protected final boolean isEmpty

mined

public final int mined

crafted

public final int crafted

used

public final int used

broken

public final int broken

pickedUp

public final int pickedUp

dropped

public final int dropped

Constructor Details

SUItemStat

public SUItemStat(IStatsProvider statsProvider,
 net.minecraft.item.Item item)

Method Details

getItem

public final net.minecraft.item.Item getItem()

Returns the Item corresponding with this SUItemStat.

getBlock

@Nullable
public final @Nullable net.minecraft.block.Block getBlock()

Returns the Block that corresponds with getItem(), or null if the Item does not have a corresponding Block.

isEmpty

public final boolean isEmpty()

Description copied from class: SUStat

Returns true if the sum of all the Stat values associated with this SUStat is 0.

Specified by:

isEmpty in class SUStat<net.minecraft.item.Item>

getItemStatText

public static net.minecraft.text.Text getItemStatText(net.minecraft.item.Item item)

Returns the Text that should correspond to a given SUItemStat.

getItemStats

public static List<SUItemStat> getItemStats(IStatsProvider statsProvider,
 @Nullable
 @Nullable Predicate<SUItemStat> filter)

Obtains all Item Stats in form of SUItemStat.

Parameters:

statsProvider - The IStatsProvider.

filter - Optional. A Predicate used to filter out any unwanted SUItemStats.

getItemStatsByItemGroups

public static Map<net.minecraft.item.ItemGroup,List<SUItemStat>> getItemStatsByItemGroups(IStatsProvider statsProvider,
 @Nullable
 @Nullable Predicate<SUItemStat> filter)

Obtains all Item Stats in form of SUItemStat, grouped into ItemGroups using a Map.

Parameters:

statsProvider - The IStatsProvider.

filter - Optional. A Predicate used to filter out any unwanted SUItemStats.

getItemStatsByModGroups

public static Map<String,List<SUItemStat>> getItemStatsByModGroups(IStatsProvider statsProvider,
 @Nullable
 @Nullable Predicate<SUItemStat> filter)

Obtains all Item Stats in form of SUItemStat, grouped into "mod groups" using a Map. The Map keys represent "mod IDs".

Parameters:

statsProvider - The IStatsProvider.

filter - Optional. A Predicate used to filter out any unwanted SUItemStats.

getItemStatsByItemGroupsB

@Deprecated(since="3.9.2",
            forRemoval=true)
public static Map<net.minecraft.text.Text,List<SUItemStat>> getItemStatsByItemGroupsB(IStatsProvider statsProvider,
 @Nullable
 @Nullable Predicate<SUItemStat> filter)

Deprecated, for removal: This API element is subject to removal in a future version.

Same as getItemStatsByItemGroups(IStatsProvider, Predicate), but the Map keys represent Textual names of the ItemGroups.

Parameters:

statsProvider - The IStatsProvider.

filter - Optional. A Predicate used to filter out any unwanted SUItemStats.

getItemStatsByModGroupsB

@Deprecated(since="3.9.2",
            forRemoval=true)
public static Map<net.minecraft.text.Text,List<SUItemStat>> getItemStatsByModGroupsB(IStatsProvider statsProvider,
 @Nullable
 @Nullable Predicate<SUItemStat> filter)

Deprecated, for removal: This API element is subject to removal in a future version.

Same as getItemStatsByModGroups(IStatsProvider, Predicate), but the Map keys represent Textual names of the mods.

Parameters:

statsProvider - The IStatsProvider.

filter - Optional. A Predicate used to filter out any unwanted SUItemStats.