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

Class SUStat<T>

java.lang.Object

io.github.thecsdev.betterstats.api.util.stats.SUStat<T>

Direct Known Subclasses:

SUGeneralStat, SUItemStat, SUMobStat, SUPlayerBadgeStat

@Internal
public abstract class SUStat<T>
extends Object

A "Stat utils stat".

Represents a statistic about something, whether it be about Items, or EntityTypes, or anything else. This is a utility class for easier reading of statistics about given things.

Field Summary

Fields

Modifier and Type	Field	Description
static final net.minecraft.util.Identifier	ID_NULL
protected final net.minecraft.util.Identifier	statId
protected final String	statIdSQ
protected final net.minecraft.text.Text	statLabel
protected final String	statLabelSQ
protected final IStatsProvider	statsProvider

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SUStat(IStatsProvider statsProvider, net.minecraft.util.Identifier statId, net.minecraft.text.Text statLabel)

Method Summary

Modifier and Type	Method	Description
final net.minecraft.util.Identifier	getStatID()	Returns the unique Identifier associated with this SUStat.
final net.minecraft.text.Text	getStatLabel()	Returns the Textual label that represents the Stat.
final IStatsProvider	getStatsProvider()	Returns the IStatsProvider the Stats data was obtained from.
abstract boolean	isEmpty()	Returns true if the sum of all the Stat values associated with this SUStat is 0.
boolean	matchesSearchQuery(String search)	Checks if this SUStat's statLabel matches a given "search query".

Methods inherited from class java.lang.Object

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

Field Details

ID_NULL

public static final net.minecraft.util.Identifier ID_NULL

statsProvider

protected final IStatsProvider statsProvider

statId

protected final net.minecraft.util.Identifier statId

statLabel

protected final net.minecraft.text.Text statLabel

statLabelSQ

protected final String statLabelSQ

statIdSQ

protected final String statIdSQ

Constructor Details

SUStat

protected SUStat(IStatsProvider statsProvider,
 net.minecraft.util.Identifier statId,
 net.minecraft.text.Text statLabel)
          throws NullPointerException

Throws:

NullPointerException

Method Details

getStatLabel

public final net.minecraft.text.Text getStatLabel()

Returns the Textual label that represents the Stat.

getStatID

public final net.minecraft.util.Identifier getStatID()

Returns the unique Identifier associated with this SUStat.

For SUGeneralStat, refers to Stat.getValue(),
for SUItemStat, refers to Item's Identifier,
for SUMobStat, refers to EntityType's Identifier.

getStatsProvider

public final IStatsProvider getStatsProvider()

Returns the IStatsProvider the Stats data was obtained from.

matchesSearchQuery

public boolean matchesSearchQuery(String search)

Checks if this SUStat's statLabel matches a given "search query".

Parameters:

search - The search query being performed.

See Also:

• getStatLabel()

isEmpty

public abstract boolean isEmpty()

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