API

If you are looking for information on a specific function, class or method, this part of the documentation is for you.

AltDriver

The AltDriver class represents the main game driver component. When you instantiate an AltDriver in your tests, you can use it to “drive” your game like one of your users would, by interacting with all the game objects, their properties and methods.

An AltDriver instance will connect to the running instrumented Unity application. In the constructor, we need to tell the driver where (on what IP and on what port) the instrumented Unity App is running. We can also set some more advanced parameters, as shown in the table below:

Parameters

Name Type Required Description
host string No The IP or hostname AltTester Unity SDK is listening on. The default value is "127.0.0.1".
port int No The default value is 13000.
enableLogging boolean No The default value is false.

Once you have an instance of the AltDriver, you can use all the available commands to interact with the game. The available methods are the following:

Find Objects

FindObject

Finds the first object in the scene that respects the given criteria. Check By for more information about criteria.

Parameters

Name Type Required Description
by By Yes Set what criteria to use in order to find the object.
value string Yes The value to which object will be compared to see if they respect the criteria or not.
cameraBy By No Set what criteria to use in order to find the camera.
cameraValue string No The value to which all the cameras in the scene will be compared to see if they respect the criteria or not to get the camera for which the screen coordinate of the object will be calculated. If no camera is given It will search through all camera that are in the scene until some camera sees the object or return the screen coordinate of the object calculated to the last camera in the scene.
enabled boolean No If true will match only objects that are active in hierarchy. If false will match all objects.

Returns

  • AltObject

Examples

[Test]
public void TestFindAltObject()
{
    const string name = "Capsule";
    var altObject = altDriver.FindObject(By.NAME,name);
    Assert.NotNull(altObject);
    Assert.AreEqual(name, altObject.name);
}

FindObjects

Finds all objects in the scene that respects the given criteria. Check By for more information about criteria.

Parameters

Name Type Required Description
by By Yes Set what criteria to use in order to find the object.
value string Yes The value to which object will be compared to see if they respect the criteria or not.
cameraBy By No Set what criteria to use in order to find the camera.
cameraValue string No The value to which all the cameras in the scene will be compared to see if they respect the criteria or not to get the camera for which the screen coordinate of the object will be calculated. If no camera is given It will search through all camera that are in the scene until some camera sees the object or return the screen coordinate of the object calculated to the last camera in the scene.
enabled boolean No If true will match only objects that are active in hierarchy. If false will match all objects.

Returns

  • List of AltObjects or an empty list if no objects were found.

Examples

[Test]
public void TestFindObjectsByTag()
{
    var altObjects = altDriver.FindObjects(By.TAG,"plane");
    Assert.AreEqual(2, altObjects.Count);
    foreach(var altObject in altObjects)
    {
        Assert.AreEqual("Plane", altObject.name);
    }
}

FindObjectWhichContains

Finds the first object in the scene that respects the given criteria. Check By for more information about criteria.

Parameters

Name Type Required Description
by By Yes Set what criteria to use in order to find the object.
value string Yes The value to which object will be compared to see if they respect the criteria or not.
cameraBy By No Set what criteria to use in order to find the camera.
cameraValue string No The value to which all the cameras in the scene will be compared to see if they respect the criteria or not to get the camera for which the screen coordinate of the object will be calculated. If no camera is given It will search through all camera that are in the scene until some camera sees the object or return the screen coordinate of the object calculated to the last camera in the scene.
enabled boolean No If true will match only objects that are active in hierarchy. If false will match all objects.

Returns

  • AltObject

Examples

[Test]
public void TestFindObjectWhichContains()
{
    var altObject = altDriver.FindObjectWhichContains(By.NAME, "Event");
    Assert.AreEqual("EventSystem", altObject.name);
}

FindObjectsWhichContain

Finds all objects in the scene that respects the given criteria. Check By for more information about criteria.

Parameters

Name Type Required Description
by By Yes Set what criteria to use in order to find the object.
value string Yes The value to which object will be compared to see if they respect the criteria or not.
cameraBy By No Set what criteria to use in order to find the camera.
cameraValue string No The value to which all the cameras in the scene will be compared to see if they respect the criteria or not to get the camera for which the screen coordinate of the object will be calculated. If no camera is given It will search through all camera that are in the scene until some camera sees the object or return the screen coordinate of the object calculated to the last camera in the scene.
enabled boolean No If true will match only objects that are active in hierarchy. If false will match all objects.

Returns

  • List of AltObjects or an empty list if no objects were found.

Examples

[Test]
public void TestFindObjects()
{
    var planes = altDriver.FindObjectsWhichContain(By.NAME, "Plane");
    Assert.AreEqual(3, planes.Count);
}

FindObjectAtCoordinates

Retrieves the Unity object at given coordinates.

Uses EventSystem.RaycastAll to find object. If no object is found then it uses UnityEngine.Physics.Raycast and UnityEngine.Physics2D.Raycast and returns the one closer to the camera.

Parameters

Name Type Required Description
coordinates Vector2 Yes The screen coordinates.

Returns

  • AltObject - The UI object hit by event system Raycast, nothing otherwise.

Examples

[Test]
public void TestFindElementAtCoordinates()
{
    var counterButton = altDriver.FindObject(By.NAME, "ButtonCounter");
    var element = altDriver.FindObjectAtCoordinates(new AltVector2(80 + counterButton.x, 15 + counterButton.y));
    Assert.AreEqual("Text", element.name);
}

GetAllElements

Returns information about every objects loaded in the currently loaded scenes. This also means objects that are set as DontDestroyOnLoad.

Parameters

Name Type Required Description
cameraBy By No Set what criteria to use in order to find the camera.
cameraValue string No The value to which all the cameras in the scene will be compared to see if they respect the criteria or not to get the camera for which the screen coordinate of the object will be calculated. If no camera is given It will search through all camera that are in the scene until some camera sees the object or return the screen coordinate of the object calculated to the last camera in the scene.
enabled boolean No If true will match only objects that are active in hierarchy. If false will match all objects.

Returns

  • List of AltObjects or an empty list if no objects were found.

Examples

[Test]
public void TestGetAllEnabledObjects()
{
    var altObjects = altDriver.GetAllElements(enabled: true);
    Assert.IsNotEmpty(altObjects);
}

WaitForObject

Waits until it finds an object that respects the given criteria or until timeout limit is reached. Check By for more information about criteria.

Parameters

Name Type Required Description
by By Yes Set what criteria to use in order to find the object.
value string Yes The value to which object will be compared to see if they respect the criteria or not.
cameraBy By No Set what criteria to use in order to find the camera.
cameraValue string No The value to which all the cameras in the scene will be compared to see if they respect the criteria or not to get the camera for which the screen coordinate of the object will be calculated. If no camera is given It will search through all camera that are in the scene until some camera sees the object or return the screen coordinate of the object calculated to the last camera in the scene.
enabled boolean No If true will match only objects that are active in hierarchy. If false will match all objects.
timeout double No The number of seconds that it will wait for object.
interval double No The number of seconds after which it will try to find the object again. The interval should be smaller than timeout.

