StaticbuildInformation about the most-recent build.
Static ReadonlyframeworkThe name of the framework package required to start the RSX runtime.
StaticlogThe log category of deployment information.-
Protected StaticonInvoked when a log was generated during a deployment operation.
StaticactiveChanges the active build platform. Might cause asset reimport.
StaticactiveGets stored build setting for the active platform.
Active build settings.
StaticavailableGetter for available platforms for user build.
List of available platforms the executable can be built for.
StaticsettingsThe current deploymment data.
StaticbeginStaticbeginStaticcalculateCalculates the size of the resource on disk including potential streaming and preview data sizes.
The resource UUID.
Structure with information about default scene.
The size or null if the size cannot be calculated for the resource.
Protected StaticcleanCleans the build folder.
StaticcookCooks one or more resources and it's dependencies and exports the packages to the outputFolder.
Returns true on success. If something fails, message is printed to log and false is returned.
StaticcreateCreates a runtime settings resource that contains necessary data for starting up the project (for example initial scene).
Root folder of the user build where the settings should go.
The user build configuration.
The cloud project used to imprint meta-data into the deployment.
OptionaldeploymentBaseURL: string
If project is streaming, the deployment base URL.
OptionaldeploymentUUID: UUID
If project is streaming, the deployment UUID.
StaticcreateCreates a new web deployment on the cloud server. This will upload the manifest to the server and create all resources necessary to run the deployed application on the web.
A JSON object that represents the deployment manifest. Call createWebDeploymentJSON to create a new manifest.
The user build configuration.
OptionalisPublicTemplate: booleanAn uncertain async op that will be resolved with the deployment UUID once everything is complete.
StaticcreateCreates a new web deployment JSON that can be sent to the server to create a new cloud deployment.
The resources to package. Call gatherResources to gather all required resources for the build.
The user build configuration.
A JsonObject that represents the deployment configuration to be sent to the server.
StaticdeployCompiles and deploys user code.
Protected StaticdeployDeploys the runtime data.
Protected StaticdeployDeploys the runtime executable
StaticfinalizeFinalizes the active deployment.
StaticgatherFinds all used resources by the build.
Structure with information about default scene.
Resources
StaticgenerateGenerate icon.icns file for a macOS bundle.
Root folder of the user build where the bundle is built.
Structure with information about the icon that should be injected.
StaticgenerateGenerate info.plist file for a macOS bundle.
Root folder of the user build where the bundle is built.
Structure with information about the icon that should be injected.
StaticgetFolder where to output user build files for given platform.
Platform for which to return the build root.
Path to build root folder.
StaticgetReturns a list of script defines for a specific platform.
Platform for which we build.
String with defines.
StaticgetGets the destination path for the path type.
StaticgetReturns given list of files that need to be copied, usually relative to some source and/or destination path.
Enum describing, which file list to retrieve.
Platform information to retrieve the data for.
StaticgetGets stored build setting for a specific platform.
Platform for which to return the build settings.
Build settings for the platform.
StaticgetPath to game executable binary that is used for user build.
Platform for which we build.
Path to game executable file.
StaticgetGets the source path for the path type.
StaticinjectInjects icons specified in platformInformation into an executable at the specified filePath.
Path to the executable.
Structure with information about the icon that should be injected.
StaticloadLoads a previously stored list of build settings.
Path to the input file.
StaticpackagePackages all resources into an output folder.
Root folder of the user build where the resources should go.
The resources to package. Call gatherResources to gather all required resources for the build.
Structure with information about default scene.
Returns true on success. If something fails, message is printed to log and false is returned.
StaticresetResets the currently active build settings.
StaticsaveStores build settings for all platforms in the specified file.
Path to the output file.
Staticset
The DeploymentManager provides API for convenient project deployments. It manages packaging of the project into executable form, including the necessary resources. This allows the Project to become a standalone application on both the web and on native platforms.