1. Epic GamesDeveloper
  3. IAutomationLatentCommandWithRetriesAndDelays

IAutomationLatentCommandWithRetriesAndDelays

Extension of [IAutomationLatentCommand](API\Runtime\Core\Misc\IAutomationLatentCommand) with delays between attempts if initial command does not succeed.

API > API/Runtime > API/Runtime/Core > API/Runtime/Core/Misc

Inheritance Hierarchy

References

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

Syntax

class IAutomationLatentCommandWithRetriesAndDelays : public IAutomationLatentCommand

Remarks

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

Variables

  Type Name Description
Protected variable const bool bHasUnlimitedRetries Indicates that this latent command has unlimited retries Used to implement the MaxTotalRunTimeInSeconds logic
Protected variable const FString CommandClassName Command Name stored for easy logging.
Protected variable double DelayStartTime Time that the Delay Timer started.
Protected variable const double DelayTimeInSeconds Time in between UpdateDelayed calls. Default is 1 second but can be overridden.
Protected variable const int32 MaxRetries Times to retry command before reporting command failure. Defaults to 10, but can be overridden.

Constructors

  Type Name Description
Protected function   Default constructor
Protected function  

IAutomationLatentCommandWithRetriesAndDelays ( const FString InCommandClassName,
const int32 InMaxRetries,
const double InWaitTimeBetweenRuns
)

 Parameterized constructor

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Protected function Const bool Determines if we should execute the command.
Public function Virtual void

CommandFailedDueToError ( const FString& ErrorMessage
)

  
Public function bool

Execute ()

 Pure virtual method that must be overridden. This is the actual command logic.
Protected function Const FAutomationTestBase *  
Protected function Const FString Returns the command name.
Protected function bool Returns if we have exceeded max allowed total run time for this latent command.
Protected function Const bool Determines if timer is running, pausing execution in a non-blocking way.
Protected function void

OverrideMaxTotalRunTimeInSeconds ( double OverrideValue
)

  
Protected function void Resets the Delay Timer by setting start time to now (In game time).

Overridden from IAutomationLatentCommand

  Type Name Description
Public function Virtual bool

Update ()

 Base Update override with delay logic built in. Can be further overridden in child classes

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page