Class DeploymentManager

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.

Constructors

constructor

Properties

buildResult frameworkPackageName logCategoryDeployment onDeploymentLogAdded

Accessors

activePlatform activePlatformInformation availablePlatforms settings

Methods

beginDeploymentOperation beginStreamingDeploymentOperation calculateResourceSizeOnDisk cleanDeploymentFolder cookResource createRuntimeSettings createWebDeployment createWebDeploymentJSON deployProjectModule deployRuntimeData deployRuntimeExecutable finalizeDeployment gatherResources generateBundleIcon generateBundleInfoPList getBuildRoot getDefines getDestinationPath getFileList getPlatformInformation getRuntimeExecutableFile getSourcePath injectIcons loadSettings packageResources resetSettings saveSettings setExecutablePermissions

Constructors

constructor

Properties

StaticbuildResult

buildResult: BuildResult

Information about the most-recent build.

Static ReadonlyframeworkPackageName

frameworkPackageName = "rsxFramework.rpak"

The name of the framework package required to start the RSX runtime.

StaticlogCategoryDeployment

logCategoryDeployment: number

The log category of deployment information.-

Protected StaticonDeploymentLogAdded

onDeploymentLogAdded: ((logEntry: LogEntry) => void)

Invoked when a log was generated during a deployment operation.

Accessors

StaticactivePlatform

  • get activePlatform(): EnumValue<PlatformType, number>

  • Changes the active build platform. Might cause asset reimport.

    Returns EnumValue<PlatformType, number>

  • set activePlatform(value): void

  • Parameters

    Returns void

StaticactivePlatformInformation

  • get activePlatformInformation(): PlatformInformation

  • Gets stored build setting for the active platform.

    Returns PlatformInformation

    Active build settings.

StaticavailablePlatforms

Staticsettings

  • get settings(): DeploymentData

  • The current deploymment data.

    Returns DeploymentData

  • set settings(value): void

  • Parameters

    Returns void

Methods

StaticbeginDeploymentOperation

  • beginDeploymentOperation(buildFolder, targetPlatform, onProgressReport?, onFinalize?): Coroutine<string>

  • Builds the executable and packages the game.

    Parameters

    • buildFolder: FilePath
    • targetPlatform: PlatformInformation
    • OptionalonProgressReport: ((progress: number) => void)
        • (progress): void

        • Parameters

          • progress: number

          Returns void

    • OptionalonFinalize: (() => void)
        • (): void

        • Returns void

    Returns Coroutine<string>

StaticbeginStreamingDeploymentOperation

  • beginStreamingDeploymentOperation(buildFolder, targetPlatform, onProgressReport?, onFinalize?): Coroutine<string>

  • Builds the executable and packages the game.

    Parameters

    • buildFolder: FilePath
    • targetPlatform: PlatformInformation
    • OptionalonProgressReport: ((progress: number) => void)
        • (progress): void

        • Parameters

          • progress: number

          Returns void

    • OptionalonFinalize: (() => void)
        • (): void

        • Returns void

    Returns Coroutine<string>

StaticcalculateResourceSizeOnDisk

  • calculateResourceSizeOnDisk(uuid, platformInformation): number

  • Calculates the size of the resource on disk including potential streaming and preview data sizes.

    Parameters

    • uuid: UUID

      The resource UUID.

    • platformInformation: PlatformInformation

      Structure with information about default scene.

    Returns number

    The size or null if the size cannot be calculated for the resource.

Protected StaticcleanDeploymentFolder

  • cleanDeploymentFolder(targetPlatform, buildFolder): void

  • Cleans the build folder.

    Parameters

    • targetPlatform: PlatformInformation
    • buildFolder: FilePath

    Returns void

StaticcookResource

  • cookResource(resourceUUIDs, outputFolder, includeDependencies): boolean

  • Cooks one or more resources and it's dependencies and exports the packages to the outputFolder.

    Parameters

    • resourceUUIDs: UUID[]

      The resources to cook and export to outputFolder.

    • outputFolder: FilePath

      The place where all the packages will be created.

    • includeDependencies: boolean

      Determines if resource depenencies will be included.

    Returns boolean

    Returns true on success. If something fails, message is printed to log and false is returned.

StaticcreateRuntimeSettings

  • createRuntimeSettings(buildFolder, platformInformation, cloudProject, deploymentBaseURL?, deploymentUUID?): void

  • Creates a runtime settings resource that contains necessary data for starting up the project (for example initial scene).

    Parameters

    • buildFolder: FilePath

      Root folder of the user build where the settings should go.

    • platformInformation: PlatformInformation

      The user build configuration.

    • cloudProject: CloudProject

      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.

    Returns void

StaticcreateWebDeployment

  • createWebDeployment(manifestJSON, platformInformation): UncertainAsyncOp<CloudProjectDeployment, string>

  • Creates 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.

    Parameters

    • manifestJSON: JsonObject

      A JSON object that represents the deployment manifest. Call createWebDeploymentJSON to create a new manifest.

    • platformInformation: PlatformInformation

      The user build configuration.

    Returns UncertainAsyncOp<CloudProjectDeployment, string>

    An uncertain async op that will be resolved with the deployment UUID once everything is complete.

