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 > Developer > AutomationController > IAutomationControllerManager

Light Theme

Dark Theme

IAutomationControllerManager

Interface for AutomationController .

Windows

MacOS

Linux

References

Module	AutomationController
Header	/Engine/Source/Developer/AutomationController/Public/IAutomationControllerManager.h
Include	#include "IAutomationControllerManager.h"

Syntax

class IAutomationControllerManager

Remarks

Interface for AutomationController .

Destructors

	Name	Description
	~IAutomationControllerManager()	Virtual destructor.

Functions

	Name	Description
const bool	CheckTestResultsAvailable()	Check if the automation tests have completed.
void	CleanUpCheckpointFile()
void	ClearAutomationReports()	Remove results from the automation controller module.
const bool	ExportReport ( uint32 FileExportTypeMask )	Generate an automation report.
TArray< FStr...	GetCheckpointFileContents()
FArchive ...	GetCheckpointFileForWrite()
FString	GetClusterGroupName ( const int32 ClusterIndex )	Get the group name of the specified cluster.
FString	GetDeviceTypeName ( const int32 ClusterIndex )	Get name of a particular device cluster.
void	GetEnabledTestNames ( TArray< FString >& OutEnabledTestN... )	Gets the names of all the enabled tests.
int32	GetEnabledTestsNum()	Returns number of tests that will be run.
FString	GetGameInstanceName ( const int32 ClusterIndex, const int32 DeviceIndex )	Get a game instance name.
int32	GetNumDeviceClusters()	Get num devices types.
int32	GetNumDevicesInCluster ( const int32 ClusterIndex )	Get num devices in specified cluster.
int32	GetNumPasses()	Get the number of test passes.
FString	GetReportOutputPath()
TArray< TSha...	GetReports()	Gives the array of test results to the UI.
EAutomationC...	GetTestState()	Gets the controller's current test state.
void	Init()	Initializes the automation controller.
bool	IsDeveloperDirectoryIncluded()	Returns whether the automation tests should include developer content directories.
bool	IsDeviceGroupFlagSet ( EAutomationDeviceGroupTypes::Type I... )	Checks if a device group flag is set.
bool	IsSendAnalytics()	Returns if analytics should be sent
bool	IsTestRunnable ( IAutomationReportPtr InReport )	Check that the test we are looking to run is runnable.
FOnAutomatio...	OnControllerReset()	Gets a delegate that is invoked when the controller's reset.
FOnAutomatio...	OnShutdown()	Gets the multicast delegate that is invoked when the controller manager shuts down.
FOnAutomatio...	OnTestsAvailable()	Gets the multicast delegate that is invoked when the controller has tests available.
FOnAutomatio...	OnTestsComplete()	Gets the test complete multicast delegate.
FOnAutomatio...	OnTestsRefreshed()	Gets the multicast delegate that is invoked when the controller's test status changes.
void	RemoveCallbacks()	Removes all callbacks.
const bool	ReportsHaveErrors()	Check if the automation tests results have errors.
const bool	ReportsHaveLogs()	Check if the automation tests results have logs.
const bool	ReportsHaveWarnings()	Check if the automation tests results have warnings.
void	RequestAvailableWorkers ( const FGuid& InSessionId )	Broadcast a request for workers to ping if they are available.
void	RequestLoadAsset ( const FString& InAssetName )	Request an asset to be loaded in the editor.
void	RequestTests()	Send request for tests that are available to run.
void	ResetAutomationTestTimeout ( const TCHAR* Reason )
void	RunTests ( const bool bIsLocalSession )	Resets all enabled tests to be able to run during Tick by local/remote machines.
void	SetDeveloperDirectoryIncluded ( const bool bInDeveloperDirectoryInc... )	Sets whether the automation tests should include developer content directories.
void	SetEnabledTests ( const TArray< FString >& EnabledTe... )	Sets any tests that match a name in the enabled tests array.
void	SetFilter ( TSharedPtr< AutomationFilterCollect... )	Filters the visible list of tests.
void	SetNumPasses ( const int32 InNumPasses )	Sets the number of test passes.
void	SetRequestedTestFlags ( const uint32 InRequestedTestFlags )	Sets what flags we're considering automation tests from
void	SetSendAnalytics ( const bool bNewValue )	Sets if analytics should be sent
void	SetVisibleTestsEnabled ( const bool bEnabled )	Sets whether all visible tests are enabled or not.
void	Shutdown()	Shuts down the manager.
void	Startup()	Starts up the manager.
void	StopTests()	Stops all running tests.
void	Tick()	Tick function that will execute enabled tests for different device clusters.
void	ToggleDeviceGroupFlag ( EAutomationDeviceGroupTypes::Type I... )	Toggles a device group flag.
void	UpdateDeviceGroups()	Updates the clusters when the device grouping changes.
void	WriteLineToCheckpointFile ( FString LineToWrite )
void	WriteLoadedCheckpointDataToFile()

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

Take our survey

Dismiss