Navigation
API > API/Runtime > API/Runtime/Core
Extension of IAutomationLatentCommand with delays between attempts if initial command does not succeed. Has a max retry count that can be overridden. Default is 10 retries with a 1 second delay in between. To protect against misuse of unlimited retries, has a Max execution time of 5 minutes. This can be overridden, but not recommended. Only do this if you're absolutely certain it will not cause an infinite loop
| Name | IAutomationLatentCommandWithRetriesAndDelays |
| Type | class |
| Header File | /Engine/Source/Runtime/Core/Public/Misc/AutomationTest.h |
| Include Path | #include "Misc/AutomationTest.h" |
Syntax
class IAutomationLatentCommandWithRetriesAndDelays : public IAutomationLatentCommand
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Default constructor | Misc/AutomationTest.h | ||
IAutomationLatentCommandWithRetriesAndDelays
(
const FString InCommandClassName, |
Parameterized constructor | Misc/AutomationTest.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IAutomationLatentCommandWithRetriesAndDelays() |
Misc/AutomationTest.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| CurrentIteration | int32 | To keep track of which iteration we are on. | Misc/AutomationTest.h | |
| MaxTotalRunTimeInSeconds | double | Max total run time for command Default is 5 minutes, but can be overridden | Misc/AutomationTest.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void CommandFailedDueToError
(
const FString& ErrorMessage |
Misc/AutomationTest.h | ||
bool Execute() |
Pure virtual method that must be overridden. This is the actual command logic. | Misc/AutomationTest.h |
Overridden from IAutomationLatentCommand
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool Update() |
Base Update override with delay logic built in. Can be further overridden in child classes | Misc/AutomationTest.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool CanRetry () |
Determines if we should execute the command. | Misc/AutomationTest.h | |
FAutomationTestBase * GetCurrentTest() |
Misc/AutomationTest.h | ||
FString GetTestAndCommandName() |
Returns the command name. | Misc/AutomationTest.h | |
bool HasExceededMaxTotalRunTime() |
Returns if we have exceeded max allowed total run time for this latent command. | Misc/AutomationTest.h | |
bool IsDelayTimerRunning() |
Determines if timer is running, pausing execution in a non-blocking way. | Misc/AutomationTest.h | |
void OverrideMaxTotalRunTimeInSeconds
(
double OverrideValue |
Misc/AutomationTest.h | ||
void ResetDelayTimer() |
Resets the Delay Timer by setting start time to now (In game time). | Misc/AutomationTest.h |