Navigation
API > API/Plugins > API/Plugins/AutomatedPerfTesting
| Name | UAutomatedPerfTestControllerBase |
| Type | class |
| Header File | /Engine/Plugins/Performance/AutomatedPerfTesting/Source/AutomatedPerfTesting/Public/AutomatedPerfTestControllerBase.h |
| Include Path | #include "AutomatedPerfTestControllerBase.h" |
Syntax
UCLASS (MinimalAPI)
class UAutomatedPerfTestControllerBase : public UGauntletTestController
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UGauntletTestController → UAutomatedPerfTestControllerBase
Derived Classes
UAutomatedPerfTestControllerBase derived class hierarchy
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UAutomatedPerfTestControllerBase
(
const FObjectInitializer& ObjectInitializer |
Base functionality. | AutomatedPerfTestControllerBase.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bRequestsCSVProfiler | bool | AutomatedPerfTestControllerBase.h | ||
| bRequestsFPSChart | bool | AutomatedPerfTestControllerBase.h | ||
| bRequestsInsightsTrace | bool | AutomatedPerfTestControllerBase.h | ||
| bRequestsLockedDynRes | bool | AutomatedPerfTestControllerBase.h | ||
| bRequestsVideoCapture | bool | AutomatedPerfTestControllerBase.h | ||
| CmdsToExecEarly | const TArray< FString > | AutomatedPerfTestControllerBase.h | ||
| CSVOutputMode | EAutomatedPerfTestCSVOutputMode | AutomatedPerfTestControllerBase.h | ||
| CsvProfilerDelegateHandle | FDelegateHandle | AutomatedPerfTestControllerBase.h | ||
| DeviceProfileOverride | FString | AutomatedPerfTestControllerBase.h | ||
| GameMode | AGameModeBase * | AutomatedPerfTestControllerBase.h | ||
| TestDatetime | FString | AutomatedPerfTestControllerBase.h | ||
| TestID | FString | AutomatedPerfTestControllerBase.h | ||
| TraceChannels | FString | AutomatedPerfTestControllerBase.h | ||
| VideoRecordingTitle | FText | AutomatedPerfTestControllerBase.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Exit() |
AutomatedPerfTestControllerBase.h | ||
EAutomatedPerfTestCSVOutputMode GetCSVOutputMode() |
AutomatedPerfTestControllerBase.h | ||
FString GetDeviceProfile() |
AutomatedPerfTestControllerBase.h | ||
AGameModeBase * GetGameMode() |
AutomatedPerfTestControllerBase.h | ||
FString GetOverallRegionName() |
AutomatedPerfTestControllerBase.h | ||
virtual FString GetTestID() |
AutomatedPerfTestControllerBase.h | ||
FString GetTestName() |
AutomatedPerfTestControllerBase.h | ||
FString GetTraceChannels() |
AutomatedPerfTestControllerBase.h | ||
void OnGameStateSet
(
AGameStateBase*const GameStateBase |
AutomatedPerfTestControllerBase.h | ||
virtual void OnPreWorldInitialize
(
UWorld* World |
AutomatedPerfTestControllerBase.h | ||
void OnPreWorldInitializeInternal
(
UWorld* World, |
AutomatedPerfTestControllerBase.h | ||
void OnWorldBeginPlay() |
AutomatedPerfTestControllerBase.h | ||
bool RequestsCSVProfiler() |
AutomatedPerfTestControllerBase.h | ||
bool RequestsFPSChart() |
AutomatedPerfTestControllerBase.h | ||
bool RequestsInsightsTrace() |
AutomatedPerfTestControllerBase.h | ||
bool RequestsLockedDynRes() |
AutomatedPerfTestControllerBase.h | ||
bool RequestsVideoCapture() |
AutomatedPerfTestControllerBase.h | ||
virtual void RunTest() |
AutomatedPerfTestControllerBase.h | ||
void SetCSVOutputMode
(
EAutomatedPerfTestCSVOutputMode NewOutputMode |
You'll need to set this via your subclass if you want to customize the behavior otherwise it will default to a single CSV per session | AutomatedPerfTestControllerBase.h | |
virtual void SetupTest() |
AutomatedPerfTestControllerBase.h | ||
void TakeScreenshot
(
FString ScreenshotName |
AutomatedPerfTestControllerBase.h | ||
virtual void TeardownTest
(
bool bExitAfterTeardown |
AutomatedPerfTestControllerBase.h | ||
virtual void TriggerExitAfterDelay() |
AutomatedPerfTestControllerBase.h | ||
void TryEarlyExec
(
UWorld*const World |
AutomatedPerfTestControllerBase.h | ||
bool TryFinalizingVideoCapture
(
const bool bStopAutoContinue |
AutomatedPerfTestControllerBase.h | ||
virtual bool TryStartCSVProfiler () |
AutomatedPerfTestControllerBase.h | ||
virtual bool TryStartCSVProfiler
(
FString CSVFileName |
AutomatedPerfTestControllerBase.h | ||
bool TryStartFPSChart() |
AutomatedPerfTestControllerBase.h | ||
bool TryStartInsightsTrace() |
AutomatedPerfTestControllerBase.h | ||
bool TryStartVideoCapture() |
AutomatedPerfTestControllerBase.h | ||
bool TryStopCSVProfiler() |
AutomatedPerfTestControllerBase.h | ||
bool TryStopFPSChart() |
AutomatedPerfTestControllerBase.h | ||
bool TryStopInsightsTrace() |
AutomatedPerfTestControllerBase.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void EndAutomatedPerfTest
(
const int32 ExitCode |
AutomatedPerfTestControllerBase.h | ||
virtual FString GetCSVFilename() |
AutomatedPerfTestControllerBase.h | ||
virtual FString GetInsightsFilename() |
AutomatedPerfTestControllerBase.h | ||
virtual void OnVideoRecordingFinalized
(
bool Succeeded, |
AutomatedPerfTestControllerBase.h | ||
void SetupGameModeInstance() |
AutomatedPerfTestControllerBase.h | ||
virtual void UnbindAllDelegates() |
AutomatedPerfTestControllerBase.h |
Overridden from UGauntletTestController
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnInit() |
AutomatedPerfTestControllerBase.h | ||
virtual void OnPreMapChange() |
AutomatedPerfTestControllerBase.h | ||
| AutomatedPerfTestControllerBase.h | |||
virtual void OnTick
(
float TimeDelta |
AutomatedPerfTestControllerBase.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void BeginDestroy() |
AutomatedPerfTestControllerBase.h |