UAutomatedPerfTestControllerBase

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

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
ArtifactOutputPath FString   AutomatedPerfTestControllerBase.h  
bRequestsCSVProfiler bool   AutomatedPerfTestControllerBase.h  
bRequestsFPSChart bool   AutomatedPerfTestControllerBase.h  
bRequestsInsightsTrace bool   AutomatedPerfTestControllerBase.h  
bRequestsLockedDynRes bool   AutomatedPerfTestControllerBase.h  
bRequestsVideoCapture bool   AutomatedPerfTestControllerBase.h  
CsvProfileEndCaptureEvent FGraphEventRef Event for the most recent call to TryStopCSVProfiler. AutomatedPerfTestControllerBase.h  
CsvProfilerDelegateHandle FDelegateHandle   AutomatedPerfTestControllerBase.h  
GameMode AGameModeBase *   AutomatedPerfTestControllerBase.h  
InsightsRegionID uint64   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

void ConsoleCommand ( const TCHAR* Cmd
)

   AutomatedPerfTestControllerBase.h  

AGameModeBase * GetGameMode()

   AutomatedPerfTestControllerBase.h  

FString GetOverallRegionName()

   AutomatedPerfTestControllerBase.h  

FString GetTestID()

   AutomatedPerfTestControllerBase.h  

FString GetTestName()

   AutomatedPerfTestControllerBase.h  

FString GetTraceChannels()

   AutomatedPerfTestControllerBase.h  

void OnPreWorldInitializeInternal ( UWorld* World,
const UWorld::InitializationValues IVS
)

   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  

void TakeScreenshot ( FString ScreenshotName
)

   AutomatedPerfTestControllerBase.h  

bool TryFinalizingVideoCapture ( const bool bStopAutoContinue
)

   AutomatedPerfTestControllerBase.h  

bool TryStartCSVProfiler ( FString CSVFileName,
const FString& DestinationFolder,
int32 Frames
)

   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  

Public Virtual

Name Remarks Include Path Unreal Specifiers

virtual void Exit()

   AutomatedPerfTestControllerBase.h  

virtual void GatherTestMetadata ( TArray< TPair< FString, FString > >& OutMetadata
) const

 Gather test metadata key-value pairs for profiling instruments. AutomatedPerfTestControllerBase.h  

virtual FString GetPerfTestTypeID()

 Unique identifier for the class type provided to output artifact generation. AutomatedPerfTestControllerBase.h  

virtual void OnPreWorldInitialize ( UWorld* World
)

   AutomatedPerfTestControllerBase.h  

virtual void RunTest()

   AutomatedPerfTestControllerBase.h  

virtual void SetupTest()

   AutomatedPerfTestControllerBase.h  

virtual void TeardownTest ( bool bExitAfterTeardown
)

   AutomatedPerfTestControllerBase.h  

virtual void TriggerExitAfterDelay()

   AutomatedPerfTestControllerBase.h  

Protected

Name Remarks Include Path Unreal Specifiers

void EndTestFailure ( const int32 ExitCode
)

 Shut down and queue an exit with an exit code of 1 to indicate generic failure. AutomatedPerfTestControllerBase.h  

void EndTestSuccess()

 Shut down and queue an exit with an exit code of 0 to indicate success. AutomatedPerfTestControllerBase.h  

APlayerController * GetPlayerController()

   AutomatedPerfTestControllerBase.h  

void InitializeInsights()

   AutomatedPerfTestControllerBase.h  

void MarkProfilingEnd()

   AutomatedPerfTestControllerBase.h  

void MarkProfilingStart()

   AutomatedPerfTestControllerBase.h  

void SetupGameModeInstance()

   AutomatedPerfTestControllerBase.h  

void SetupProfiling()

 Profiling Functions AutomatedPerfTestControllerBase.h  

void ShutdownInsights()

   AutomatedPerfTestControllerBase.h  

void TeardownProfiling()

   AutomatedPerfTestControllerBase.h  

Protected Virtual

Name Remarks Include Path Unreal Specifiers

virtual void OnVideoRecordingFinalized ( bool Succeeded,
const FString& FilePath
)

   AutomatedPerfTestControllerBase.h  

virtual void UnbindAllDelegates()

   AutomatedPerfTestControllerBase.h  

Overridden from UGauntletTestController

Name Remarks Include Path Unreal Specifiers

virtual void OnInit()

   AutomatedPerfTestControllerBase.h  

virtual void OnTick ( float TimeDelta
)

   AutomatedPerfTestControllerBase.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

   AutomatedPerfTestControllerBase.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page