docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class BuildContext

    Holds contextual information when building a build pipeline.

    Inheritance
    object
    ContextBase
    BuildContext
    Implements
    IDisposable
    Inherited Members
    ContextBase.Values
    ContextBase.UsedComponents
    ContextBase.BuildConfigurationName
    ContextBase.BuildConfigurationAssetPath
    ContextBase.BuildConfigurationAssetGUID
    ContextBase.Platform
    ContextBase.HasValue<T>()
    ContextBase.GetValue<T>()
    ContextBase.GetOrCreateValue<T>()
    ContextBase.GetValueOrDefault<T>()
    ContextBase.SetValue<T>(T)
    ContextBase.SetValue<T>()
    ContextBase.RemoveValue<T>()
    ContextBase.HasComponent(Type)
    ContextBase.HasComponent<T>()
    ContextBase.IsComponentInherited(Type)
    ContextBase.IsComponentInherited<T>()
    ContextBase.IsComponentOverriding(Type)
    ContextBase.IsComponentOverriding<T>()
    ContextBase.IsComponentUsed(Type)
    ContextBase.IsComponentUsed<T>()
    ContextBase.TryGetComponent(Type, out IBuildComponent)
    ContextBase.TryGetComponent<T>(out T)
    ContextBase.GetComponentOrDefault(Type)
    ContextBase.GetComponentOrDefault<T>()
    ContextBase.GetComponents()
    ContextBase.GetComponents(Type)
    ContextBase.GetComponents<T>()
    ContextBase.GetComponentTypes()
    ContextBase.SetComponent(Type, IBuildComponent)
    ContextBase.SetComponent<T>(T)
    ContextBase.SetComponent(Type)
    ContextBase.SetComponent<T>()
    ContextBase.RemoveComponent(Type)
    ContextBase.RemoveComponent<T>()
    ContextBase.GetOutputBuildDirectory()
    ContextBase.Dispose()
    ContextBase.IsComponentOverridden(Type)
    ContextBase.IsComponentOverridden<T>()
    ContextBase.GetLastBuildArtifact(Type)
    ContextBase.GetLastBuildArtifact<T>()
    ContextBase.GetLastBuildResult()
    object.ToString()
    object.Equals(object)
    object.Equals(object, object)
    object.ReferenceEquals(object, object)
    object.GetHashCode()
    object.GetType()
    Namespace: Unity.Build
    Assembly: solution.dll
    Syntax
    public sealed class BuildContext : ContextBase, IDisposable

    Properties

    Name Description
    BuildManifest

    Quick access to build manifest value.

    BuildProgress

    The build progress object used througout the build.

    Methods

    Name Description
    Failure(Exception)

    Get a build result representing a failure.

    Failure(string)

    Get a build result representing a failure.

    GetAllBuildArtifacts()

    Get all build artifact values.

    GetBuildArtifact(Type)

    Get the first build artifact value that is assignable to specified type. Multiple build artifact value can be stored per build configuration.

    GetBuildArtifact<T>()

    Get the first build artifact value that is assignable to specified type. Multiple build artifact value can be stored per build configuration.

    GetOrCreateBuildArtifact(Type)

    Get the first build artifact value that is assignable to specified type, or create and set it if not found. Multiple build artifact value can be stored per build configuration.

    GetOrCreateBuildArtifact<T>()

    Get the first build artifact value that is assignable to specified type, or create and set it if not found. Multiple build artifact value can be stored per build configuration.

    HasBuildArtifact(Type)

    Determine if a build artifact that is assignable to the specified type is present.

    HasBuildArtifact<T>()

    Determine if a build artifact that is assignable to the specified type is present.

    RemoveAllBuildArtifacts()

    Remove all build artifacts.

    RemoveBuildArtifact(Type)

    Remove all build artifact that is assignable to specified type.

    RemoveBuildArtifact<T>()

    Remove all build artifact that is assignable to specified type.

    SetBuildArtifact(IBuildArtifact)

    Set the value of a build artifact.

    Success()

    Get a build result representing a success.

    In This Article
    Back to top
    Copyright © 2024 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)