1. Epic GamesDeveloper
  3. UAutomationBlueprintFunctionLibrary

UAutomationBlueprintFunctionLibrary

API > API/Developer > API/Developer/FunctionalTesting

Inheritance Hierarchy

  • UBlueprintFunctionLibrary
  • UAutomationBlueprintFunctionLibrary

References

   
Module FunctionalTesting
Header /Engine/Source/Developer/FunctionalTesting/Public/AutomationBlueprintFunctionLibrary.h
Include #include "AutomationBlueprintFunctionLibrary.h"

Syntax

UCLASS (Meta=(ScriptName="AutomationLibrary"))  
class UAutomationBlueprintFunctionLibrary : public UBlueprintFunctionLibrary

Constructors

  Type Name Description
Public function  

UAutomationBlueprintFunctionLibrary ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Static UFunction BlueprintCallable, Category, Meta void

AddExpectedLogError ( FString ExpectedPatternString,
int32 Occurrences,
bool ExactMatch,
bool IsRegex
)

 Mute the report of log error and warning matching a pattern during an automated test.
Public function Static UFunction BlueprintCallable, Category, Meta void

AddExpectedLogMessage ( FString ExpectedPatternString,
int32 Occurrences,
bool ExactMatch,
bool IsRegex
)

 Expect a specific log message to match a pattern during an automated test regardless of its verbosity.
Public function Static UFunction BlueprintCallable, Category, Meta void

AddExpectedPlainLogError ( FString ExpectedString,
int32 Occurrences,
bool ExactMatch
)

 Mute the report of log error and warning matching a plain string during an automated test
Public function Static UFunction BlueprintCallable, Category, Meta void

AddExpectedPlainLogMessage ( FString ExpectedString,
int32 Occurrences,
bool ExactMatch
)

 Expect a specific log message to match a plain string during an automated test regardless of its verbosity
Public function Static UFunction BlueprintCallable, Category void

AddTestError ( const FString& InLogItem
)

 Add error to currently running automated test.
Public function Static UFunction BlueprintCallable, Category void

AddTestInfo ( const FString& InLogItem
)

 Add info to currently running automated test.
Public function Static UFunction BlueprintCallable, Category, Meta void

AddTestTelemetryData ( FString DataPoint,
float Measurement,
FString Context
)

 Add Telemetry data to currently running automated test.
Public function Static UFunction BlueprintCallable, Category void

AddTestWarning ( const FString& InLogItem
)

 Add warning to currently running automated test.
Public function Static UFunction BlueprintPure, Category bool Lets you know if any automated tests are running, or are about to run and the automation system is spinning up tests.
Public function Static UFunction BlueprintCallable, Category, Meta void

AutomationWaitForLoading ( UObject* WorldContextObject,
FLatentActionInfo LatentInfo,
FAutomationWaitForLoadingOptions Options
)

  
Public function Static FAutomationScreenshotData

BuildScreenshotData ( const FString& MapOrContext,
const FString& ScreenShotName,
int32 Width,
int32 Height
)

  
Public function Static FAutomationScreenshotData

BuildScreenshotData ( UWorld* InWorld,
const FString& ScreenShotName,
int32 Width,
int32 Height
)

  
Public function Static UFunction BlueprintCallable, Category, Meta bool

CompareImageAgainstReference ( FString ImageFilePath,
FString ComparisonName,
EComparisonTolerance ComparisonTolerance,
FString ComparisonNotes,
UObject* WorldContextObject
)

 Request image comparison.
Public function Static UFunction BlueprintCallable, Category, Meta void

DisableStatGroup ( UObject* WorldContextObject,
FName GroupName
)

  
Public function Static UFunction BlueprintCallable, Category, Meta void

EnableStatGroup ( UObject* WorldContextObject,
FName GroupName
)

  
Public function Static UFunction BlueprintCallable, Category void  
Public function Static FIntPoint  
Public function Static UFunction BlueprintPure, Category FAutomationScreenshotOptions  
Public function Static UFunction BlueprintPure, Category FAutomationScreenshotOptions  
Public function Static UFunction BlueprintCallable, Category float

GetStatCallCount ( FName StatName
)

  
Public function Static UFunction BlueprintCallable, Category float

GetStatExcAverage ( FName StatName
)

  
Public function Static UFunction BlueprintCallable, Category float

GetStatExcMax ( FName StatName
)

  
Public function Static UFunction BlueprintCallable, Category float

GetStatIncAverage ( FName StatName
)

  
Public function Static UFunction BlueprintCallable, Category float

GetStatIncMax ( FName StatName
)

  
Public function Static UFunction BlueprintCallable, Category void

SetEditorViewportViewMode ( EViewModeIndex Index
)

 Sets all viewports of the first found level editor to have the given ViewMode (Lit/Unlit/etc.)
Public function Static UFunction BlueprintCallable, Category void

SetEditorViewportVisualizeBuffer ( FName BufferName
)

 Sets all viewports of the first found level editor to have the VisualizeBuffer ViewMode and also display a given buffer (BaseColor/Metallic/Roughness/etc.)
Public function Static UFunction BlueprintCallable, Category, Meta void

SetScalabilityQualityLevelRelativeToMax ( UObject* WorldContextObject,
int32 Value
)

 Sets all other settings based on an overall value
Public function Static UFunction BlueprintCallable, Category, Meta void

SetScalabilityQualityToEpic ( UObject* WorldContextObject
)

  
Public function Static UFunction BlueprintCallable, Category, Meta void

SetScalabilityQualityToLow ( UObject* WorldContextObject
)

  
Public function Static UFunction BlueprintCallable, Category void

SetTestTelemetryStorage ( FString StorageName
)

 Set Telemetry data storage name of currently running automated test.
Public function Static UFunction BlueprintCallable, Category, Meta void

TakeAutomationScreenshot ( UObject* WorldContextObject,
FLatentActionInfo LatentInfo,
const FString& Name,
const FString& Notes,
const FAutomationScreenshotOptions& Options
)

 Takes a screenshot of the game's viewport. Does not capture any UI.
Public function Static UFunction BlueprintCallable, Category, Meta void

TakeAutomationScreenshotAtCamera ( UObject* WorldContextObject,
FLatentActionInfo LatentInfo,
ACameraActor* Camera,
const FString& NameOverride,
const FString& Notes,
const FAutomationScreenshotOptions& Options
)

 Takes a screenshot of the game's viewport, from a particular camera actors POV.
Public function Static bool

TakeAutomationScreenshotInternal ( UObject* WorldContextObject,
const FString& ScreenShotName,
const FString& Notes,
FAutomationScreenshotOptions Options
)

  
Public function Static UFunction BlueprintCallable, Category, Meta void

TakeAutomationScreenshotOfUI ( UObject* WorldContextObject,
FLatentActionInfo LatentInfo,
const FString& Name,
const FAutomationScreenshotOptions& Options
)

  
Public function Static bool

TakeAutomationScreenshotOfUI_Immediate ( UObject* WorldContextObject,
const FString& Name,
const FAutomationScreenshotOptions& Options
)

  
Public function Static UFunction BlueprintCallable, Category, Meta UAutomationEditorTask *

TakeHighResScreenshot ( int32 ResX,
int32 ResY,
FString Filename,
ACameraActor* Camera,
bool bMaskEnabled,
bool bCaptureHDR,
EComparisonTolerance ComparisonTolerance,
FString ComparisonNotes,
float Delay,
bool bForceGameView
)

 Take high res screenshot in editor.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page