GameDriver

string msScript = @"
    local a = 3
    local b = 7
    return a * b";

int output = api.ExecuteScript<int>(msScript);

Using a typed variation of ExecuteScript will allow the call to return a value equivalent to the return value of the Moonsharp script that is executed.

string msScript = "print('Scheduled script executed.')";

string scriptID = api.ScheduleScript(msScript, ScriptExecutionMode.EveryNthFrames, 10);

The string returned by the 'ScheduleScript' call represents a unique identifier of the script, which can be passed to the 'UnscheduleScript' call to stop any further executions of that script.

string msScript = @"
    -- LiteGameObject ResolveObject(string path)
    local childObject = ResolveObject('//Child')
    if childObject ~= nil then
        return childObject
end

    -- IEnumerable<LiteGameObject> ResolveObjects(string path)
    local objects = ResolveObjects('//*')
    for object in objects do
        print(object.name)
end";

The above script would search for an object in the scene with the tag "Child" and return it if one is found. Otherwise, it will print the name of all objects in the scene to the editor output. Note that both ResolveObject and ResolveObjects will return 'nil' if no objects are found matching the given query.

GameDriver's implementation of Moonsharp also allows for the use of numerous input-based functions, such as KeyPress, AxisPress, and ButtonPress, all of which are modeled after the like-named GameDriver API calls.

string msScript = @"
    -- KeyPress(Keycode key, ulong frames)
    -- Presses the space key for ten frames
    KeyPress(KeyCode.Space, 10)

    -- AxisPress(string name, float value, ulong frames)
    -- Presses the Horizontal axis fully forward for thirty frames
    AxisPress("Horizontal", 1.0, 30)

    -- ButtonPress(string name, ulong frames)
    -- Presses the input button registered under the name "Jump" for five frames
    ButtonPress("Jump", 5)";

void HandleNotify(object sender, ScriptSignalEventArgs args) {
  LiteGameObject object = (LiteGameObject) args.obj;
  Console.WriteLine($"A script has resolved the object: {object.name}");
}

api.ScriptSignal += HandleNotify;

// Find the Object by the component/property value
string popupListener = api.ScheduleScript(@"local obj = ResolveObject(""(//*[@name='Text (TMP)'])[1]/fn:component('TMPro.TextMeshProUGUI')/@text"");
                    if obj == 'Close' then
                        Notify(true)
                    end
", ScriptExecutionMode.EveryNthFrames, (int)api.GetLastFPS() * 5);

// Trigger callback when a popup is detected
api.ScriptSignal += (sender, args) => {
    Console.WriteLine("Found a popup!");
    isPopup = true;
};

We're then going to handle 10 such popups as they occur by checking whether isPopup is true, and then calling a helper function to handle the popup. This helper function contains the logic that could be part of the callback handler if this were to be used in a larger test scenario.

while (popupCount < 10)
{
    Console.WriteLine("Searching for popups...");
    api.Wait(1000);

    if (isPopup)
    {
        HandlePopup();
     }
}

public void HandlePopup()
{
    api.Wait(300);

    // Click close button by specific path
    //api.ClickObject(MouseButtons.LEFT, "//*[@name='Close Button']", 10);

    // Finds any object with a Button that is interactable and click it
    api.ClickObject(MouseButtons.LEFT, "//*[contains(.,fn:component('UnityEngine.UI.Button')/@interactable)]", 10);

    // Reset popup flag
    isPopup = false;
    popupCount++;
}

{
    "version": "0.1.0",
    "configurations": [
    {
        "name": "SmartAgent Attach",
        "type": "node",
        "debugServer": 41912,
        "request": "attach"
    }
    ],
}

With this configuration, you can connect to a running game’s debug server by clicking Start Debugging or by pressing F5.

Debugging Scripts
When running a script via ExecuteScript or ScheduleScript, the debugger should pause immediately upon invocation. The script will come into focus in VSCode and from there the user can step through the program.

Remote Debugging
Currently, remote debugging only works with port-forwarded local devices (eg. An Android device plugged into the local machine and forwarded via ADB). When running GameDriver on an Android device, it is required to forward the GDIOAgent communication port for the test client to connect:

$ adb forward tcp:19734 tcp:19734

When debugging a Lua script running on an Android device, you'll additionally need to forward the configured debug server port:

$ adb forward tcp:41912 tcp:41912