RunScript

Executes a script on the server.

tip

Note that the data object will contain anything returned from the script.

success

Pro-tip: If a script path is not specified in scriptName field, it will default to cloud code scripts root folder.

Service	Operation
script	RUN

Method Parameters

Parameter	Description
scriptName	The name of the script with its absolute path to be run.
scriptData	Data to be sent to the script in JSON format.

Usage

http://localhost:3000

C#

string scriptName = "path/to/script1";
string scriptData = "{\"arg1\":42,\"arg2\":true,\"arg3\":\"example\"}";
SuccessCallback successCallback = (response, cbObject) =>
{
    Debug.Log(string.Format("Success | {0}", response));
};
FailureCallback failureCallback = (status, code, error, cbObject) =>
{
    Debug.Log(string.Format("Failed | {0}  {1}  {2}", status, code, error));
};

_bc.ScriptService.RunScript(scriptName, scriptData, successCallback, failureCallback);

C++

const char *scriptName = "path/to/script1";
const char *scriptData = "{\"arg1\":42,\"arg2\":true,\"arg3\":\"example\"}";
_bc->getScriptService()->runScript(scriptName, scriptData, this);

Obj-C

NSString *scriptName = @"path/to/script1";
NSString *scriptData = @"{\"arg1\":42,\"arg2\":true,\"arg3\":\"example\"}";
BCCompletionBlock successBlock;      // define callback
BCErrorCompletionBlock failureBlock; // define callback

[[_bc scriptService] runScript:scriptName
             scriptData:scriptData
            completionBlock:successBlock
       errorCompletionBlock:failureBlock
                   cbObject:nil];

Java

String scriptName = "path/to/script1";
String scriptData = "{\"arg1\":42,\"arg2\":true,\"arg3\":\"example\"}";
this; // implements IServerCallback

_bc.getScriptService().runScript(scriptName, scriptData, this);

public void serverCallback(ServiceName serviceName, ServiceOperation serviceOperation, JSONObject jsonData)
{
    System.out.print(String.format("Success | %s", jsonData.toString()));
}
public void serverError(ServiceName serviceName, ServiceOperation serviceOperation, int statusCode, int reasonCode, String jsonError)
{
    System.out.print(String.format("Failed | %d %d %s", statusCode,  reasonCode, jsonError.toString()));
}

JavaScript

var scriptName = "path/to/script1";
var scriptData = {
    "arg1": 42,
    "arg2": true,
    "arg3": "example"
};

_bc.script.runScript(scriptName, scriptData, result =>
{
    var status = result.status;
    console.log(status + " : " + JSON.stringify(result, null, 2));
});

Dart

var  scriptName = "path/to/script1";
var  scriptData = {
    "arg1": 42,
    "arg2": true,
    "arg3": "example"
};

ServerResponse result = await _bc.scriptService.runScript(scriptName:scriptName, scriptData:scriptData);

if (result.statusCode == 200) {
    print("Success");
} else {
    print("Failed ${result.error['status_message'] ?? result.error}");
}

Roblox

local scriptName = "path/to/script1"
local scriptData = {
    arg1 = 42,
    arg2 = true,
    arg3 = "example"
}

local callback = function(success, response)
    if success then
        print("Success")
    else
        print("Failed | " .. tostring(response.status_message))
    end
end

_bc.script:runScript(scriptName, scriptData, callback)

GDScript

var script_name = "path/to/script1"
var script_data = {
    "arg1": 42,
    "arg2": true,
    "arg3": "example"
}

var result = await _bc.script_service.run_script(script_name, script_data)

if result.status == 200:
	print("Success")
else:
	print("Failed: %s" % result.status_message)

Lua

local scriptName = "path/to/script1"
local scriptData = { arg1 = 42, arg2 = true, arg3 = "example" }

local callback = function(success, response)
    if success then
        print("Success")
    else
        print("Failed | " .. tostring(response.status_message))
    end
end

_bc.script:runScript(scriptName, scriptData, callback)

Cloud Code

var scriptName = "path/to/script1";
var scriptData = {
    "arg1": 42,
    "arg2": true,
    "arg3": "example"
};
var scriptProxy = bridge.getScriptServiceProxy();

var postResult = scriptProxy.runScript(scriptName, scriptData);
if (postResult.status == 200) {
    // Success!
}

Raw

{
    "service": "script",
    "operation": "RUN",
    "data": {
    "scriptName": "path/to/script1",
    "scriptData": {
        "parm": "value"
    }
 }
}

JSON Response

{
    "status": 200,
    "data": {
        "success": true
    }
}

Common Error Code

Status Codes

Code	Name	Description
40363	MISSING_SCRIPT	The script not found in specified folder.