Returns

  • AltObject

Examples

[Test]
 public void TestWaitForObjectToNotExistFail()
 {
     try
     {
         altDriver.WaitForObjectNotBePresent(By.NAME,"Capsule", timeout: 1, interval: 0.5f);
         Assert.Fail();
     }
     catch (WaitTimeOutException exception)
     {
         Assert.AreEqual("Element //Capsule still found after 1 seconds", exception.Message);
     }
 }

WaitForObjectWhichContains

Waits until it finds an object that respects the given criteria or time runs out and will throw an error. Check By for more information about criteria.

Parameters

Name Type Required Description
by By Yes Set what criteria to use in order to find the object.
value string Yes The value to which object will be compared to see if they respect the criteria or not.
cameraBy By No Set what criteria to use in order to find the camera.
cameraValue string No The value to which all the cameras in the scene will be compared to see if they respect the criteria or not to get the camera for which the screen coordinate of the object will be calculated. If no camera is given It will search through all camera that are in the scene until some camera sees the object or return the screen coordinate of the object calculated to the last camera in the scene.
enabled boolean No If true will match only objects that are active in hierarchy. If false will match all objects.
timeout double No The number of seconds that it will wait for object
interval double No The number of seconds after which it will try to find the object again. interval should be smaller than timeout

Returns

  • AltObject

Examples

[Test]
public void TestWaitForObjectWhichContains()
{
    var altObject = altDriver.WaitForObjectWhichContains(By.NAME, "Canva");
    Assert.AreEqual("Canvas", altObject.name);
}

WaitForObjectNotBePresent

Waits until the object in the scene that respects the given criteria is no longer in the scene or until timeout limit is reached. Check By for more information about criteria.

Parameters

Name Type Required Description
by By Yes Set what criteria to use in order to find the object.
value string Yes The value to which object will be compared to see if they respect the criteria or not.
cameraBy By No Set what criteria to use in order to find the camera.
cameraValue string No The value to which all the cameras in the scene will be compared to see if they respect the criteria or not to get the camera for which the screen coordinate of the object will be calculated. If no camera is given It will search through all camera that are in the scene until some camera sees the object or return the screen coordinate of the object calculated to the last camera in the scene.
enabled boolean No If true will match only objects that are active in hierarchy. If false will match all objects.
timeout double No The number of seconds that it will wait for object.
interval double No The number of seconds after which it will try to find the object again. interval should be smaller than timeout.

Returns

  • Nothing

Examples

[Test]
public void TestWaitForObjectToNotExist()
{
    altDriver.WaitForObjectNotBePresent(By.NAME, "Capsulee", timeout: 1, interval: 0.5f);
}

SetCommandResponseTimeout

Sets the value for the command response timeout.

Parameters

Name Type Required Description
commandTimeout int Yes The duration for a command response from the driver.

Returns

  • Nothing

Examples

altDriver.SetCommandResponseTimeout(commandTimeout);

GetDelayAfterCommand

Gets the current delay after a command.

Parameters

None

Returns

  • The current delay after a command.

Examples

altDriver.GetDelayAfterCommand();

SetDelayAfterCommand

Set the delay after a command.

Parameters

Name Type Required Description
delay int Yes The new delay a after a command.

Returns

  • Nothing

Examples

altDriver.SetDelayAfterCommand(5);

Input Actions

KeyDown

Simulates a key down.

Parameters

Name Type Required Description
keyCode AltKeyCode Yes The keyCode of the key simulated to be pressed.
power int Yes A value between [-1,1] used for joysticks to indicate how hard the button was pressed.

Returns

  • Nothing

Examples

[Test]
public void TestKeyDownAndKeyUp()
{
    altDriver.LoadScene("Scene 5 Keyboard Input");
    AltKeyCode kcode = AltKeyCode.A;

    altDriver.KeyDown(kcode, 1);
    var lastKeyDown = altDriver.FindObject(By.NAME, "LastKeyDownValue");
    var lastKeyPress = altDriver.FindObject(By.NAME, "LastKeyPressedValue");

    Assert.AreEqual((int)kcode, (int)Enum.Parse(typeof(AltKeyCode), lastKeyDown.GetText(), true));
    Assert.AreEqual((int)kcode, (int)Enum.Parse(typeof(AltKeyCode), lastKeyPress.GetText(), true));

    altDriver.KeyUp(kcode);
    var lastKeyUp = altDriver.FindObject(By.NAME, "LastKeyUpValue");

    Assert.AreEqual((int)kcode, (int)Enum.Parse(typeof(AltKeyCode), lastKeyUp.GetText(), true));
}

KeyUp

Simulates a key up.

Parameters

Name Type Required Description
keyCode AltKeyCode Yes The keyCode of the key simulated to be released.

Returns

  • Nothing

Examples

[Test]
public void TestKeyDownAndKeyUp()
{
    altDriver.LoadScene("Scene 5 Keyboard Input");
    AltKeyCode kcode = AltKeyCode.A;

    altDriver.KeyDown(kcode, 1);
    var lastKeyDown = altDriver.FindObject(By.NAME, "LastKeyDownValue");
    var lastKeyPress = altDriver.FindObject(By.NAME, "LastKeyPressedValue");

    Assert.AreEqual((int)kcode, (int)Enum.Parse(typeof(AltKeyCode), lastKeyDown.GetText(), true));
    Assert.AreEqual((int)kcode, (int)Enum.Parse(typeof(AltKeyCode), lastKeyPress.GetText(), true));

    altDriver.KeyUp(kcode);
    var lastKeyUp = altDriver.FindObject(By.NAME, "LastKeyUpValue");

    Assert.AreEqual((int)kcode, (int)Enum.Parse(typeof(AltKeyCode), lastKeyUp.GetText(), true));
}

HoldButton

Simulates holding left click button down for a specified amount of time at given coordinates.

Parameters

Name Type Required Default Description
coordinates Vector2 Yes The coordinates where the button is held down.
duration float No 0.1 The time measured in seconds to keep the button down.
wait boolean No true If set wait for command to finish.

Returns

  • Nothing

Examples

[Test]
public void TestHoldButton()
{
    var button = altDriver.FindObject(By.NAME, "UIButton");
    altDriver.HoldButton(button.GetScreenPosition(), 1);
    var capsuleInfo = altDriver.FindObject(By.NAME, "CapsuleInfo");
    var text = capsuleInfo.GetText();
    Assert.AreEqual(text, "UIButton clicked to jump capsule!");
}

MoveMouse

Simulate mouse movement in your game.

Parameters

Name Type Required Default Description
coordinates Vector2 Yes The screen coordinates.
duration float No 0.1 The time measured in seconds to move the mouse from the current mouse position to the set coordinates.
wait boolean No true If set wait for command to finish.

