1. Epic GamesDeveloper
  3. IAsyncActionSequence

IAsyncActionSequence

Unreal Engine C++ API Reference > Developer > AutomationDriver

References

   
Module AutomationDriver
Header /Engine/Source/Developer/AutomationDriver/Public/IDriverSequence.h
Include #include "IDriverSequence.h"

Syntax

class IAsyncActionSequence

Functions

  Type Name Description
Public function IAsyncActionSequence &

Click ()

 Queues the series of events to invoke a click with the left mouse button at the current cursor location
Public function IAsyncActionSequence &

Click ( const TSharedRef< IElementLocator, ESPMode::ThreadSafe >& ElementLocator
)

 Queues a move of the cursor over the element, then triggers the series of events to invoke a click with the left mouse button
Public function IAsyncActionSequence &

Click ( EMouseButtons::Type MouseButton
)

 Queues the series of events to invoke a click with the specified mouse button at the current cursor location
Public function IAsyncActionSequence &

Click ( const TSharedRef< IElementLocator, ESPMode::ThreadSafe >& ElementLocator,
EMouseButtons::Type MouseButton
)

 Queues a move of the cursor over the element, then triggers the series of events to invoke a click with the specified mouse button
Public function IAsyncActionSequence & Queues the series of events to invoke a double click with the left mouse button at the current cursor location
Public function IAsyncActionSequence &

DoubleClick ( const TSharedRef< IElementLocator, ESPMode::ThreadSafe >& ElementLocator
)

 Queues a move of the cursor over the element, then triggers the series of events to invoke a double click with the left mouse button
Public function IAsyncActionSequence & Queues the series of events to invoke a double click with the specified mouse button at the current cursor location
Public function IAsyncActionSequence &

DoubleClick ( const TSharedRef< IElementLocator, ESPMode::ThreadSafe >& ElementLocator,
EMouseButtons::Type MouseButton
)

 Queues a move of the cursor over the element, then triggers the series of events to invoke a double click with the specified mouse button
Public function IAsyncActionSequence &

Focus ( const TSharedRef< IElementLocator, ESPMode::ThreadSafe >& ElementLocator
)

 Queues a change of focus to the element for the default user
Public function IAsyncActionSequence &

Focus ( const TSharedRef< IElementLocator, ESPMode::ThreadSafe >& ElementLocator,
uint32 UserFocus
)

 Queues a change of focus to the element for the specified user
Public function IAsyncActionSequence &

MoveByOffset ( int32 XOffset,
int32 YOffset
)

 Queues a move of the cursor from its current position by the specified offsets
Public function IAsyncActionSequence &

MoveToElement ( const TSharedRef< IElementLocator, ESPMode::ThreadSafe >& ElementLocator
)

 Queues a move of the cursor over the center of the element, triggering any hover cue the element may have
Public function IAsyncActionSequence &

MoveToElement ( const TSharedRef< IElementLocator, ESPMode::ThreadSafe >& ElementLocator,
int32 XOffset,
int32 YOffset
)

 Queues a move of the cursor over the center of the element offset by the specified amounts, triggering any hover cue the element may have
Public function IAsyncActionSequence &

Press ( const TSharedRef< IElementLocator, ESPMode::ThreadSafe >& ElementLocator,
FKey Key
)

 Queues a change of focus to the specified element, then a series of events to invoke keyboard input for pressing the specified key.
Public function IAsyncActionSequence &

Press ( const TSharedRef< IElementLocator, ESPMode::ThreadSafe >& ElementLocator,
TCHAR Character
)

 Queues a change of focus to the specified element, then a series of events to invoke keyboard input for pressing the specified character.
Public function IAsyncActionSequence &

Press ( const TSharedRef< IElementLocator, ESPMode::ThreadSafe >& ElementLocator,
EMouseButtons::Type MouseButton
)

 Queues a move of the cursor over the element, then a series of events to invoke mouse input for pressing the specified button.
Public function IAsyncActionSequence &

Press ( FKey Key
)

 Queues the series of events to invoke keyboard input for pressing the specified key.
Public function IAsyncActionSequence &

Press ( TCHAR Character
)

 Queues the series of events to invoke keyboard input for pressing the specified character.
Public function IAsyncActionSequence &

Press ( EMouseButtons::Type MouseButton
)

 Queues the series of events to invoke mouse input for pressing the specified button.
Public function IAsyncActionSequence &

PressChord ( const TSharedRef< IElementLocator, ESPMode::ThreadSafe >& ElementLocator,
FKey Key1,
FKey Key2,
FKey Key3
)

 Queues a change of focus to the element, then triggers the series of events to invoke keyboard input for each argument in order from 1 to N.
Public function IAsyncActionSequence &

PressChord ( const TSharedRef< IElementLocator, ESPMode::ThreadSafe >& ElementLocator,
FKey Key1,
TCHAR Character
)

 Queues a change of focus to the element, then triggers the series of events to invoke keyboard input for each argument in order from 1 to N.
Public function IAsyncActionSequence &

PressChord ( const TSharedRef< IElementLocator, ESPMode::ThreadSafe >& ElementLocator,
FKey Key1,
FKey Key2
)

 Queues a change of focus to the element, then triggers the series of events to invoke keyboard input for each argument in order from 1 to N.
Public function IAsyncActionSequence &

PressChord ( const TSharedRef< IElementLocator, ESPMode::ThreadSafe >& ElementLocator,
FKey Key1,
FKey Key2,
TCHAR Character
)

 Queues a change of focus to the element, then triggers the series of events to invoke keyboard input for each argument in order from 1 to N.
Public function IAsyncActionSequence &

PressChord ( FKey Key1,
FKey Key2,
FKey Key3
)

 Queues the series of events to invoke keyboard input for each argument in order from 1 to N.
Public function IAsyncActionSequence &

PressChord ( FKey Key1,
TCHAR Character
)

 Queues the series of events to invoke keyboard input for each argument in order from 1 to N.
Public function IAsyncActionSequence &

PressChord ( FKey Key1,
FKey Key2
)

 Queues the series of events to invoke keyboard input for each argument in order from 1 to N.
Public function IAsyncActionSequence &

PressChord ( FKey Key1,
FKey Key2,
TCHAR Character
)

 Queues the series of events to invoke keyboard input for each argument in order from 1 to N.
Public function IAsyncActionSequence &

Release ( TCHAR Character
)

 Queues the series of events to invoke keyboard input for releasing the specified character.
Public function IAsyncActionSequence &

Release ( FKey Key
)

 Queues the series of events to invoke keyboard input for releasing the specified key.
Public function IAsyncActionSequence &

Release ( EMouseButtons::Type MouseButton
)

 Queues the series of events to invoke mouse input for releasing the specified button.
Public function IAsyncActionSequence &

Release ( const TSharedRef< IElementLocator, ESPMode::ThreadSafe >& ElementLocator,
TCHAR Character
)

 Queues a change of focus to the element, then triggers the series of events to invoke keyboard input for releasing the specified character.
Public function IAsyncActionSequence &

Release ( const TSharedRef< IElementLocator, ESPMode::ThreadSafe >& ElementLocator,
FKey Key
)

 Queues a change of focus to the element, then triggers the series of events to invoke keyboard input for releasing the specified character.
Public function IAsyncActionSequence &

Release ( const TSharedRef< IElementLocator, ESPMode::ThreadSafe >& ElementLocator,
EMouseButtons::Type MouseButton
)

 Queues a move of the cursor over the element, then triggers the series of events to invoke mouse input for releasing the specified button.
Public function IAsyncActionSequence &

ReleaseChord ( const TSharedRef< IElementLocator, ESPMode::ThreadSafe >& ElementLocator,
FKey Key1,
TCHAR Character
)

 Queues a change of focus to the element, then triggers the series of events to invoke keyboard input for each argument in order from N to 1.
Public function IAsyncActionSequence &

ReleaseChord ( const TSharedRef< IElementLocator, ESPMode::ThreadSafe >& ElementLocator,
FKey Key1,
FKey Key2,
TCHAR Character
)

 Queues a change of focus to the element, then triggers the series of events to invoke keyboard input for each argument in order from N to 1.
Public function IAsyncActionSequence &

ReleaseChord ( const TSharedRef< IElementLocator, ESPMode::ThreadSafe >& ElementLocator,
FKey Key1,
FKey Key2,
FKey Key3
)

 Queues a change of focus to the element, then triggers the series of events to invoke keyboard input for each argument in order from N to 1.
Public function IAsyncActionSequence &

ReleaseChord ( const TSharedRef< IElementLocator, ESPMode::ThreadSafe >& ElementLocator,
FKey Key1,
FKey Key2
)

 Queues a change of focus to the element, then triggers the series of events to invoke keyboard input for each argument in order from N to 1.
Public function IAsyncActionSequence &

ReleaseChord ( FKey Key1,
FKey Key2,
FKey Key3
)

 Queues the series of events to invoke keyboard input for each argument in order from N to 1.
Public function IAsyncActionSequence &

