1. Epic GamesDeveloper
  3. UAutomationBlueprintFunctionLibrary

UAutomationBlueprintFunctionLibrary

API > API/Developer > API/Developer/FunctionalTesting

   
Name UAutomationBlueprintFunctionLibrary
Type class
Header File /Engine/Source/Developer/FunctionalTesting/Public/AutomationBlueprintFunctionLibrary.h
Include Path #include "AutomationBlueprintFunctionLibrary.h"

Syntax

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

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UAutomationBlueprintFunctionLibrary ( const FObjectInitializer& ObjectInitializer
)

   AutomationBlueprintFunctionLibrary.h  

Functions

Public

Static

Name Remarks Include Path Unreal Specifiers

static 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. AutomationBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="Automation"
  • Meta=(AdvancedDisplay="Occurrences, ExactMatch, IsRegex")

static 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. AutomationBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="Automation"
  • Meta=(AdvancedDisplay="Occurrences, ExactMatch, IsRegex")

static void AddExpectedPlainLogError ( FString ExpectedString,
int32 Occurrences,
bool ExactMatch
)

 Mute the report of log error and warning matching a plain string during an automated test AutomationBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="Automation"
  • Meta=(AdvancedDisplay="Occurrences, ExactMatch")

static 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 AutomationBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="Automation"
  • Meta=(AdvancedDisplay="Occurrences, ExactMatch")

static void AddTestError ( const FString& InLogItem
)

 Add error to currently running automated test. AutomationBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="Automation"

static void AddTestInfo ( const FString& InLogItem
)

 Add info to currently running automated test. AutomationBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="Automation"

static void AddTestTelemetryData ( FString DataPoint,
float Measurement,
FString Context
)

 Add Telemetry data to currently running automated test. AutomationBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="Automation"
  • Meta=(AdvancedDisplay="Context")

static void AddTestWarning ( const FString& InLogItem
)

 Add warning to currently running automated test. AutomationBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="Automation"

static bool AreAutomatedTestsRunning()

 Lets you know if any automated tests are running, or are about to run and the automation system is spinning up tests. AutomationBlueprintFunctionLibrary.h
  • BlueprintPure
  • Category="Automation"

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

   AutomationBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="Automation"
  • Meta=(Latent, HidePin="WorldContextObject", DefaultToSelf="WorldContextObject", LatentInfo="LatentInfo")

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

   AutomationBlueprintFunctionLibrary.h  

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

   AutomationBlueprintFunctionLibrary.h  

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

 Request image comparison. AutomationBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="Automation"
  • Meta=(AdvancedDisplay="ComparisonName, ComparisonTolerance, ComparisonNotes", HidePin="WorldContextObject", DefaultToSelf="WorldContextObject")

static void DisableStatGroup ( UObject* WorldContextObject,
FName GroupName
)

   AutomationBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="Automation"
  • Meta=(HidePin="WorldContextObject", DefaultToSelf="WorldContextObject")

static void EnableStatGroup ( UObject* WorldContextObject,
FName GroupName
)

   AutomationBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="Automation"
  • Meta=(HidePin="WorldContextObject", DefaultToSelf="WorldContextObject")

static void FinishLoadingBeforeScreenshot()

   AutomationBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="Automation"

static FIntPoint GetAutomationScreenshotSize ( const FAutomationScreenshotOptions& Options
)

   AutomationBlueprintFunctionLibrary.h  

static FAutomationScreenshotOptions GetDefaultScreenshotOptionsForGameplay ( EComparisonTolerance Tolerance,
float Delay
)

   AutomationBlueprintFunctionLibrary.h
  • BlueprintPure
  • Category="Automation"

static FAutomationScreenshotOptions GetDefaultScreenshotOptionsForRendering ( EComparisonTolerance Tolerance,
float Delay
)

   AutomationBlueprintFunctionLibrary.h
  • BlueprintPure
  • Category="Automation"

static EViewModeIndex GetEditorActiveViewportViewMode ()

 Get the ViewMode (Lit/Unlit/etc.) of the active viewport. AutomationBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="Automation"

static float GetEditorActiveViewportWireframeOpacity()

 Retrieves the opacity for wireframe viewport view modes of the active viewport. AutomationBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="Automation"

static float GetStatCallCount ( FName StatName
)

   AutomationBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="Automation"

static float GetStatExcAverage ( FName StatName
)

   AutomationBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="Automation"

static float GetStatExcMax ( FName StatName
)

   AutomationBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="Automation"

static float GetStatIncAverage ( FName StatName
)

   AutomationBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="Automation"

static float GetStatIncMax ( FName StatName
)

   AutomationBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="Automation"

static void SetEditorActiveViewportViewMode ( EViewModeIndex Index
)

 Sets ViewMode (Lit/Unlit/etc.) of the first active viewport found AutomationBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="Automation"

static void SetEditorActiveViewportWireframeOpacity ( float Opacity
)

 Sets the opacity for wireframe viewport view modes of the active viewport. AutomationBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="Automation"

static void SetEditorViewportViewMode ( EViewModeIndex Index
)

 Sets all viewports of the first found level editor to have the given ViewMode (Lit/Unlit/etc.) AutomationBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="Automation"

static 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.) AutomationBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="Automation"

static void SetScalabilityQualityLevelRelativeToMax ( UObject* WorldContextObject,
int32 Value
)

 Sets all other settings based on an overall value AutomationBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="Automation"
  • Meta=(HidePin="WorldContextObject", DefaultToSelf="WorldContextObject")

static void SetScalabilityQualityToEpic ( UObject* WorldContextObject
)

   AutomationBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="Automation"
  • Meta=(HidePin="WorldContextObject", DefaultToSelf="WorldContextObject")

static void SetScalabilityQualityToLow ( UObject* WorldContextObject
)

   AutomationBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="Automation"
  • Meta=(HidePin="WorldContextObject", DefaultToSelf="WorldContextObject")

static void SetTestTelemetryStorage ( FString StorageName
)

 Set Telemetry data storage name of currently running automated test. AutomationBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="Automation"

static 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. AutomationBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="Automation"
  • Meta=(Latent, HidePin="WorldContextObject", DefaultToSelf="WorldContextObject", LatentInfo="LatentInfo", Name="")

static 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. AutomationBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="Automation"
  • Meta=(Latent, HidePin="WorldContextObject", DefaultToSelf="WorldContextObject", LatentInfo="LatentInfo", NameOverride="")

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

   AutomationBlueprintFunctionLibrary.h  

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

   AutomationBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="Automation"
  • Meta=(Latent, HidePin="WorldContextObject", DefaultToSelf="WorldContextObject", LatentInfo="LatentInfo", NameOverride="")

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

   AutomationBlueprintFunctionLibrary.h  

static 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. AutomationBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="Automation"
  • Meta=(AdvancedDisplay="Camera, bMaskEnabled, bCaptureHDR, ComparisonTolerance, ComparisonNotes, bForceGameView")

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page