Package io.github.thecsdev.betterstats.api.client.badge

Class BSClientPlayerBadge

java.lang.Object

io.github.thecsdev.tcdcommons.api.badge.PlayerBadge

io.github.thecsdev.tcdcommons.api.client.badge.ClientPlayerBadge

io.github.thecsdev.betterstats.api.client.badge.BSClientPlayerBadge

public class BSClientPlayerBadge
extends io.github.thecsdev.tcdcommons.api.client.badge.ClientPlayerBadge

BetterStats's implementation of ClientPlayerBadge.

Field Summary

Fields

Modifier and Type	Field	Description
protected final net.minecraft.text.Text	description
protected final net.minecraft.text.Text	name
protected @Nullable Function<IStatsProvider,Integer>	statCriteria

Constructor Summary

Constructors

Constructor	Description
BSClientPlayerBadge(net.minecraft.text.Text title, net.minecraft.text.Text description)

Method Summary

Modifier and Type	Method	Description
net.minecraft.text.Text	getDescription()
net.minecraft.text.Text	getName()
final @Nullable Function<IStatsProvider,Integer>	getStatCriteria()	About the returned function:
void	setStatCriteria(@Nullable Function<IStatsProvider,Integer> statCriteria)	Sets the "stat criteria" Function.

Methods inherited from class io.github.thecsdev.tcdcommons.api.client.badge.ClientPlayerBadge

getClientPlayerBadgeHandler, shouldSave

Methods inherited from class io.github.thecsdev.tcdcommons.api.badge.PlayerBadge

getId

Methods inherited from class java.lang.Object

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

Field Details

name

protected final net.minecraft.text.Text name

description

protected final net.minecraft.text.Text description

statCriteria

@Nullable
protected @Nullable Function<IStatsProvider,Integer> statCriteria

Constructor Details

BSClientPlayerBadge

public BSClientPlayerBadge(net.minecraft.text.Text title,
 net.minecraft.text.Text description)
                    throws NullPointerException

Throws:

NullPointerException

Method Details

getName

public net.minecraft.text.Text getName()

Specified by:

getName in class io.github.thecsdev.tcdcommons.api.badge.PlayerBadge

getDescription

public net.minecraft.text.Text getDescription()

Specified by:

getDescription in class io.github.thecsdev.tcdcommons.api.badge.PlayerBadge

getStatCriteria

@Nullable
public final @Nullable Function<IStatsProvider,Integer> getStatCriteria()

About the returned function:

The Function returns an Integer if a given IStatsProvider contains statistics that meet the criteria for this BSClientPlayerBadge to be "awarded" to said IStatsProvider.

The returned Integer indicates the "value" aka "quantity" of the BSClientPlayerBadge that should be "awarded".

See Also:

• SUPlayerBadgeStat.value

setStatCriteria

public void setStatCriteria(@Nullable
 @Nullable Function<IStatsProvider,Integer> statCriteria)
                     throws IllegalStateException

Sets the "stat criteria" Function.

Throws:

IllegalStateException - If statCriteria is already defined.

See Also:

• getStatCriteria()