ReleaseChord ( FKey Key1,
TCHAR Character
)

 Queues the series of events to invoke keyboard input for each argument in order from N to 1.
Public function IAsyncActionSequence &

ReleaseChord ( FKey Key1,
FKey Key2
)

 Queues the series of events to invoke keyboard input for each argument in order from N to 1.
Public function IAsyncActionSequence &

ReleaseChord ( FKey Key1,
FKey Key2,
TCHAR Character
)

 Queues the series of events to invoke keyboard input for each argument in order from N to 1.
Public function IAsyncActionSequence &

ScrollBy ( float Delta
)

 Queues the series of events to invoke a mouse wheel scroll by the specified delta at the current mouse position Most average user scrolling is limited to a range of -5 to 5.
Public function IAsyncActionSequence &

ScrollBy ( const TSharedRef< IElementLocator, ESPMode::ThreadSafe >& ElementLocator,
float Delta
)

 Queues a move of the cursor over the element, then triggers the series of events to invoke a mouse wheel scroll by the specified delta
Public function IAsyncActionSequence &

ScrollToBeginning ( const TSharedRef< IElementLocator, ESPMode::ThreadSafe >& ElementLocator
)

 Queues a move of the cursor over the element, then triggers the series of events to invoke a mouse wheel scroll, scrolling the element until it reaches the beginning
Public function IAsyncActionSequence &

ScrollToBeginning ( const TSharedRef< IElementLocator, ESPMode::ThreadSafe >& ElementLocator,
float Amount
)

 Queues a move of the cursor over the element, then triggers the series of events to invoke a mouse wheel scroll by the specified delta amount, scrolling the element until it reaches the beginning
Public function IAsyncActionSequence &

ScrollToBeginningUntil ( const TSharedRef< IElementLocator, ESPMode::ThreadSafe >& ScrollableElementLocator,
const TSharedRef< IElementLocator, ESPMode::ThreadSafe >& ElementLocator
)

 Queues a move of the cursor over the scrollable element, then triggers the series of events to invoke a mouse wheel scroll until the specified locator locates the desired element or the beginning is reached
Public function IAsyncActionSequence &

ScrollToBeginningUntil ( const TSharedRef< IElementLocator, ESPMode::ThreadSafe >& ElementLocator
)

 Queues the series of events to invoke a mouse wheel scroll until the specified locator is locates the desired element or the beginning is reached at the current cursor position
Public function IAsyncActionSequence &

ScrollToEnd ( const TSharedRef< IElementLocator, ESPMode::ThreadSafe >& ElementLocator
)

 Queues a move of the cursor over the element, then triggers the series of events to invoke a mouse wheel scroll, scrolling the element until it reaches the end
Public function IAsyncActionSequence &

ScrollToEnd ( const TSharedRef< IElementLocator, ESPMode::ThreadSafe >& ElementLocator,
float Delta
)

 Queues a move of the cursor over the element, then triggers the series of events to invoke a mouse wheel scroll by the specified delta amount, scrolling the element until it reaches the end
Public function IAsyncActionSequence &

ScrollToEndUntil ( const TSharedRef< IElementLocator, ESPMode::ThreadSafe >& ElementLocator
)

 Queues a move of the cursor over the element, then triggers the series of events to invoke a mouse wheel scroll until the specified locator locates the desired element or the end is reached
Public function IAsyncActionSequence &

ScrollToEndUntil ( const TSharedRef< IElementLocator, ESPMode::ThreadSafe >& ScrollableElementLocator,
const TSharedRef< IElementLocator, ESPMode::ThreadSafe >& ElementLocator
)

 Queues a move of the cursor over the scrollable element, then triggers the series of events to invoke a mouse wheel scroll until the specified locator locates the desired element or the end is reached
Public function IAsyncActionSequence &

Type ( const TSharedRef< IElementLocator, ESPMode::ThreadSafe >& ElementLocator,
FKey Key1
)

 Queues the a change of focus to the specified element, then a series of events to invoke keyboard input for the key specified.
Public function IAsyncActionSequence &

Type ( TCHAR Character
)

 Queues the series of events to invoke keyboard input for the character specified.
Public function IAsyncActionSequence &

Type ( const TSharedRef< IElementLocator, ESPMode::ThreadSafe >& ElementLocator,
const TArray< FKey >& Keys
)

 Queues the a change of focus to the specified element, then a series of events to invoke keyboard input for each key specified.
Public function IAsyncActionSequence &

Type ( const TSharedRef< IElementLocator, ESPMode::ThreadSafe >& ElementLocator,
TCHAR Character
)

 Queues the a change of focus to the specified element, then a series of events to invoke keyboard input for the character specified.