StaticcreateWebDeploymentJSON

  • createWebDeploymentJSON(resources, platformInformation, cloudProject): JsonObject

  • Creates a new web deployment JSON that can be sent to the server to create a new cloud deployment.

    Parameters

    • resources: UUID[]

      The resources to package. Call gatherResources to gather all required resources for the build.

    • platformInformation: PlatformInformation

      The user build configuration.

    • cloudProject: CloudProject

    Returns JsonObject

    A JsonObject that represents the deployment configuration to be sent to the server.

StaticdeployProjectModule

  • deployProjectModule(buildFolder, platformInformation): boolean

  • Compiles and deploys user code.

    Parameters

    • buildFolder: FilePath
    • platformInformation: PlatformInformation

    Returns boolean

Protected StaticdeployRuntimeData

  • deployRuntimeData(targetPlatform, buildFolder): void

  • Deploys the runtime data.

    Parameters

    • targetPlatform: PlatformInformation
    • buildFolder: FilePath

    Returns void

Protected StaticdeployRuntimeExecutable

  • deployRuntimeExecutable(targetPlatform, buildFolder): void

  • Deploys the runtime executable

    Parameters

    • targetPlatform: PlatformInformation
    • buildFolder: FilePath

    Returns void

StaticfinalizeDeployment

  • finalizeDeployment(buildFolder, platformInformation): void

  • Finalizes the active deployment.

    Parameters

    • buildFolder: FilePath
    • platformInformation: PlatformInformation

    Returns void

StaticgatherResources

  • gatherResources(platformInformation): UUID[]

  • Finds all used resources by the build.

    Parameters

    • platformInformation: PlatformInformation

      Structure with information about default scene.

    Returns UUID[]

    Resources

StaticgenerateBundleIcon

  • generateBundleIcon(buildFolder, platformInformation): void

  • Generate icon.icns file for a macOS bundle.

    Parameters

    • buildFolder: FilePath

      Root folder of the user build where the bundle is built.

    • platformInformation: PlatformInformation

      Structure with information about the icon that should be injected.

    Returns void

StaticgenerateBundleInfoPList

  • generateBundleInfoPList(buildFolder, platformInformation): void

  • Generate info.plist file for a macOS bundle.

    Parameters

    • buildFolder: FilePath

      Root folder of the user build where the bundle is built.

    • platformInformation: PlatformInformation

      Structure with information about the icon that should be injected.

    Returns void

StaticgetBuildRoot

  • getBuildRoot(type): FilePath

  • Folder where to output user build files for given platform.

    Parameters

    Returns FilePath

    Path to build root folder.

StaticgetDefines

  • getDefines(platform): string

  • Returns a list of script defines for a specific platform.

    Parameters

    Returns string

    String with defines.

StaticgetDestinationPath

StaticgetFileList

  • getFileList(fileList, platformInformation): FilePath[]

  • Returns given list of files that need to be copied, usually relative to some source and/or destination path.

    Parameters

    • fileList: EnumValue<DeploymentFileList, number>

      Enum describing, which file list to retrieve.

    • platformInformation: PlatformInformation

      Platform information to retrieve the data for.

    Returns FilePath[]

StaticgetPlatformInformation

  • getPlatformInformation(type): PlatformInformation

  • Gets stored build setting for a specific platform.

    Parameters

    Returns PlatformInformation

    Build settings for the platform.

StaticgetRuntimeExecutableFile

  • getRuntimeExecutableFile(platform): FilePath

  • Path to game executable binary that is used for user build.

    Parameters

    Returns FilePath

    Path to game executable file.

StaticgetSourcePath

StaticinjectIcons

  • injectIcons(filePath, platformInformation): void

  • Injects icons specified in platformInformation into an executable at the specified filePath.

    Parameters

    • filePath: FilePath

      Path to the executable.

    • platformInformation: PlatformInformation

      Structure with information about the icon that should be injected.

    Returns void

StaticloadSettings

  • loadSettings(inFile): void

  • Loads a previously stored list of build settings.

    Parameters

    • inFile: FilePath

      Path to the input file.

    Returns void

StaticpackageResources

  • packageResources(buildFolder, resources, platformInformation): boolean

  • Packages all resources into an output folder.

    Parameters

    • buildFolder: FilePath

      Root folder of the user build where the resources should go.

    • resources: UUID[]

      The resources to package. Call gatherResources to gather all required resources for the build.

    • platformInformation: PlatformInformation

      Structure with information about default scene.

    Returns boolean

    Returns true on success. If something fails, message is printed to log and false is returned.

StaticresetSettings

  • resetSettings(): void

  • Resets the currently active build settings.

    Returns void

StaticsaveSettings

  • saveSettings(outFile): void

  • Stores build settings for all platforms in the specified file.

    Parameters

    • outFile: FilePath

      Path to the output file.

    Returns void

StaticsetExecutablePermissions

  • setExecutablePermissions(executablePath, platformInformation): void

  • Sets the permissions for the executable.

    Parameters

    • executablePath: FilePath
    • platformInformation: PlatformInformation

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods