Class StatsViewGeneral

java.lang.Object

com.thecsdev.betterstats.api.mcbs.view.statsview.StatsView

com.thecsdev.betterstats.mcbs.view.statsview.SubjectStatsView<com.thecsdev.commonmc.api.stats.util.CustomStat>

com.thecsdev.betterstats.mcbs.view.statsview.StatsViewGeneral

All Implemented Interfaces:

com.thecsdev.commonmc.api.client.gui.widget.TDropdownWidget.Entry

@Environment(CLIENT)
@Internal
public final class StatsViewGeneral
extends SubjectStatsView<com.thecsdev.commonmc.api.stats.util.CustomStat>

StatsView that displays "General" statistics.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	StatsViewGeneral.DistanceUnit	TDropdownWidget.Entrys for overriding distance stat formatters.
static enum	StatsViewGeneral.GroupBy	TDropdownWidget.Entrys for grouping CustomStat.
static enum	StatsViewGeneral.SortBy	TDropdownWidget.Entrys for sorting CustomStat.
static enum	StatsViewGeneral.TimeUnit	TDropdownWidget.Entrys for overriding time stat formatters.

Nested classes/interfaces inherited from class StatsView

StatsView.Filters, StatsView.FiltersInitContext, StatsView.StatsInitContext

Field Summary

Fields

Modifier and Type	Field	Description
static final StatsViewGeneral	INSTANCE	The main instance of this Class.

Fields inherited from class SubjectStatsView

OC_DONE, OC_INPROGRESS

Method Summary

Modifier and Type	Method	Description
final @NotNull net.minecraft.network.chat.Component	getDisplayName()	Returns the display name of this StatsView. This Component will be shown on the GUI to indicate the view's name.
protected final @NotNull Function<Iterable<com.thecsdev.commonmc.api.stats.util.CustomStat>, LinkedHashMap<net.minecraft.network.chat.Component, Iterable<com.thecsdev.commonmc.api.stats.util.CustomStat>>>	getStatsGrouper(@NotNull StatsView.Filters filters)	The Function that takes a collection of SubjectStats and groups them into a Map based on the StatsView.Filters.
protected final @NotNull Comparator<com.thecsdev.commonmc.api.stats.util.CustomStat>	getStatsSorter(@NotNull StatsView.Filters filters)	The Comparator used for sorting SubjectStats shown on this SubjectStatsView's "Statistics" panel.
final void	initFilters(@NotNull StatsView.FiltersInitContext context)	Invoked when a StatsView's filters GUI is initializing.
final void	initStats(@NotNull StatsView.StatsInitContext context)	Invoked when the StatsView's statistics GUI is initializing.
final void	postProcessWidget(StatsView.StatsInitContext context, @NotNull com.thecsdev.commonmc.api.client.gui.widget.stats.TCustomStatWidget widget)	Post-processes a TCustomStatWidget after its creation.

Methods inherited from class SubjectStatsView

getStatsPredicate

Methods inherited from class StatsView

getDefault

Methods inherited from class Object

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

Field Details

INSTANCE

public static final StatsViewGeneral INSTANCE

The main instance of this Class.

Method Details

getDisplayName

@NotNull
public final @NotNull net.minecraft.network.chat.Component getDisplayName()

Description copied from class: StatsView

Returns the display name of this StatsView.
This Component will be shown on the GUI to indicate the view's name.

Specified by:

getDisplayName in interface com.thecsdev.commonmc.api.client.gui.widget.TDropdownWidget.Entry

Specified by:

getDisplayName in class StatsView

initFilters

public final void initFilters(@NotNull
 @NotNull StatsView.FiltersInitContext context)

Description copied from class: StatsView

Invoked when a StatsView's filters GUI is initializing.

Overrides:

initFilters in class StatsView

Parameters:

context - The StatsView.FiltersInitContext.

initStats

public final void initStats(@NotNull
 @NotNull StatsView.StatsInitContext context)

Description copied from class: StatsView

Invoked when the StatsView's statistics GUI is initializing.

Specified by:

initStats in class StatsView

Parameters:

context - The StatsView.StatsInitContext.

postProcessWidget

public final void postProcessWidget(@NotNull
 StatsView.StatsInitContext context,
 @NotNull
 @NotNull com.thecsdev.commonmc.api.client.gui.widget.stats.TCustomStatWidget widget)

Post-processes a TCustomStatWidget after its creation.

Parameters:

context - The StatsView.StatsInitContext.

widget - The TCustomStatWidget to post-process.

Throws:

NullPointerException - If any of the arguments is null.

getStatsSorter

@NotNull
protected final @NotNull Comparator<com.thecsdev.commonmc.api.stats.util.CustomStat> getStatsSorter(@NotNull
 @NotNull StatsView.Filters filters)
                                                                                             throws NullPointerException

Description copied from class: SubjectStatsView

The Comparator used for sorting SubjectStats shown on this SubjectStatsView's "Statistics" panel.

Overrides:

getStatsSorter in class SubjectStatsView<com.thecsdev.commonmc.api.stats.util.CustomStat>

Parameters:

filters - The StatsView.Filters.

Throws:

NullPointerException - If the argument is null.

getStatsGrouper

@NotNull
protected final @NotNull Function<Iterable<com.thecsdev.commonmc.api.stats.util.CustomStat>, LinkedHashMap<net.minecraft.network.chat.Component, Iterable<com.thecsdev.commonmc.api.stats.util.CustomStat>>> getStatsGrouper(@NotNull
 @NotNull StatsView.Filters filters)

Description copied from class: SubjectStatsView

The Function that takes a collection of SubjectStats and groups them into a Map based on the StatsView.Filters.

Overrides:

getStatsGrouper in class SubjectStatsView<com.thecsdev.commonmc.api.stats.util.CustomStat>

Parameters:

filters - The StatsView.Filters.