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

Class SUPlayerBadgeStat

java.lang.Object

io.github.thecsdev.betterstats.api.util.stats.SUStat<io.github.thecsdev.tcdcommons.api.badge.PlayerBadge>

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

public final class SUPlayerBadgeStat
extends SUStat<io.github.thecsdev.tcdcommons.api.badge.PlayerBadge>

Field Summary

Fields

Modifier and Type	Field	Description
protected final boolean	isEmpty
protected final io.github.thecsdev.tcdcommons.api.badge.PlayerBadge	playerBadge
final int	value	Supposed to indicate the "quantity" of a given PlayerBadge that a given player has.

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

ID_NULL, statId, statIdSQ, statLabel, statLabelSQ, statsProvider

Constructor Summary

Constructors

Constructor	Description
SUPlayerBadgeStat(IStatsProvider statsProvider, io.github.thecsdev.tcdcommons.api.badge.PlayerBadge playerBadge)

Method Summary

Modifier and Type	Method	Description
final io.github.thecsdev.tcdcommons.api.badge.PlayerBadge	getPlayerBadge()
static List<SUPlayerBadgeStat>	getPlayerBadgeStats(IStatsProvider statsProvider, @Nullable Predicate<SUPlayerBadgeStat> filter)	Obtains PlayerBadge stats, in form of SUPlayerBadgeStats.
static Map<String,List<SUPlayerBadgeStat>>	getPlayerBadgeStatsByModGroups(IStatsProvider statsProvider, @Nullable Predicate<SUPlayerBadgeStat> filter)	Obtains PlayerBadge stats, in form of SUPlayerBadgeStats, grouped into "mod groups" using a Map.
static Map<net.minecraft.text.Text,List<SUPlayerBadgeStat>>	getPlayerBadgeStatsByModGroupsB(IStatsProvider statsProvider, @Nullable Predicate<SUPlayerBadgeStat> filter)	Same as getPlayerBadgeStatsByModGroups(IStatsProvider, Predicate), but the Map keys represent Textual names of the mods.
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

playerBadge

protected final io.github.thecsdev.tcdcommons.api.badge.PlayerBadge playerBadge

isEmpty

protected final boolean isEmpty

value

public final int value

Supposed to indicate the "quantity" of a given PlayerBadge that a given player has.

Constructor Details

SUPlayerBadgeStat

public SUPlayerBadgeStat(IStatsProvider statsProvider,
 io.github.thecsdev.tcdcommons.api.badge.PlayerBadge playerBadge)
                  throws NullPointerException

Throws:

NullPointerException

Method Details

getPlayerBadge

public final io.github.thecsdev.tcdcommons.api.badge.PlayerBadge getPlayerBadge()

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<io.github.thecsdev.tcdcommons.api.badge.PlayerBadge>

getPlayerBadgeStats

public static List<SUPlayerBadgeStat> getPlayerBadgeStats(IStatsProvider statsProvider,
 @Nullable
 @Nullable Predicate<SUPlayerBadgeStat> filter)

Obtains PlayerBadge stats, in form of SUPlayerBadgeStats.

Parameters:

statsProvider - The IStatsProvider.

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

getPlayerBadgeStatsByModGroups

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

Obtains PlayerBadge stats, in form of SUPlayerBadgeStats, 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 SUPlayerBadgeStats.

getPlayerBadgeStatsByModGroupsB

public static Map<net.minecraft.text.Text,List<SUPlayerBadgeStat>> getPlayerBadgeStatsByModGroupsB(IStatsProvider statsProvider,
 @Nullable
 @Nullable Predicate<SUPlayerBadgeStat> filter)

Same as getPlayerBadgeStatsByModGroups(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 SUPlayerBadgeStats.