Returns

  • Nothing

Examples

[Test]
public void TestCreatingStars()
{
    altDriver.LoadScene("Scene 5 Keyboard Input");

    var stars = altDriver.FindObjectsWhichContain(By.NAME, "Star", cameraValue: "Player2");
    var pressingpoint1 = altDriver.FindObjectWhichContains(By.NAME, "PressingPoint1", cameraValue: "Player2");
    Assert.AreEqual(1, stars.Count);

    altDriver.MoveMouse(new AltVector2(pressingpoint1.x, pressingpoint1.y), 1);
    altDriver.PressKey(AltKeyCode.Mouse0, 0.1f);

    var pressingpoint2 = altDriver.FindObjectWhichContains(By.NAME, "PressingPoint2", cameraValue: "Player2");
    altDriver.MoveMouse(new AltVector2(pressingpoint2.x, pressingpoint2.y), 1);
    altDriver.PressKey(AltKeyCode.Mouse0, 0.1f);

    stars = altDriver.FindObjectsWhichContain(By.NAME, "Star");
    Assert.AreEqual(3, stars.Count);
}

PressKey

Simulates key press action in your game.

Parameters

Name Type Required Default Description
keycode AltKeyCode Yes The key code of the key simulated to be pressed.
power float No 1 A value between [-1,1] used for joysticks to indicate how hard the button was pressed.
duration float No 0.1 The time measured in seconds from the key press to the key release.
wait boolean No true If set wait for command to finish.

Returns

  • Nothing

Examples

[Test]
public void TestCreatingStars()
{
    altDriver.LoadScene("Scene 5 Keyboard Input");

    var stars = altDriver.FindObjectsWhichContain(By.NAME, "Star", cameraValue: "Player2");
    var pressingpoint1 = altDriver.FindObjectWhichContains(By.NAME, "PressingPoint1", cameraValue: "Player2");
    Assert.AreEqual(1, stars.Count);

    altDriver.MoveMouse(new AltVector2(pressingpoint1.x, pressingpoint1.y), 1);
    altDriver.PressKey(AltKeyCode.Mouse0, 0.1f);

    var pressingpoint2 = altDriver.FindObjectWhichContains(By.NAME, "PressingPoint2", cameraValue: "Player2");
    altDriver.MoveMouse(new AltVector2(pressingpoint2.x, pressingpoint2.y), 1);
    altDriver.PressKey(AltKeyCode.Mouse0, 0.1f);

    stars = altDriver.FindObjectsWhichContain(By.NAME, "Star");
    Assert.AreEqual(3, stars.Count);
}

PressKeys

Simulates multiple key press action in your game.

Parameters

Name Type Required Default Description
keycodes List[AltKeyCode] Yes The list of keycodes simulated to be pressed simultaneously.
power float No 1 A value between [-1,1] used for joysticks to indicate how hard the buttons were pressed.
duration float No 0.1 The time measured in seconds from the multiple key press to the multiple key release.
wait boolean No true If set, wait for command to finish.

Returns

  • Nothing

Examples

[Test]
public void TestPressKeys()
{
    AltKeyCode[] keys = { AltKeyCode.K, AltKeyCode.L };
    altDriver.PressKeys(keys);
    var altObject = altDriver.FindObject(By.NAME, "Capsule");
    var finalPropertyValue = altObject.GetComponentProperty<string>("AltExampleScriptCapsule", "stringToSetFromTests", "Assembly-CSharp");
    Assert.AreEqual("multiple keys pressed", finalPropertyValue);
}

Scroll

Simulate scroll action in your game.

Parameters

Name Type Required Default Description
speed float No 1 Set how fast to scroll. Positive values will scroll up and negative values will scroll down.
duration float No 0.1 The duration of the scroll in seconds.
wait boolean No true If set wait for command to finish.
speedHorizontal float No 1 Set how fast to scroll right or left.

Returns

  • Nothing

Examples

[Test]
public void TestScroll()
{
    altDriver.LoadScene("Scene 5 Keyboard Input");
    var player2 = altDriver.FindObject(By.NAME, "Player2");
    AltVector3 cubeInitialPosition = new AltVector3(player2.worldX, player2.worldY, player2.worldY);
    altDriver.Scroll(4, 2);

    player2 = altDriver.FindObject(By.NAME, "Player2");
    AltVector3 cubeFinalPosition = new AltVector3(player2.worldX, player2.worldY, player2.worldY);
    Assert.AreNotEqual(cubeInitialPosition, cubeFinalPosition);
}

Swipe

Simulates a swipe action between two points.

Parameters

Name Type Required Default Description
start Vector2 Yes Starting location of the swipe.
end Vector2 Yes Ending location of the swipe.
duration float No 0.1 The time measured in seconds to move the mouse from start to end location.
wait boolean No true If set wait for command to finish.

Returns

  • Nothing

Examples

[Test]
public void MultipleDragAndDrop()
{
    var altElement1 = altDriver.FindObject(By.NAME, "Drag Image1");
    var altElement2 = altDriver.FindObject(By.NAME, "Drop Box1");
    altDriver.Swipe(new AltVector2(altElement1.x, altElement1.y), new AltVector2(altElement2.x, altElement2.y), 1);

    altElement1 = altDriver.FindObject(By.NAME, "Drag Image2");
    altElement2 = altDriver.FindObject(By.NAME, "Drop Box2");
    altDriver.Swipe(new AltVector2(altElement1.x, altElement1.y), new AltVector2(altElement2.x, altElement2.y), 1);

    altElement1 = altDriver.FindObject(By.NAME, "Drag Image3");
    altElement2 = altDriver.FindObject(By.NAME, "Drop Box1");
    altDriver.Swipe(new AltVector2(altElement1.x, altElement1.y), new AltVector2(altElement2.x, altElement2.y), 1);

    altElement1 = altDriver.FindObject(By.NAME, "Drag Image1");
    altElement2 = altDriver.FindObject(By.NAME, "Drop Box1");
    altDriver.Swipe(new AltVector2(altElement1.x, altElement1.y), new AltVector2(altElement2.x, altElement2.y), 1);
    var imageSource = altDriver.FindObject(By.NAME, "Drag Image1").GetComponentProperty("UnityEngine.UI.Image", "sprite", "UnityEngine.UI");
    var imageSourceDropZone = altDriver.FindObject(By.NAME, "Drop Image").GetComponentProperty("UnityEngine.UI.Image", "sprite", "UnityEngine.UI");
    Assert.AreNotEqual(imageSource, imageSourceDropZone);

    imageSource = altDriver.FindObject(By.NAME, "Drag Image2").GetComponentProperty("UnityEngine.UI.Image", "sprite", "UnityEngine.UI");
    imageSourceDropZone = altDriver.FindObject(By.NAME, "Drop").GetComponentProperty("UnityEngine.UI.Image", "sprite", "UnityEngine.UI");
    Assert.AreNotEqual(imageSource, imageSourceDropZone);
}