Public function IAsyncActionSequence &

Type ( const TSharedRef< IElementLocator, ESPMode::ThreadSafe >& ElementLocator,
FString Text
)

 Queues the a change of focus to the specified element, then a series of events to invoke keyboard input for each character of the string specified.
Public function IAsyncActionSequence &

Type ( FKey Key
)

 Queues the series of events to invoke keyboard input for the key specified.
Public function IAsyncActionSequence &

Type ( const TArray< FKey >& Keys
)

 Queues the series of events to invoke keyboard input for each key specified.
Public function IAsyncActionSequence &

Type ( FString Text
)

 Queues the series of events to invoke keyboard input for each character of the string specified.
Public function IAsyncActionSequence &

Type ( const TCHAR* Text
)

 Queues the series of events to invoke keyboard input for each character specified.
Public function IAsyncActionSequence &

Type ( const TSharedRef< IElementLocator, ESPMode::ThreadSafe >& ElementLocator,
const TCHAR* Text
)

 Queues the a change of focus to the specified element, then a series of events to invoke keyboard input for each character specified.
Public function IAsyncActionSequence &

TypeChord ( const TSharedRef< IElementLocator, ESPMode::ThreadSafe >& ElementLocator,
FKey Key1,
FKey Key2,
FKey Key3
)

 Queues the a change of focus to the specified element, then a series of events to invoke keyboard input for each argument in order from 1 to N and then releasing those keys in order from N to 1 Chord typing is intended to ease the to execution keyboard shortcuts, such as, CTRL + SHIFT + S
Public function IAsyncActionSequence &

TypeChord ( FKey Key1,
FKey Key2
)

 Queues the series of events to invoke keyboard input for each argument in order from 1 to N and then releasing those keys in order from N to 1 Chord typing is intended to ease the to execution keyboard shortcuts, such as, CTRL + SHIFT + S
Public function IAsyncActionSequence &

TypeChord ( FKey Key1,
TCHAR Character
)

 Queues the series of events to invoke keyboard input for each argument in order from 1 to N and then releasing those keys in order from N to 1 Chord typing is intended to ease the to execution keyboard shortcuts, such as, CTRL + SHIFT + S
Public function IAsyncActionSequence &

TypeChord ( FKey Key1,
FKey Key2,
FKey Key3
)

 Queues the series of events to invoke keyboard input for each argument in order from 1 to N and then releasing those keys in order from N to 1 Chord typing is intended to ease the to execution keyboard shortcuts, such as, CTRL + SHIFT + S
Public function IAsyncActionSequence &

TypeChord ( FKey Key1,
FKey Key2,
TCHAR Character
)

 Queues the series of events to invoke keyboard input for each argument in order from 1 to N and then releasing those keys in order from N to 1 Chord typing is intended to ease the to execution keyboard shortcuts, such as, CTRL + SHIFT + S
Public function IAsyncActionSequence &

TypeChord ( const TSharedRef< IElementLocator, ESPMode::ThreadSafe >& ElementLocator,
FKey Key1,
FKey Key2
)

 Queues the a change of focus to the specified element, then a series of events to invoke keyboard input for each argument in order from 1 to N and then releasing those keys in order from N to 1 Chord typing is intended to ease the to execution keyboard shortcuts, such as, CTRL + SHIFT + S
Public function IAsyncActionSequence &

TypeChord ( const TSharedRef< IElementLocator, ESPMode::ThreadSafe >& ElementLocator,
FKey Key1,
TCHAR Character
)

 Queues the a change of focus to the specified element, then a series of events to invoke keyboard input for each argument in order from 1 to N and then releasing those keys in order from N to 1 Chord typing is intended to ease the to execution keyboard shortcuts, such as, CTRL + SHIFT + S
Public function IAsyncActionSequence &

TypeChord ( const TSharedRef< IElementLocator, ESPMode::ThreadSafe >& ElementLocator,
FKey Key1,
FKey Key2,
TCHAR Character
)

 Queues the a change of focus to the specified element, then a series of events to invoke keyboard input for each argument in order from 1 to N and then releasing those keys in order from N to 1 Chord typing is intended to ease the to execution keyboard shortcuts, such as, CTRL + SHIFT + S
Public function IAsyncActionSequence &

Wait ( FTimespan Timespan
)

 Queues a wait no shorter than for the specified Timespan
Public function IAsyncActionSequence &

Wait ( const FDriverWaitDelegate& Delegate
)

 Queues a wait until the specified DriverWaitDelegate returns a PASSED or FAILED response

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page