Navigation
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
- UObjectBase → UObjectBaseUtility → UObject → UBlueprintFunctionLibrary → UAutomationBlueprintFunctionLibrary
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, |
Mute the report of log error and warning matching a pattern during an automated test. | AutomationBlueprintFunctionLibrary.h |
|
static void AddExpectedLogMessage
(
FString ExpectedPatternString, |
Expect a specific log message to match a pattern during an automated test regardless of its verbosity. | AutomationBlueprintFunctionLibrary.h |
|
static void AddExpectedPlainLogError
(
FString ExpectedString, |
Mute the report of log error and warning matching a plain string during an automated test | AutomationBlueprintFunctionLibrary.h |
|
static void AddExpectedPlainLogMessage
(
FString ExpectedString, |
Expect a specific log message to match a plain string during an automated test regardless of its verbosity | AutomationBlueprintFunctionLibrary.h |
|
static void AddTestError
(
const FString& InLogItem |
Add error to currently running automated test. | AutomationBlueprintFunctionLibrary.h |
|
static void AddTestInfo
(
const FString& InLogItem |
Add info to currently running automated test. | AutomationBlueprintFunctionLibrary.h |
|
static void AddTestTelemetryData
(
FString DataPoint, |
Add Telemetry data to currently running automated test. | AutomationBlueprintFunctionLibrary.h |
|
static void AddTestWarning
(
const FString& InLogItem |
Add warning to currently running automated test. | AutomationBlueprintFunctionLibrary.h |
|
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 |
|
static void AutomationWaitForLoading
(
UObject* WorldContextObject, |
AutomationBlueprintFunctionLibrary.h |
|
|
static FAutomationScreenshotData BuildScreenshotData
(
const FString& MapOrContext, |
AutomationBlueprintFunctionLibrary.h | ||
static FAutomationScreenshotData BuildScreenshotData
(
UWorld* InWorld, |
AutomationBlueprintFunctionLibrary.h | ||
static bool CompareImageAgainstReference
(
FString ImageFilePath, |
Request image comparison. | AutomationBlueprintFunctionLibrary.h |
|
static void DisableStatGroup
(
UObject* WorldContextObject, |
AutomationBlueprintFunctionLibrary.h |
|
|
static void EnableStatGroup
(
UObject* WorldContextObject, |
AutomationBlueprintFunctionLibrary.h |
|
|
static void FinishLoadingBeforeScreenshot() |
AutomationBlueprintFunctionLibrary.h |
|
|
static FIntPoint GetAutomationScreenshotSize
(
const FAutomationScreenshotOptions& Options |
AutomationBlueprintFunctionLibrary.h | ||
static FAutomationScreenshotOptions GetDefaultScreenshotOptionsForGameplay
(
EComparisonTolerance Tolerance, |
AutomationBlueprintFunctionLibrary.h |
|
|
static FAutomationScreenshotOptions GetDefaultScreenshotOptionsForRendering
(
EComparisonTolerance Tolerance, |
AutomationBlueprintFunctionLibrary.h |
|
|
static EViewModeIndex GetEditorActiveViewportViewMode () |
Get the ViewMode (Lit/Unlit/etc.) of the active viewport. | AutomationBlueprintFunctionLibrary.h |
|
static float GetEditorActiveViewportWireframeOpacity() |
Retrieves the opacity for wireframe viewport view modes of the active viewport. | AutomationBlueprintFunctionLibrary.h |
|
static float GetStatCallCount
(
FName StatName |
AutomationBlueprintFunctionLibrary.h |
|
|
static float GetStatExcAverage
(
FName StatName |
AutomationBlueprintFunctionLibrary.h |
|
|
static float GetStatExcMax
(
FName StatName |
AutomationBlueprintFunctionLibrary.h |
|
|
static float GetStatIncAverage
(
FName StatName |
AutomationBlueprintFunctionLibrary.h |
|
|
static float GetStatIncMax
(
FName StatName |
AutomationBlueprintFunctionLibrary.h |
|
|
static void SetEditorActiveViewportViewMode
(
EViewModeIndex Index |
Sets ViewMode (Lit/Unlit/etc.) of the first active viewport found | AutomationBlueprintFunctionLibrary.h |
|
static void SetEditorActiveViewportWireframeOpacity
(
float Opacity |
Sets the opacity for wireframe viewport view modes of the active viewport. | AutomationBlueprintFunctionLibrary.h |
|
static void SetEditorViewportViewMode
(
EViewModeIndex Index |
Sets all viewports of the first found level editor to have the given ViewMode (Lit/Unlit/etc.) | AutomationBlueprintFunctionLibrary.h |
|
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 |
|
static void SetScalabilityQualityLevelRelativeToMax
(
UObject* WorldContextObject, |
Sets all other settings based on an overall value | AutomationBlueprintFunctionLibrary.h |
|
static void SetScalabilityQualityToEpic
(
UObject* WorldContextObject |
AutomationBlueprintFunctionLibrary.h |
|
|
static void SetScalabilityQualityToLow
(
UObject* WorldContextObject |
AutomationBlueprintFunctionLibrary.h |
|
|
static void SetTestTelemetryStorage
(
FString StorageName |
Set Telemetry data storage name of currently running automated test. | AutomationBlueprintFunctionLibrary.h |
|
static void TakeAutomationScreenshot
(
UObject* WorldContextObject, |
Takes a screenshot of the game's viewport. Does not capture any UI. | AutomationBlueprintFunctionLibrary.h |
|
static void TakeAutomationScreenshotAtCamera
(
UObject* WorldContextObject, |
Takes a screenshot of the game's viewport, from a particular camera actors POV. | AutomationBlueprintFunctionLibrary.h |
|
static bool TakeAutomationScreenshotInternal
(
UObject* WorldContextObject, |
AutomationBlueprintFunctionLibrary.h | ||
static void TakeAutomationScreenshotOfUI
(
UObject* WorldContextObject, |
AutomationBlueprintFunctionLibrary.h |
|
|
static bool TakeAutomationScreenshotOfUI_Immediate
(
UObject* WorldContextObject, |
AutomationBlueprintFunctionLibrary.h | ||
static UAutomationEditorTask * TakeHighResScreenshot
(
int32 ResX, |
Take high res screenshot in editor. | AutomationBlueprintFunctionLibrary.h |
|