BuildPipeline.BuildGameAsync
Section titled “BuildPipeline.BuildGameAsync”
- Builds and installs one complete source-free game deployment with rollback protection.
Required contracts
Section titled “Required contracts”API: engine
Project: Inno.Build
Declaration
Section titled “Declaration”public System.Threading.Tasks.ValueTask<Inno.Build.BuildResult> Inno.Build.BuildPipeline.BuildGameAsync(Inno.Build.GameBuildRequest request, System.IProgress<Inno.Build.BuildProgress>? progress = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken))Remarks
Section titled “Remarks”Prepare current packs with EnsurePlayerSupportPackAsync before invoking this method on the authoring owner’s thread. The synchronous snapshot phase never waits for asynchronous provisioning. Coordinate readers and writers of the output directory during its two installation moves. Post-commit backup, staging and progress observer failures are warnings on the successful result.
Parameters
Section titled “Parameters”Parameter request: The exact profile, destination, and activated runtime compilation generation.
Parameter progress: Optional observer for monotonic stage progress.
Parameter cancellationToken: The token that cancels work before directory installation begins.
Returns
Section titled “Returns”The durable output identity and deployment metrics.
Exceptions
Section titled “Exceptions”Exception T:System.OperationCanceledException: Thrown when cancellation is requested before commit.
Exception T:System.IO.DirectoryNotFoundException: The target Support Pack is missing; prepare it before starting the owner-thread build snapshot.
Exception T:System.IO.InvalidDataException: The target Support Pack is present but invalid.
Exception T:System.IO.IOException: Output installation fails before a complete candidate is committed.
Exception T:System.AggregateException: Output installation and restoration both fail; the previous tree remains at the reported backup path.