Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Core > Misc > FAutomationSpecBase

Light Theme

Dark Theme

FAutomationSpecBase

Windows

MacOS

Linux

Inheritance Hierarchy

FAutomationTestBase

TSharedFromThis

FAutomationSpecBase

References

Module	Core
Header	/Engine/Source/Runtime/Core/Public/Misc/AutomationTest.h
Include	#include "Misc/AutomationTest.h"

Syntax

class FAutomationSpecBase :
public FAutomationTestBase,
public TSharedFromThis< FAutomationSpecBase >

Variables

		Name	Description
	bool	bEnableSkipIfError	Whether or not BeforeEach and It blocks should skip execution if the test has already failed
	FTimespan	DefaultTimeout	The timespan for how long a block should be allowed to execute before giving up and failing the test

Constructors

	Name	Description
	FAutomationSpecBase ( const FString& InName, const bool bInComplexTask )

Functions

		Name	Description
	void	AfterEach ( EAsyncExecution Execution, const FTimespan& Timeout, TFunction< void()> DoWork )
	void	AfterEach ( EAsyncExecution Execution, TFunction< void()> DoWork )
	void	AfterEach ( TFunction< void()> DoWork )
	void	BeforeEach ( EAsyncExecution Execution, const FTimespan& Timeout, TFunction< void()> DoWork )
	void	BeforeEach ( TFunction< void()> DoWork )
	void	BeforeEach ( EAsyncExecution Execution, TFunction< void()> DoWork )
	void	Define()
	void	Describe ( const FString& InDescription, TFunction< void()> DoWork )
	void	EnsureDefinitions()
	bool	IsStressTest()
	void	It ( const FString& InDescription, EAsyncExecution Execution, const FTimespan& Timeout, TFunction< void()> DoWork )
	void	It ( const FString& InDescription, EAsyncExecution Execution, TFunction< void()> DoWork )
	void	It ( const FString& InDescription, TFunction< void()> DoWork )
	void	LatentAfterEach ( TFunction< void... )
	void	LatentAfterEach ( EAsyncExecution Execution, const FTimespan& Timeout, TFunction< void... )
	void	LatentAfterEach ( const FTimespan& Timeout, TFunction< void... )
	void	LatentAfterEach ( EAsyncExecution Execution, TFunction< void... )
	void	LatentBeforeEach ( TFunction< void... )
	void	LatentBeforeEach ( EAsyncExecution Execution, TFunction< void... )
	void	LatentBeforeEach ( EAsyncExecution Execution, const FTimespan& Timeout, TFunction< void... )
	void	LatentBeforeEach ( const FTimespan& Timeout, TFunction< void... )
	void	LatentIt ( const FString& InDescription, TFunction< void... )
	void	LatentIt ( const FString& InDescription, const FTimespan& Timeout, TFunction< void... )
	void	LatentIt ( const FString& InDescription, EAsyncExecution Execution, TFunction< void... )
	void	LatentIt ( const FString& InDescription, EAsyncExecution Execution, const FTimespan& Timeout, TFunction< void... )
	void	PostDefine()
	void	Redefine()
	void	xAfterEach ( TFunction< void()> DoWork )
	void	xAfterEach ( EAsyncExecution Execution, TFunction< void()> DoWork )
	void	xAfterEach ( EAsyncExecution Execution, const FTimespan& Timeout, TFunction< void()> DoWork )
	void	xBeforeEach ( TFunction< void()> DoWork )
	void	xBeforeEach ( EAsyncExecution Execution, TFunction< void()> DoWork )
	void	xBeforeEach ( EAsyncExecution Execution, const FTimespan& Timeout, TFunction< void()> DoWork )
	void	xDescribe ( const FString& InDescription, TFunction< void()> DoWork )
	void	xIt ( const FString& InDescription, EAsyncExecution Execution, const FTimespan& Timeout, TFunction< void()> DoWork )
	void	xIt ( const FString& InDescription, TFunction< void()> DoWork )
	void	xIt ( const FString& InDescription, EAsyncExecution Execution, TFunction< void()> DoWork )
	void	xLatentAfterEach ( TFunction< void... )
	void	xLatentAfterEach ( const FTimespan& Timeout, TFunction< void... )
	void	xLatentAfterEach ( EAsyncExecution Execution, TFunction< void... )
	void	xLatentAfterEach ( EAsyncExecution Execution, const FTimespan& Timeout, TFunction< void... )
	void	xLatentBeforeEach ( TFunction< void... )
	void	xLatentBeforeEach ( const FTimespan& Timeout, TFunction< void... )
	void	xLatentBeforeEach ( EAsyncExecution Execution, TFunction< void... )
	void	xLatentBeforeEach ( EAsyncExecution Execution, const FTimespan& Timeout, TFunction< void... )
	void	xLatentIt ( const FString& InDescription, EAsyncExecution Execution, TFunction< void... )
	void	xLatentIt ( const FString& InDescription, TFunction< void... )
	void	xLatentIt ( const FString& InDescription, const FTimespan& Timeout, TFunction< void... )
	void	xLatentIt ( const FString& InDescription, EAsyncExecution Execution, const FTimespan& Timeout, TFunction< void... )

Overridden from FAutomationTestBase

	Name	Description
uint32	GetRequiredDeviceNum()	Pure virtual method; returns the number of participants for this test
void	GetTests ( TArray< FString >& OutBeautifiedNa..., TArray< FString >& OutTestCommands )	Asks the test to enumerate variants that will all go through the "RunTest" function with different parameters (for load all maps, this should enumerate all maps to load)\
int32	GetTestSourceFileLine ( const FString& InTestName )	Gets the line number where this test was defined.
FString	GetTestSourceFileName ( const FString& InTestName )	Gets the filename where this test was defined.
bool	RunTest ( const FString& Parameters )	Virtual call to execute the automation test.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss