Class BuildContext | Platforms | 0.2.2-preview.10
docs.unity.cn
    Show / Hide Table of Contents

    Class BuildContext

    Holds contextual information when building a build pipeline.

    Inheritance
    Object
    ContextBase
    BuildContext
    Inherited Members
    ContextBase.Values
    ContextBase.BuildConfigurationName
    ContextBase.BuildConfigurationAssetPath
    ContextBase.BuildConfigurationAssetGUID
    ContextBase.HasValue<T>()
    ContextBase.GetValue<T>()
    ContextBase.GetOrCreateValue<T>()
    ContextBase.GetValueOrDefault<T>()
    ContextBase.SetValue<T>(T)
    ContextBase.SetValue<T>()
    ContextBase.RemoveValue<T>()
    ContextBase.Dispose()
    Namespace: Unity.Build
    Syntax
    public sealed class BuildContext : ContextBase, IDisposable

    Properties

    BuildManifest

    Quick access to build manifest value.

    Declaration
    public BuildManifest BuildManifest { get; }
    Property Value
    Type Description
    BuildManifest

    BuildPipelineStatus

    Current build pipeline execution status.

    Declaration
    public BuildPipelineResult BuildPipelineStatus { get; }
    Property Value
    Type Description
    BuildPipelineResult

    BuildProgress

    The build progress object used througout the build.

    Declaration
    public BuildProgress BuildProgress { get; }
    Property Value
    Type Description
    BuildProgress

    Methods

    Failure(Exception)

    Get a build result representing a failure.

    Declaration
    public BuildPipelineResult Failure(Exception exception)
    Parameters
    Type Name Description
    Exception exception

    The exception that was thrown.

    Returns
    Type Description
    BuildPipelineResult

    A new build result instance.

    Failure(String)

    Get a build result representing a failure.

    Declaration
    public BuildPipelineResult Failure(string reason)
    Parameters
    Type Name Description
    String reason

    The reason of the failure.

    Returns
    Type Description
    BuildPipelineResult

    A new build result instance.

    Success()

    Get a build result representing a success.

    Declaration
    public BuildPipelineResult Success()
    Returns
    Type Description
    BuildPipelineResult

    A new build result instance.

    Back to top Copyright © 2020 Unity Technologies
    Generated by DocFX