Class Driver
Syntax
public class Driver : MonoBehaviour
Fields
Steps
Declaration
public static List<RecordingInputModule.TouchData> Steps
Field Value
Properties
Invoke this to perform a driver action with an error being thrown on failure.
Declaration
public static Driver Perform { get; }
Property Value
Invoke this to attempt to perform a driver action without an error being thrown on failure.
Declaration
public static Driver TryPerform { get; }
Property Value
Methods
Grabs the requested step's index, and waits until the step is executed.
Declaration
public IEnumerator Action(RecordingInputModule.TouchData action)
Parameters
Returns
Click(String, Single)
Declaration
public IEnumerator Click(string querySelector, float holdDurationBeforeReleasingClick = 0F)
Parameters
| Type |
Name |
Description |
| String |
querySelector |
|
| Single |
holdDurationBeforeReleasingClick |
|
Returns
Click(GameElement, Single)
Declaration
public IEnumerator Click(GameElement ge, float holdDurationBeforeReleasingClick = 0F)
Parameters
Returns
Click(GameObject, Single)
Declaration
public IEnumerator Click(GameObject go, float holdDurationBeforeReleasingClick = 0F)
Parameters
Returns
Click(Vector2, Single)
Declaration
public IEnumerator Click(Vector2 clickPosition, float holdDurationBeforeReleasingClick = 0F)
Parameters
| Type |
Name |
Description |
| Vector2 |
clickPosition |
|
| Single |
holdDurationBeforeReleasingClick |
|
Returns
Drag(String, String, Single)
Declaration
public IEnumerator Drag(string querySelectorDragObject, string querySelectorTargetOfDrag, float duration = 1F)
Parameters
| Type |
Name |
Description |
| String |
querySelectorDragObject |
|
| String |
querySelectorTargetOfDrag |
|
| Single |
duration |
|
Returns
Drag(String, Vector2, Single)
Declaration
public IEnumerator Drag(string querySelectorDragObject, Vector2 targetDropPosition, float duration = 1F)
Parameters
| Type |
Name |
Description |
| String |
querySelectorDragObject |
|
| Vector2 |
targetDropPosition |
|
| Single |
duration |
|
Returns
Drag(GameElement, GameElement, Single)
Declaration
public IEnumerator Drag(GameElement ge, GameElement target, float duration = 1F)
Parameters
Returns
Drag(GameElement, Vector2, Single)
Declaration
public IEnumerator Drag(GameElement ge, Vector2 position, float duration = 1F)
Parameters
Returns
Drag(GameObject, GameObject, Single)
Declaration
public IEnumerator Drag(GameObject go, GameObject target, float duration = 1F)
Parameters
Returns
Drag(GameObject, Vector2, Single)
Declaration
public IEnumerator Drag(GameObject go, Vector2 position, float duration = 1F)
Parameters
Returns
EmitTestComplete()
Declaration
public IEnumerator EmitTestComplete()
Returns
GetError(String)
Declaration
protected string GetError(string stepInfo)
Parameters
| Type |
Name |
Description |
| String |
stepInfo |
|
Returns
KeyDown(String, Single)
Presses a key for the given duration.
Declaration
public IEnumerator KeyDown(string key, float duration)
Parameters
Returns
KeyDown(KeyCode, Single)
Presses a key for the given duration.
Declaration
public IEnumerator KeyDown(KeyCode key, float duration)
Parameters
Returns
Declaration
protected IEnumerator PerformInterpolatedDragActions(int startIndex, int interpolatedEventCount, float duration = 2F)
Parameters
| Type |
Name |
Description |
| Int32 |
startIndex |
|
| Int32 |
interpolatedEventCount |
|
| Single |
duration |
|
Returns
PlayRecording(String)
Play a recording and yield until it completes
Declaration
public IEnumerator PlayRecording(string recordingFilePath)
Parameters
| Type |
Name |
Description |
| String |
recordingFilePath |
The path to the recording data
|
Returns
Presses a controller button for the given duration.
Declaration
public IEnumerator PressControllerButton(string buttonName, float duration)
Parameters
Returns
Only use this when registering an action BEFORE test execution has begun. If multiple steps are registered individually before any are executed,
then each added data will be inserted before the previous one, yielding unintended order of execution. Use Driver.Perform.RegisterSteps during test
execution to register multiple steps in a row.
Declaration
public void RegisterStep(RecordingInputModule.TouchData data)
Parameters
This will determine the correct placement of touchdata added either before or while test execution is in progress.
Declaration
public void RegisterSteps(params RecordingInputModule.TouchData[] data)
Parameters
Reset()
Declaration
public static void Reset()
SendKeys(String, String, Single)
Find GameElement using query selector and type text into field.
Declaration
public IEnumerator SendKeys(string querySelector, string text, float duration = -1F)
Parameters
Returns
SendKeys(GameElement, String, Single)
Provide GameElement and type text into field.
Declaration
public IEnumerator SendKeys(GameElement ge, string text, float duration = -1F)
Parameters
Returns
SendKeys(GameObject, String, Single)
Provide GameObject and type text into field.
Declaration
public IEnumerator SendKeys(GameObject go, string text, float duration = -1F)
Parameters
Returns
WaitFor(Func<Boolean>)
Declaration
public IEnumerator WaitFor(Func<bool> condition)
Parameters
Returns
WaitFor(Func<Boolean>, Single)
Declaration
public IEnumerator WaitFor(Func<bool> condition, float timeoutPeriodForWait)
Parameters
Returns