Package io.github.thecsdev.betterstats.client.gui.stats.tabs

Class GeneralStatsTab

java.lang.Object

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

io.github.thecsdev.betterstats.client.gui.stats.tabs.GeneralStatsTab

@Internal
public final class GeneralStatsTab
extends StatsTab

Nested Class Summary

Nested classes/interfaces inherited from class io.github.thecsdev.betterstats.api.client.registry.StatsTab

StatsTab.FiltersInitContext, StatsTab.StatsInitContext

Constructor Summary

Constructors

Constructor	Description
GeneralStatsTab()

Method Summary

Modifier and Type	Method	Description
protected FilterGroupBy	getDefaultGroupFilter()	Returns the FilterGroupBy that'll be used by "default".
final 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.
protected final AtomicInteger	getPageFilter(StatFilterSettings filters)	Returns the AtomicInteger that represents the "page" filter value.
protected Predicate<SUGeneralStat>	getPredicate(StatFilterSettings filterSettings)
protected static final void	initDebugInfo(io.github.thecsdev.tcdcommons.api.client.gui.panel.TPanelElement panel)	Initializes "debug mode" info.
protected final void	initExtraFilters(StatsTab.FiltersInitContext initContext)
final void	initFilters(StatsTab.FiltersInitContext initContext)	Invoked when a StatFiltersPanel GUI is initializing for a given StatsTab.
protected void	initPageChooser(StatsTab.StatsInitContext initContext, int totalItemCount, int itemsPerPage)	Initializes a PageChooserPanel.
final void	initStats(StatsTab.StatsInitContext initContext)	Invoked when a StatsTabPanel GUI is initializing for a given StatsTab.
protected final void	initStats(io.github.thecsdev.tcdcommons.api.client.gui.panel.TPanelElement panel, Collection<SUGeneralStat> stats, Consumer<GeneralStatWidget> processWidget)	Initializes a Collection of SUGeneralStats onto a TPanelElement.
protected void	processWidget(GeneralStatWidget widget)	Default GeneralStatWidget processing logic. Primarily used for initStats(TPanelElement, Collection, Consumer)

Methods inherited from class io.github.thecsdev.betterstats.api.client.registry.StatsTab

getId, isAvailable

Methods inherited from class java.lang.Object

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

Constructor Details

GeneralStatsTab

public GeneralStatsTab()

Method Details

getName

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

Description copied from class: StatsTab

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

Specified by:

getName in class StatsTab

initStats

public final void initStats(StatsTab.StatsInitContext initContext)

Description copied from class: StatsTab

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

Use this to initialize the StatsTab's GUI.

Specified by:

initStats in class StatsTab

Parameters:

initContext - The StatsTab.StatsInitContext.

initExtraFilters

protected final void initExtraFilters(StatsTab.FiltersInitContext initContext)

getDefaultGroupFilter

protected FilterGroupBy getDefaultGroupFilter()

Returns the FilterGroupBy that'll be used by "default".

initStats

protected final void initStats(io.github.thecsdev.tcdcommons.api.client.gui.panel.TPanelElement panel,
 Collection<SUGeneralStat> stats,
 Consumer<GeneralStatWidget> processWidget)

Initializes a Collection of SUGeneralStats onto a TPanelElement.

Parameters:

panel - The TPanelElement.

stats - The SUGeneralStats to initialize.

processWidget - Optional Consumer that allows you to make changes to widgets as they are created.

processWidget

protected void processWidget(GeneralStatWidget widget)

Default GeneralStatWidget processing logic.
Primarily used for initStats(TPanelElement, Collection, Consumer)

Parameters:

widget - The GeneralStatWidget.

initDebugInfo

protected static final void initDebugInfo(io.github.thecsdev.tcdcommons.api.client.gui.panel.TPanelElement panel)

Initializes "debug mode" info.

Parameters:

panel - The TPanelElement to initialize to.

initFilters

public final void initFilters(StatsTab.FiltersInitContext initContext)

Description copied from class: StatsTab

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

Use this to initialize the StatFilterSettings GUI.

Overrides:

initFilters in class StatsTab

Parameters:

initContext - The StatsTab.FiltersInitContext.

getPredicate

protected Predicate<SUGeneralStat> getPredicate(StatFilterSettings filterSettings)

getPageFilter

protected final AtomicInteger getPageFilter(StatFilterSettings filters)

Returns the AtomicInteger that represents the "page" filter value.

Parameters:

filters - The StatFilterSettings.

initPageChooser

protected void initPageChooser(StatsTab.StatsInitContext initContext,
 int totalItemCount,
 int itemsPerPage)

Initializes a PageChooserPanel.

Parameters:

initContext - The StatsTab.StatsInitContext.

totalItemCount - The total number of items present.

itemsPerPage - The maximum number of items to be displayed per page.