MultipointSwipe

Simulates a multipoint swipe action.

Parameters

Name Type Required Default Description
positions List[AltVector2] Yes A list of positions on the screen where the swipe be made.
duration float No 0.1 The time measured in seconds to swipe from first position to the last position.
wait boolean No true If set wait for command to finish.

Returns

  • Nothing

Examples

[Test]
public void TestResizePanelWithMultipointSwipe()
{
    var altElement = altDriver.FindObject(By.NAME, "Resize Zone");
    var position = new AltVector2(altElement.x, altElement.y);
    var pos = new[]
    {
        altElement.GetScreenPosition(),
        new AltVector2(altElement.x - 200, altElement.y - 200),
        new AltVector2(altElement.x - 300, altElement.y - 100),
        new AltVector2(altElement.x - 50, altElement.y - 100),
        new AltVector2(altElement.x - 100, altElement.y - 100)
    };
    altDriver.MultipointSwipe(pos, 4);

    altElement = altDriver.FindObject(By.NAME, "Resize Zone");
    var position2 = new AltVector2(altElement.x, altElement.y);
    Assert.AreNotEqual(position, position2);
}

BeginTouch

Simulates starting of a touch on the screen. To further interact with the touch use MoveTouch and EndTouch

Parameters

Name Type Required Description
coordinates Vector2 Yes Screen coordinates.

Returns

  • int - the fingerId.

Examples

[Test]
public void TestNewTouchCommands()
{
    var draggableArea = altDriver.FindObject(By.NAME, "Drag Zone");
    var initialPosition = draggableArea.GetScreenPosition();
    int fingerId = altDriver.BeginTouch(draggableArea.GetScreenPosition());
    AltVector2 newPosition = new AltVector2(draggableArea.x + 20, draggableArea.y + 10);
    altDriver.MoveTouch(fingerId, newPosition);
    altDriver.EndTouch(fingerId);
    draggableArea = altDriver.FindObject(By.NAME, "Drag Zone");
    Assert.AreNotEqual(initialPosition, draggableArea.GetScreenPosition());

}

MoveTouch

Simulates a touch movement on the screen. Move the touch created with BeginTouch from the previous position to the position given as parameters.

Parameters

Name Type Required Description
fingerId int Yes Identifier returned by BeginTouch command.
coordinates Vector2 Yes Screen coordinates where the touch will be moved.

Returns

  • Nothing

Examples

[Test]
public void TestNewTouchCommands()
{
    var draggableArea = altDriver.FindObject(By.NAME, "Drag Zone");
    var initialPosition = draggableArea.GetScreenPosition();
    int fingerId = altDriver.BeginTouch(draggableArea.GetScreenPosition());
    AltVector2 newPosition = new AltVector2(draggableArea.x + 20, draggableArea.y + 10);
    altDriver.MoveTouch(fingerId, newPosition);
    altDriver.EndTouch(fingerId);
    draggableArea = altDriver.FindObject(By.NAME, "Drag Zone");
    Assert.AreNotEqual(initialPosition, draggableArea.GetScreenPosition());

}

EndTouch

Simulates ending of a touch on the screen. This command will destroy the touch making it no longer usable to other movements.

Parameters

Name Type Required Description
fingerId int Yes Identifier returned by BeginTouch command.

Returns

  • Nothing

Examples

[Test]
public void TestNewTouchCommands()
{
    var draggableArea = altDriver.FindObject(By.NAME, "Drag Zone");
    var initialPosition = draggableArea.GetScreenPosition();
    int fingerId = altDriver.BeginTouch(draggableArea.GetScreenPosition());
    AltVector2 newPosition = new AltVector2(draggableArea.x + 20, draggableArea.y + 10);
    altDriver.MoveTouch(fingerId, newPosition);
    altDriver.EndTouch(fingerId);
    draggableArea = altDriver.FindObject(By.NAME, "Drag Zone");
    Assert.AreNotEqual(initialPosition, draggableArea.GetScreenPosition());
}

Click

Click at screen coordinates.

Parameters

Name Type Required Default Description
coordinates Vector2 Yes The screen coordinates.
count int No 1 Number of clicks.
interval float No 0.1 Interval between clicks in seconds.
wait boolean No true If set wait for command to finish.

Returns

  • Nothing

Examples

[Test]
public void TestClickCoordinates()
{
    const string name = "UIButton";
    var altObject = altDriver.FindObject(By.NAME,name);
    altDriver.Click(altObject.GetScreenPosition());
    Assert.AreEqual(name, altObject.name);
    altDriver.WaitForObject(By.PATH, "//CapsuleInfo[@text="UIButton clicked to jump capsule!"]");
}

Tap

Tap at screen coordinates.

Parameters

Name Type Required Default Description
coordinates Vector2 Yes The screen coordinates.
count int No 1 Number of taps.
interval float No 0.1 Interval between taps in seconds.
wait boolean No true If set wait for command to finish.

Returns

  • Nothing

Examples

[Test]
public void TestTapCoordinates()
{
    const string name = "UIButton";
    var altObject = altDriver.FindObject(By.NAME,name);
    altDriver.Tap(altObject.GetScreenPosition());
    Assert.AreEqual(name, altObject.name);
    altDriver.WaitForObject(By.PATH, "//CapsuleInfo[@text="UIButton clicked to jump capsule!"]");
}

Tilt

Simulates device rotation action in your game.

Parameters

Name Type Required Default Description
acceleration Vector3 Yes The linear acceleration of a device.
duration float No 0.1 How long the rotation will take in seconds.
wait boolean No true If set wait for command to finish.

Returns

  • Nothing

Examples

[Test]
public void TestAcceleration()
{
    var capsule = altDriver.FindObject(By.NAME, "Capsule");
    var initialWorldCoordinates = capsule.GetWorldPosition();
    altDriver.Tilt(new AltVector3(1, 1, 1), 1);
    Thread.Sleep(100);
    capsule = altDriver.FindObject(By.NAME, "Capsule");
    var afterTiltCoordinates = capsule.GetWorldPosition();
    Assert.AreNotEqual(initialWorldCoordinates, afterTiltCoordinates);
}

Screenshot

GetPNGScreenshot

Creates a screenshot of the current screen in png format.

Parameters

Name Type Required Description
path string Yes location where the image is created.

Returns

  • Nothing

Examples

[Test]
public void TestGetScreenshot()
{
    var path="testC.png";
    altDriver.GetPNGScreenshot(path);
    FileAssert.Exists(path);
}

Unity Commands

PlayerPrefKeyType

This is an enum type used for the option parameter in the set_player_pref_key command listed below and has the following values:

Type Assigned Value
Int 1
String 2
Float 3

GettingPlayerPrefs

GetIntKeyPlayerPref

Returns the value for a given key from PlayerPrefs.

Parameters

Name

Type

Required

Description

keyname

