Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Editor > StatsViewer > IStatsPage

Light Theme

Dark Theme

IStatsPage

The public interface for a stats page.

Windows

MacOS

Linux

Inheritance Hierarchy

IStatsPage

FStatsPage

References

Module	StatsViewer
Header	/Engine/Source/Editor/StatsViewer/Public/IStatsPage.h
Include	#include "IStatsPage.h"

Syntax

class IStatsPage

Remarks

The public interface for a stats page.

The table does its best to display the relevant information.

Objects UCLASS metadata required are: DisplayName - The name displayed in the page selection dropdown. Tooltip - The tooltip displayed in the page selection dropdown. ObjectSetType - A text representation of the UENUM used for object set enumeration.

The object set UENUM also uses metadata to display certain information. UENUM metadata syntax differs from UCLASS metadata as it is specified via the UMETA() tag, rather than meta=() UPROPERTY subtags. DisplayName - The name displayed in the object set dropdown. ToolTip - The tooltip displayed over the object set dropdown.

The UI supports the following UPROPERTY metadata: ColumnWidth - Integer value. The (proportionally-based, not absolute) width of the properties column. ShowTotal - Either true or false. Whether the column header should attempt to show a total (provided in Generate() via the OutTotals map). SortMode - Either Ascending or Descending. If this is specified then the properties column will be sorted on table creation. Unit - Text value displayed next to table entries and totals

Functions

	Name	Description
void	AddEntry ( UObject* InEntry )	Adds a stats entry to the page Not all pages have to override this - only ones that accept transient data output from processes that do not persist in the editor
void	Clear()	Clears any entries added via AddEntry() Not all pages have to override this - only ones that accept transient data output from processes that do not persist in the editor
void	Generate ( TArray< TWeakObjectPtr< UObject > >... )	Fill the output array with statistic objects to be displayed
void	GenerateTotals ( const TArray< TWeakObjectPtr< UObje..., TMap< FString, FText >& OutTotals )	Totals are displayed by mapping the CPP name of the columns property to the total string in the OutTotals map.
void	GetCustomColumns ( TArray< TSharedRef< class IProperty... )	Get any column customizations that this page wants to use.
TSharedPtr< ...	GetCustomFilter ( TWeakPtr< class IStatsViewer > InPa... )	Get custom filter to display in the top part of the stats viewer, can return nullptr
TSharedPtr< ...	GetCustomWidget ( TWeakPtr< class IStatsViewer > InPa... )	Get custom widget to display in the top part of the stats viewer, can return nullptr
const FText	GetDisplayName()	Get the name of the entry type to be displayed in the page selection dropdown
UClass *	GetEntryClass()	Get the class of the entry we handle This is needed to display the search filter's combo button
FName	GetName()	Get the name of the entry type
int32	GetObjectSetCount()	Get the number of object sets this page supports
FString	GetObjectSetName ( int32 InObjectSetIndex )	Get the name of the object set, to be displayed in the dropdown
FString	GetObjectSetToolTip ( int32 InObjectSetIndex )	Get the tooltip of the object set, to be displayed over the object set the dropdown
int32	GetSelectedObjectSet()	Get the currently displayed object set
const FText	GetToolTip()	Get the tooltip to be displayed over the page selection dropdown
UWorld *	GetWorld()	Get the world used for page statistics.
bool	IsRefreshPending()	Check if this page wants to refresh itself
bool	IsShowPending()	Check if this page wants to show itself
void	OnHide()	Called back each time the page is hidden
void	OnShow ( TWeakPtr< class IStatsViewer > InPa... )	Called back each time the page is shown
void	Refresh ( bool bRefresh )	Sends a requests to the stats page to refresh itself the next chance it gets
void	SetSelectedObjectSet ( int32 InObjectSetIndex )	Set the currently displayed object set
void	SetWorld ( UWorld& InWorld )	Set a specific world to use for page statistics.
void	Show ( bool bShow )	Tries to switch the currently displayed page to this one

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss