addonscript-spec/docs/schema/api_builder_response.md

1,003 B

Environment Builder Response Object

{
    "addonscript": {},
    "files": [],
    "launch_client": {},
    "launch_server": {},
}

Required properties

addonscript

This is an AddonScript object containing information about the version of AddonScript used in this response. It MUST be equal to the addonscript Property of the request.

files

This is an array of File objects. These files will be concidered to be files of the addon, for which the launch environment was build, and MUST be treated equal to the files in the manifest.

Optional properties

launch_client

This is a Launch Config object for the client, which can be used, to modify the launch configuration of the instance.

launch_server

This is a Launch Config object for the server, which can be used, to modify the launch configuration of the instance.