FEngineStatFuncs

Struct for keeping track off all the info regarding a specific simple stat exec

Windows
MacOS
Linux

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Engine/Engine.h

Include

#include "Engine/Engine.h"

Syntax

struct FEngineStatFuncs

Remarks

Struct for keeping track off all the info regarding a specific simple stat exec

Variables

Name Description

Public variable

bool

 

bIsRHS

If true, this stat should render on the right side of the viewport, otherwise left

Public variable

FName

 

CategoryName

The category the command falls into (only used by UI)

Public variable

FName

 

CommandName

The name of the command, e.g. STAT FPS would just have FPS as it's CommandName

Public variable

FString

 

CommandNameString

A string version of CommandName without STAT_ at the beginning. Cached for optimization.

Public variable

FText

 

DescriptionString

The description of what this command does (only used by UI)

Public variable

FEngineStatRend...

 

RenderFunc

The function needed to render the stat when it's enabled Note: This is only called when it should be rendered

Public variable

FEngineStatTogg...

 

ToggleFunc

The function we call after the stat has been toggled Note: This is only needed if you need to do something else depending on the state of the stat

Constructors

Name Description

Public function

FEngineStatFuncs

(
    const FName& InCommandName,
    const FName& InCategoryName,
    const FText& InDescriptionString,
    FEngineStatRender InRenderFunc,
    FEngineStatToggle InToggleFunc,
    const bool bInIsRHS
)

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