string

Yes

Key to be retrieved

Returns

  • int

[Test]
public void TestDeleteKey()
{
    altDriver.DeletePlayerPref();
    altDriver.SetKeyPlayerPref("test", 1);
    var val = altDriver.GetIntKeyPlayerPref("test");
    Assert.AreEqual(1, val);
    altDriver.DeleteKeyPlayerPref("test");
    try
    {
        altDriver.GetIntKeyPlayerPref("test");
        Assert.Fail();
    }
    catch (NotFoundException exception)
    {
        Assert.AreEqual("notFound", exception.Message);
    }

}

GetFloatKeyPlayerPref

Returns the value for a given key from PlayerPrefs.

Parameters

Name

Type

Required

Description

keyname

string

Yes

Key to be retrieved

Returns

  • float

[Test]
public void TestDeleteKey()
{
    altDriver.DeletePlayerPref();
    altDriver.SetKeyPlayerPref("test", 1.0f);
    var val = altDriver.GetFloatKeyPlayerPref("test");
    Assert.AreEqual(1.0f, val);
    altDriver.DeleteKeyPlayerPref("test");
    try
    {
        altDriver.GetFloatKeyPlayerPref("test");
        Assert.Fail();
    }
    catch (NotFoundException exception)
    {
        Assert.AreEqual("notFound", exception.Message);
    }
}

GetStringKeyPlayerPref

Returns the value for a given key from PlayerPrefs.

Parameters

Name

Type

Required

Description

keyname

string

Yes

Key to be retrieved

Returns

  • string

[Test]
public void TestDeleteKey()
{
    altDriver.DeletePlayerPref();
    altDriver.SetKeyPlayerPref("test", "1");
    var val = altDriver.GetStringKeyPlayerPref("test");
    Assert.AreEqual("1", val);
    altDriver.DeleteKeyPlayerPref("test");
    try
    {
        altDriver.GetStringKeyPlayerPref("test");
        Assert.Fail();
    }
    catch (NotFoundException exception)
    {
        Assert.AreEqual("notFound", exception.Message);
    }

}
SettingPlayerPrefs

SetKeyPlayerPref

Sets the value for a given key in PlayerPrefs.

Parameters

Name

Type

Required

Description

keyname

string

Yes

Key to be set

value

integer/float/string

Yes

Value to be set

Returns

  • Nothing

Examples

[Test]
public void TestDeleteKey()
{
    altDriver.DeletePlayerPref();
    altDriver.SetKeyPlayerPref("test", "1");
    var val = altDriver.GetStringKeyPlayerPref("test");
    Assert.AreEqual("1", val);
    altDriver.DeleteKeyPlayerPref("test");
    try
    {
        altDriver.GetStringKeyPlayerPref("test");
        Assert.Fail();
    }
    catch (NotFoundException exception)
    {
        Assert.AreEqual("notFound", exception.Message);
    }

}

DeleteKeyPlayerPref

Removes key and its corresponding value from PlayerPrefs.

Parameters

Name Type Required Description
keyname sting Yes Key to be deleted.

Returns

  • Nothing

Examples

[Test]
public void TestDeleteKey()
{
    altDriver.DeletePlayerPref();
    altDriver.SetKeyPlayerPref("test", 1);
    var val = altDriver.GetIntKeyPlayerPref("test");
    Assert.AreEqual(1, val);
    altDriver.DeleteKeyPlayerPref("test");
    try
    {
        altDriver.GetIntKeyPlayerPref("test");
        Assert.Fail();
    }
    catch (NotFoundException exception)
    {
        Assert.AreEqual("notFound", exception.Message);
    }

}

DeletePlayerPref

Removes all keys and values from PlayerPref.

Parameters

None

Returns

  • Nothing

Examples

[Test]
public void TestSetKeyInt()
{
    altDriver.DeletePlayerPref();
    altDriver.SetKeyPlayerPref("test", 1);
    var val = altDriver.GetIntKeyPlayerPref("test");
    Assert.AreEqual(1, val);
}

GetCurrentScene

Returns the current active scene.

Parameters

None

Returns

  • String

Examples

[Test]
public void TestGetCurrentScene()
{
    altDriver.LoadScene("Scene 1 AltDriverTestScene");
    Assert.AreEqual("Scene 1 AltDriverTestScene", altDriver.GetCurrentScene());
}

LoadScene

Loads a scene.

Parameters

Name Type Required Description
scene string Yes The name of the scene to be loaded.
loadSingle bool No If set to false the scene will be loaded additive, together with the current loaded scenes. Default value is true.

Returns

  • Nothing

Examples

[Test]
public void TestGetCurrentScene()
{
    altDriver.LoadScene("Scene 1 AltDriverTestScene",true);
    Assert.AreEqual("Scene 1 AltDriverTestScene", altDriver.GetCurrentScene());
}

UnloadScene

Unloads a scene.

Parameters

Name Type Required Description
scene string Yes Name of the scene to be unloaded.

Returns

  • Nothing

Examples

[Test]
public void TestUnloadScene()
{
    altDriver.LoadScene("Scene 2 Draggable Panel", false);
    Assert.AreEqual(2, altDriver.GetAllLoadedScenes().Count);
    altDriver.UnloadScene("Scene 2 Draggable Panel");
    Assert.AreEqual(1, altDriver.GetAllLoadedScenes().Count);
    Assert.AreEqual("Scene 1 AltDriverTestScene", altDriver.GetAllLoadedScenes()[0]);
}

GetAllLoadedScenes

Returns all the scenes that have been loaded.

Parameters

None

Returns

  • List of strings

Examples

[Test]
public void TestGetAllLoadedScenes()
{
    altDriver.LoadScene("Scene 1 AltDriverTestScene");
    System.Collections.Generic.List<string> loadedSceneNames = altDriver.GetAllLoadedScenes();
    Assert.AreEqual(loadedSceneNames.Count, 1);
    altDriver.LoadScene("Scene 2 Draggable Panel", false);
    altDriver.LoadScene("Scene 3 Drag And Drop", false);
    altDriver.LoadScene("Scene 4 No Cameras", false);
    altDriver.LoadScene("Scene 5 Keyboard Input", false);
    loadedSceneNames = altDriver.GetAllLoadedScenes();
    Assert.AreEqual(loadedSceneNames.Count, 5);
}

WaitForCurrentSceneToBe

Waits for the scene to be loaded for a specified amount of time. It returns the name of the current scene.

Parameters

Name Type Required Description
sceneName string Yes The name of the scene to wait for.
timeout double No The time measured in seconds to wait for the specified scene.
interval double No How often to check that the scene was loaded in the given timeout.

Returns

  • None

Examples

