Navigation
Unreal Engine C++ API Reference > Developer > AutomationController
References
Module | AutomationController |
Header | /Engine/Source/Developer/AutomationController/Public/IAutomationControllerManager.h |
Include | #include "IAutomationControllerManager.h" |
Syntax
class IAutomationControllerManager
Remarks
Interface for AutomationController .
Destructors
Type | Name | Description | |
---|---|---|---|
![]() ![]() |
Virtual destructor. |
Functions
Type | Name | Description | |
---|---|---|---|
![]() ![]() |
const bool | Check if the automation tests have completed. | |
![]() |
void | Remove results from the automation controller module. | |
![]() |
const bool | ExportReport
(
uint32 FileExportTypeMask |
Generate an automation report. |
![]() ![]() |
FString | GetClusterGroupName
(
const int32 ClusterIndex |
Get the group name of the specified cluster. |
![]() ![]() |
FString | GetDeviceName
(
const int32 ClusterIndex, |
Get a device name. |
![]() ![]() |
FString | GetDeviceTypeName
(
const int32 ClusterIndex |
Get name of a particular device cluster. |
![]() |
TArray< TSharedPtr< IAutomationReport > > | Gives the array of enabled test results to the UI. | |
![]() ![]() |
void | GetEnabledTestNames
(
TArray< FString >& OutEnabledTestNames |
Gets the names of all the enabled tests. |
![]() ![]() |
int32 | Returns number of tests that will be run. | |
![]() |
TArray< TSharedPtr< IAutomationReport > > & | Gives the array of filtered test results to the UI. | |
![]() ![]() |
void | GetFilteredTestNames
(
TArray< FString >& OutFilteredTestNames |
Gets the names of all the filtered tests. |
![]() ![]() |
FString | GetGameInstanceName
(
const int32 ClusterIndex, |
Get a game instance name. |
![]() ![]() |
int32 | Get num devices types. | |
![]() ![]() |
int32 | GetNumDevicesInCluster
(
const int32 ClusterIndex |
Get num devices in specified cluster. |
![]() |
int32 | GetNumPasses () |
Get the number of test passes. |
![]() ![]() |
FString | ||
![]() ![]() |
EAutomationControllerModuleState::Type | GetTestState () |
Gets the controller's current test state. |
![]() |
void | Init () |
Initializes the automation controller. |
![]() ![]() |
bool | Returns whether the automation tests should include developer content directories. | |
![]() ![]() |
bool | IsDeviceGroupFlagSet
(
EAutomationDeviceGroupTypes::Type InDeviceGroup |
Checks if a device group flag is set. |
![]() |
bool | Return true when the manager is ready and capable of executing tests. | |
![]() ![]() |
bool | Returns if analytics should be sent | |
![]() ![]() |
bool | IsTestRunnable
(
IAutomationReportPtr InReport |
Check that the test we are looking to run is runnable. |
![]() ![]() |
bool | KeepPIEOpen () |
Returns if PIE should be kept open when test pass end |
![]() |
FOnAutomationControllerReset & | Gets a delegate that is invoked when the controller's reset. | |
![]() |
FOnAutomationControllerManagerShutdown & | OnShutdown () |
Gets the multicast delegate that is invoked when the controller manager shuts down. |
![]() |
FOnAutomationControllerManagerTestsAvailable & | Gets the multicast delegate that is invoked when the controller has tests available. | |
![]() |
FOnAutomationControllerTestsComplete & | Gets the test complete multicast delegate. | |
![]() |
FOnAutomationControllerTestsRefreshed & | Gets the multicast delegate that is invoked when the controller's test status changes. | |
![]() |
void | Removes all callbacks. | |
![]() ![]() |
const bool | Check if the automation tests results have errors. | |
![]() ![]() |
const bool | Check if the automation tests results have logs. | |
![]() ![]() |
const bool | 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 bInDeveloperDirectoryIncluded |
Sets whether the automation tests should include developer content directories. |
![]() |
void | SetEnabledTests
(
const TArray< FString >& EnabledTests |
Sets any tests that match a name in the enabled tests array. |
![]() |
void | SetFilter
(
TSharedPtr< AutomationFilterCollection > InFilter |
Filters the visible list of tests. |
![]() |
void | SetKeepPIEOpen
(
const bool bNewValue |
Sets if PIE should be kept open when test pass end |
![]() |
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 InDeviceGroup |
Toggles a device group flag. |
![]() |
void | Updates the clusters when the device grouping changes. |
Deprecated Functions
Type | Name | Description | |
---|---|---|---|
![]() |
TArray< TSharedPtr< IAutomationReport > > & | GetReports () |
Use GetFilteredReports or GetEnabledReports instead. |