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

Class StatsTab

java.lang.Object

io.github.thecsdev.betterstats.api.client.registry.StatsTab

Direct Known Subclasses:

BSConfigTab, BSCreditsTab, GeneralStatsTab, ItemStatsTab, MobStatsTab, PlayerBadgeStatsTab

public abstract class StatsTab
extends Object

Represents a "statistics tab" Object used in StatsTabPanel for initializing a "statistics tab"'s GUI.

Examples include like the "General", "Items", and "Mobs" tabs.

See Also:

• initFilters(FiltersInitContext)
• initStats(StatsInitContext)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StatsTab.FiltersInitContext	The "initialization context" for when a StatsTab's corresponding "stat filters" GUI is "initializing".
static interface	StatsTab.StatsInitContext	The "initialization context" for when a StatsTab's GUI is "initializing".

Constructor Summary

Constructors

Constructor	Description
StatsTab()

Method Summary

Modifier and Type	Method	Description
final Optional<net.minecraft.util.Identifier>	getId()	Returns an Optional containing the unique Identifier of this StatsTab.
abstract net.minecraft.text.Text	getName()	Returns the name of this StatsTab. This Text will be rendered on the GUI to indicate the tab's name.
void	initFilters(StatsTab.FiltersInitContext initContext)	Invoked when a StatFiltersPanel GUI is initializing for a given StatsTab.
abstract void	initStats(StatsTab.StatsInitContext initContext)	Invoked when a StatsTabPanel GUI is initializing for a given StatsTab.
boolean	isAvailable()	Returns true if this StatsTab should appear in the SelectStatsTabWidget's dropdown menu at the time of the SelectStatsTabWidget's creation.

Methods inherited from class java.lang.Object

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

Constructor Details

StatsTab

public StatsTab()

Method Details

getName

public abstract net.minecraft.text.Text getName()

Returns the name of this StatsTab.
This Text will be rendered on the GUI to indicate the tab's name.

initStats

public abstract void initStats(StatsTab.StatsInitContext initContext)

Invoked when a StatsTabPanel GUI is initializing for a given StatsTab.

Use this to initialize the StatsTab's GUI.

Parameters:

initContext - The StatsTab.StatsInitContext.

initFilters

public void initFilters(StatsTab.FiltersInitContext initContext)

Invoked when a StatFiltersPanel GUI is initializing for a given StatsTab.

Use this to initialize the StatFilterSettings GUI.

Parameters:

initContext - The StatsTab.FiltersInitContext.

getId

public final Optional<net.minecraft.util.Identifier> getId()

Returns an Optional containing the unique Identifier of this StatsTab. The Optional will contain null if this StatsTab isn't registered.

See Also:

• BSClientRegistries.STATS_TAB

isAvailable

public boolean isAvailable()

Returns true if this StatsTab should appear in the SelectStatsTabWidget's dropdown menu at the time of the SelectStatsTabWidget's creation.