[Test]
public void TestWaitForCurrentSceneToBe()
{
    const string name = "Scene 1 AltDriverTestScene";
    var timeStart = DateTime.Now;
    var currentScene = altDriver.WaitForCurrentSceneToBe(name);
    var timeEnd = DateTime.Now;
    var time = timeEnd - timeStart;
    Assert.Less(time.TotalSeconds, 20);
    Assert.NotNull(currentScene);
    Assert.AreEqual("Scene 1 AltDriverTestScene", currentScene);
}

GetTimeScale

Returns the value of the time scale.

Parameters

None

Returns

  • float

Examples

[Test]
public void TestTimeScale()
{
    altDriver.SetTimeScale(0.1f);
    Thread.Sleep(1000);
    var timeScaleFromGame = altDriver.GetTimeScale();
    Assert.AreEqual(0.1f, timeScaleFromGame);
}

SetTimeScale

Sets the value of the time scale.

Parameters

Name Type Required Description
timeScale float Yes The value you want to set the time scale to.

Returns

  • Nothing

Examples

[Test]
public void TestTimeScale()
{
    altDriver.SetTimeScale(0.1f);
    Thread.Sleep(1000);
    var timeScaleFromGame = altDriver.GetTimeScale();
    Assert.AreEqual(0.1f, timeScaleFromGame);
}

CallStaticMethod

Invokes static methods from your game.

Parameters

Name Type Required Description
typeName string Yes The name of the script. If the script has a namespace the format should look like this: "namespace.typeName".
methodName string Yes The name of the public method that we want to call. If the method is inside a static property/field to be able to call that method, methodName need to be the following format "propertyName.MethodName".
assemblyName string Yes The name of the assembly containing the script.
parameters array No An array containing the serialized parameters to be sent to the component method.
typeOfParameters array No An array containing the serialized type of parameters to be sent to the component method.

Returns

  • This is a generic method. The return type depends on the type parameter.

Examples

[Test]
public void TestCallStaticMethod()
{

    altDriver.CallStaticMethod<string>("UnityEngine.PlayerPrefs", "SetInt", "UnityEngine.CoreModule", new[] { "Test", "1" });
    int a = altDriver.CallStaticMethod<int>("UnityEngine.PlayerPrefs", "GetInt", "UnityEngine.CoreModule", new[] { "Test", "2" });
    Assert.AreEqual(1, a);

}

GetStaticProperty

Gets the value of the static field or property.

Parameters

Name Type Required Description
componentName string Yes The name of the component which has the static field or property to be retrieved.
propertyName string Yes The name of the static field or property to be retrieved.
assembly string Yes The name of the assembly the component belongs to.
maxDepth int No The maximum depth in the hierarchy to look for the static field or property. Its value is 2 by default.

Returns

  • This is a generic method. The return type depends on the type of the static field or property to be retrieved.

Examples

[Test]
public void TestGetStaticProperty()
{
    altDriver.CallStaticMethod<string>("UnityEngine.Screen", "SetResolution", "UnityEngine.CoreModule", new string[] {"1920", "1080", "true"}, new string[] {"System.Int32", "System.Int32", "System.Boolean"});
    var width = altDriver.GetStaticProperty<int>("UnityEngine.Screen", "currentResolution.width", "UnityEngine.CoreModule");
    Assert.AreEqual(1920, width);
}

SetStaticProperty

Sets the value of the static field or property.

Parameters

Name Type Required Description
componentName string Yes The name of the component which has the static field or property to be retrieved.
propertyName string Yes The name of the static field or property to be retrieved.
assembly string Yes The name of the assembly the component belongs to.
updatedProperty object Yes The new value of the component which has the static field or property to be seted.

Returns

  • Nothing

Examples

[Test]
public void TestSetStaticProperty()
{
    var expectedValue = 5;
    altDriver.SetStaticProperty("AltExampleScriptCapsule", "privateStaticVariable", "Assembly-CSharp", expectedValue);
    var value = altDriver.GetStaticProperty<int>("AltExampleScriptCapsule", "privateStaticVariable", "Assembly-CSharp");
    Assert.AreEqual(expectedValue, value);
}

Other

SetServerLogging

Sets the level of logging on AltTester Unity SDK.

Parameters

Name Type Required Description
logger AltLogger Yes The type of logger.
logLevel AltLogLevel Yes The logging level.

Returns

  • Nothing

Examples

altDriver.SetServerLogging(AltLogger.File, AltLogLevel.Off);
altDriver.SetServerLogging(AltLogger.Unity, AltLogLevel.Info);

AltObject

The AltObject class represents the objects present in the game and it allows you through the methods listed below to interact with them. It is the return type of the methods in the FindObjects category.

Fields

Name Type Description
name string The name of the object.
id int The objects's id.
x int The value for x axis coordinate on screen.
y int The value for y axis coordinate on screen.
mobileY int The value for y axis for appium.
type string Object's type, for objects from the game is gameObject.
enabled bool The local active state of the object. Note that an object may be inactive because a parent is not active, even if this returns true.
worldX float The value for x axis coordinate in the game's world.
worldY float The value for y axis coordinate in the game's world.
worldZ float The value for z axis coordinate in the game's world.
idCamera int The camera's id.
transformId int The transform's component id.
parentId int The transform parent's id. It's obsolete. Use transformParentId instead.
transformParentId int The transform parent's id.

The available methods are the following:

CallComponentMethod

Invokes a method from an existing component of the object.

Parameters

Name Type Required Description
componentName string Yes The name of the component. If the component has a namespace the format should look like this: "namespace.componentName".
methodName string Yes The name of the public method that will be called. If the method is inside a property/field to be able to call that method, methodName need to be the following format "propertyName.MethodName".
assemblyName string Yes The name of the assembly containing the component.
parameters array No An array containing the serialized parameters to be sent to the component method.
typeOfParameters array No An array containing the serialized type of parameters to be sent to the component method.

Returns

  • This is a generic method. The return type depends on the type parameter.

Examples

[Test]
public void TestCallMethodWithAssembly()
{
    AltObject capsule = altDriver.FindObject(By.NAME, "Capsule");
    var initialRotation = capsule.GetComponentProperty("UnityEngine.Transform", "rotation");
    capsule.CallComponentMethod<string>("UnityEngine.Transform", "Rotate", "UnityEngine.CoreModule", new[] { "10", "10", "10" }, new[] { "System.Single", "System.Single", "System.Single" });
    AltObject capsuleAfterRotation = altDriver.FindObject(By.NAME, "Capsule");
    var finalRotation = capsuleAfterRotation.GetComponentProperty("UnityEngine.Transform", "rotation");
    Assert.AreNotEqual(initialRotation, finalRotation);
}

[Test]
public void TestCallMethodWithNoParameters()
{
    const string componentName = "UnityEngine.UI.Text";
    const string methodName = "get_text";
    const string assemblyName = "UnityEngine.UI";
    const string elementText = "Change Camera Mode";
    var altElement = altUnityDriver.FindObject(By.PATH, "/Canvas/Button/Text");
    var data = altElement.CallComponentMethod<string>(componentName, methodName, assemblyName, new object[] { });
    Assert.AreEqual(elementText, data);
}

[Test]
public void TestCallMethodWithParameters()
{
    const string componentName = "UnityEngine.UI.Text";
    const string methodName = "set_fontSize";
    const string methodToVerifyName = "get_fontSize";
    const string assemblyName = "UnityEngine.UI";
    Int32 fontSizeExpected = 16;
    string[] parameters = new[] {"16"};
    var altElement = altUnityDriver.FindObject(By.PATH, "/Canvas/UnityUIInputField/Text");
    var data = altElement.CallComponentMethod<string>(componentName, methodName, assemblyName, parameters);
    var fontSize =  altElement.CallComponentMethod<Int32>(componentName, methodToVerifyName, assemblyName, new object[] { });
    Assert.AreEqual(fontSizeExpected, fontSize);
}

GetComponentProperty

Returns the value of the given component property.

Parameters

Name Type Required Description
componentName string Yes The name of the component. If the component has a namespace the format should look like this: "namespace.componentName"
propertyName string Yes Name of the property of which value you want. If the property is an array you can specify which element of the array to return by doing property[index], or if you want a property inside of another property you can get by doing property.property2 for example position.x.
assemblyName string Yes The name of the assembly containing the component.
maxDepth int No Set how deep the serialization of the property to do. For example for position property in transform the result are following: maxDepth=2 {"normalized":{"magnitude":1.0, "sqrMagnitude":1.0, "x":0.871575534, "y":0.490261227, "z":0.0}, "magnitude":1101.45361, "sqrMagnitude":1213200.0, "x":960.0,"y":540.0, "z":0.0} and for maxDepth=1 :{"normalized":{},"magnitude":1101.45361, "sqrMagnitude":1213200.0, "x":960.0,"y":540.0, "z":0.0}

Returns

  • Object

Examples

[Test]
public void TestGetComponentProperty()
{
    const string componentName = "Altom.AltTester.AltRunner";
    const string propertyName = "InstrumentationSettings.AltTesterPort";
    var altObject = altDriver.FindObject(By.NAME,"AltRunnerPrefab");
    Assert.NotNull(altObject);
    var propertyValue = altObject.GetComponentProperty<int>(componentName, propertyName, "Assembly-CSharp");
    Assert.AreEqual(propertyValue, 13000);
}

SetComponentProperty

Sets value of the given component property.

Parameters

Name Type Required Description
componentName string Yes The name of the component. If the component has a namespace the format should look like this: "namespace.componentName".
propertyName string Yes The name of the property of which value you want to set
assemblyName string Yes The name of the assembly containing the component. It is NULL by default.
value object Yes The value to be set for the chosen component's property

Returns

  • Nothing

Examples

[Test]
public void TestSetComponentProperty()
{
    const string componentName = "Capsule";
    const string propertyName = "stringToSetFromTests";
    var altObject = altDriver.FindObject(By.NAME, "Capsule");
    Assert.NotNull(altObject);
    altObject.SetComponentProperty(componentName, propertyName, "Assembly-CSharp", "2");

    var propertyValue = altObject.GetComponentProperty<string>(componentName, propertyName);
    Assert.AreEqual("2", propertyValue);
}

GetText

Returns text value from a Button, Text, InputField. This also works with TextMeshPro elements.

Parameters

None

Returns

  • String

Examples

[Test]
public void TestWaitForObjectWithText()
{
    const string name = "CapsuleInfo";
    string text = altDriver.FindObject(By.NAME,name).GetText();
    var timeStart = DateTime.Now;
    var altObject = altDriver.WaitForObject(By.PATH, "//" + name + "[@text=" + text + "]");
    var timeEnd = DateTime.Now;
    var time = timeEnd - timeStart;
    Assert.Less(time.TotalSeconds, 20);
    Assert.NotNull(altObject);
    Assert.AreEqual(altObject.GetText(), text);

}

SetText

Sets text value for a Button, Text, InputField. This also works with TextMeshPro elements.

Parameters

Name Type Required Description
text string Yes The text to be set.
submit bool No If set will trigger a submit event.

Returns

  • AltObject

Examples

[Test]
public void TestSetTextForElement()
{
    const string name = "InputField";
    const string text = "InputFieldTest";
    var input = altDriver.FindObject(By.NAME, name).SetText(text, true);
    Assert.NotNull(input);
    Assert.AreEqual(input.GetText(), text);
}

Tap

Tap current object.

Parameters

Name Type Required Default Description
count int No 1 Number of taps.
interval float No 0.1 Interval between taps in seconds.
wait boolean No true Wait for command to finish.

Returns

  • Nothing

Examples

[Test]
public void TestTap()
{
    var counterButton = altDriver.FindObject(By.NAME, "ButtonCounter");
    var counterButtonText = altDriver.FindObject(By.NAME, "ButtonCounter/Text");
    counterButton.Tap();
    altDriver.WaitForObject(By.PATH, "//ButtonCounter/Text[@text=1]");
}

Click

Click current object.

Parameters

Name Type Required Default Description
count int No 1 Number of clicks.
interval float No 0.1 Interval between clicks in seconds.
wait boolean No true Wait for command to finish.

Returns

  • Nothing

Examples

[Test]
public void TestClickElement()
{
    var counterButton = altDriver.FindObject(By.NAME, "ButtonCounter");
    var counterButtonText = altDriver.FindObject(By.NAME, "ButtonCounter/Text");
    counterButton.Click();
    altDriver.WaitForObject(By.PATH, "//ButtonCounter/Text[@text=1]");
}

PointerDown

Simulates pointer down action on the object.

Parameters

None

Returns

  • AltObject

Examples

[Test]
public void TestPointerDownCommand()
{
    var panel = altDriver.FindObject(By.NAME, "Panel");
    var color1 = panel.GetComponentProperty("PanelScript", "normalColor", "Assembly-CSharp");
    panel.PointerDownFromObject();
    Thread.Sleep(1000);
    var color2 = panel.GetComponentProperty("PanelScript", "highlightColor", "Assembly-CSharp");
    Assert.AreNotEqual(color1, color2);
}

PointerUp

Simulates pointer up action on the object.

Parameters

None

Returns

  • AltObject

Examples

[Test]
public void TestPointerUpCommand()
{
    var panel = altDriver.FindObject(By.NAME, "Panel");
    var color1 = panel.GetComponentProperty("PanelScript", "normalColor", "Assembly-CSharp");
    panel.PointerDownFromObject();
    Thread.Sleep(1000);
    panel.PointerUpFromObject();
    var color2 = panel.GetComponentProperty("PanelScript", "highlightColor", "Assembly-CSharp");
    Assert.AreEqual(color1, color2);
}

PointerEnter

Simulates pointer enter action on the object.

Parameters

None

Returns

  • AltObject

Examples

[Test]
public void TestPointerEnterAndExit()
{
    var altObject = altDriver.FindObject(By.NAME,"Drop Image");
    var color1 = altObject.GetComponentProperty("DropMe", "highlightColor", "Assembly-CSharp");
    altDriver.FindObject(By.NAME,"Drop Image").PointerEnterObject();
    var color2 = altObject.GetComponentProperty("DropMe", "highlightColor", "Assembly-CSharp");
    Assert.AreNotEqual(color1,color2);
    altDriver.FindObject(By.NAME,"Drop Image").PointerExitObject();
    var color3 = altObject.GetComponentProperty("DropMe", "highlightColor", "Assembly-CSharp");
    Assert.AreNotEqual(color3, color2);
    Assert.AreEqual(color1,color3);
}

PointerExit

Simulates pointer exit action on the object.

Parameters

None

Returns

  • AltObject

Examples

[Test]
public void TestPointerEnterAndExit()
{
    var altObject = altDriver.FindObject(By.NAME,"Drop Image");
    var color1 = altObject.GetComponentProperty("DropMe", "highlightColor", "Assembly-CSharp"));
    altDriver.FindObject(By.NAME,"Drop Image").PointerEnterObject();
    var color2 = altObject.GetComponentProperty("DropMe", "highlightColor", "Assembly-CSharp"));
    Assert.AreNotEqual(color1,color2);
    altDriver.FindObject(By.NAME,"Drop Image").PointerExitObject();
    var color3 = altObject.GetComponentProperty("DropMe", "highlightColor", "Assembly-CSharp"));
    Assert.AreNotEqual(color3, color2);
    Assert.AreEqual(color1,color3);
}

GetParent

Returns the parent of the object on which it is called.

Parameters

None

Returns

  • AltObject

Examples

[Test]
public void TestGetParent()
{
    var altObject = altDriver.FindObject(By.NAME, "Panel", By.NAME, "Main Camera");
    var altObjectParent = altObject.GetParent();
    Assert.AreEqual("Panel Drag Area", altObjectParent.name);
}

BY-Selector

It is used in find objects methods to set the criteria of which the objects are searched. Currently there are 7 types implemented:

  • By.TAG - search for objects that have a specific tag

  • By.LAYER - search for objects that are set on a specific layer

  • By.NAME - search for objects that are named in a certain way

  • By.COMPONENT - search for objects that have certain component

  • By.ID - search for objects that have assigned a certain id (every object has an unique id so this criteria always will return 1 or 0 objects). Id checks for InstanceId and AltId

  • By.TEXT - search for objects that have a certain text

  • By.PATH - search for objects that respect a certain path

Searching object by PATH

The following selecting nodes and attributes are implemented:

  • object - Selects all object with the name “object”

  • / - Selects from the root node

  • // - Selects nodes in the document from the current node that match the selection no matter where they are

  • .. - Selects the parent of the current node

  • * - Matches any element node

  • contains - Selects objects that contain a certain string in the name

  • [n-th] - Selects n-th child of the current node. 0 - represents the first child, 1 - is the second child and so on. -1 -represents the last child

  • @tag

  • @layer

  • @name

  • @component

  • @id

  • @text

Examples

//NameOfParent/NameOfChild/*

//NameOfParent/NameOfChild//*

altDriver.FindObjects(By.PATH, "//Canvas/Panel/*")
  • Returns all direct children from Panel

altDriver.FindObjects(By.PATH, "//Canvas/Panel//*")
  • Returns all children from Panel

Escaping characters

There are several characters that you need to escape when you try to find an object. Some examples characters are the symbols for Request separator and Request ending, by default this are ; and & but can be changed in Server settings. If you don’t escape this characters the whole request is invalid and might shut down the server. Other characters are !, [, ], (, ), /, \, . or ,. This characters are used in searching algorithm and if not escaped might return the wrong object or not found at all. To escape all the characters mentioned before just add \\ before each character you want to escape.

Examples

  • //Q&A - not escaped

  • //Q\\&A - escaped

AltId

Is a solution offered by AltTester Unity SDK in order to find object easier. This is an unique identifier stored in an component and added to every object. A limitation of this is that only the object already in the scene before building the game will have an AltId. Object instantiated during run time will not have an AltId

To add AltId to every object simply just click Add AltId to every object from AltTester menu.

Add AltId

AltPortForwarding

API to interact with adb and iproxy programmatically.

ForwardAndroid

This method calls adb forward [-s {deviceId}] tcp:{localPort} tcp:{remotePort}.

Parameters

Name Type Required Description
localPort int No The local port to forward from.
remotePort int No The device port to forward to.
deviceId string No The id of the device.
adbPath string No The adb path. If no adb path is provided, it tries to use adb from ${ANDROID_SDK_ROOT}/platform-tools/adb. If ANDROID_SDK_ROOT env variable is not set, it tries to execute adb from PATH.

Examples

[OneTimeSetUp]
public void SetUp()
{
    AltPortForwarding.ForwardAndroid();
    altDriver = new AltDriver();
}

RemoveForwardAndroid

This method calls adb forward --remove [-s {deviceId}] tcp:{localPort} or adb forward --remove-all if no local port is provided.

Parameters

Name Type Required Description
localPort int No The local port to be removed.
deviceId string No The id of the device to be removed.
adbPath string No The adb path. If no adb path is provided, it tries to use adb from ${ANDROID_SDK_ROOT}/platform-tools/adb. If ANDROID_SDK_ROOT env variable is not set, it tries to execute adb from PATH.

Returns

Nothing

Examples

[OneTimeTearDown]
public void TearDown()
{
    altDriver.Stop();
    AltPortForwarding.RemoveForwardAndroid();
}

RemoveAllForwardAndroid

This method calls adb forward --remove-all.

Parameters

Name Type Required Description
adbPath string No The adb path. If no adb path is provided, it tries to use adb from ${ANDROID_SDK_ROOT}/platform-tools/adb. If ANDROID_SDK_ROOT env variable is not set, it tries to execute adb from PATH.

Returns

Nothing

Examples

[OneTimeTearDown]
public void TearDown()
{
    altDriver.Stop();
    AltPortForwarding.RemoveAllForwardAndroid();
}

ForwardIos

This method calls iproxy {localPort} {remotePort} -u {deviceId}. Requires iproxy 2.0.2.

Parameters

Name Type Required Description
localPort int No The local port to forward from.
remotePort int No The device port to forward to.
deviceId string No The id of the device.
iproxyPath string No The path to iProxy. If iproxyPath is not provided, iproxy should be available in PATH.

Returns

Nothing

Examples

[OneTimeSetUp]
public void SetUp()
{
    AltPortForwarding.ForwardIos();
    altDriver = new AltDriver();
}

KillAllIproxyProcess

This method kills all iproxy processes. Calls killall iproxy.

Parameters

None

Returns

  • Nothing

Examples

[OneTimeTearDown]
public void TearDown()
{
    altDriver.Stop();
    AltPortForwarding.KillAllIproxyProcess();
}