Class BuildContext | Entities | 0.2.0-preview.18
docs.unity3d.com
    Show / Hide Table of Contents

    Class BuildContext

    Holds contextual information while a BuildPipeline is executing.

    Inheritance
    Object
    BuildContext
    Namespace: Unity.Build
    Syntax
    public sealed class BuildContext : IDisposable

    Properties

    BuildManifest

    Quick access to BuildManifest value.

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

    BuildPipelineStatus

    Current BuildPipeline execution status.

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

    BuildProgress

    The BuildProgress object used througout the build.

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

    Values

    List of all values stored.

    Declaration
    public object[] Values { get; }
    Property Value
    Type Description
    Object[]

    Methods

    Dispose()

    Declaration
    public void Dispose()

    GetOrCreateValue<T>()

    Get value of type T if found, otherwise a new instance of type T constructed with .

    Declaration
    public T GetOrCreateValue<T>()
        where T : class
    Returns
    Type Description
    T

    The value or new instance of type T.

    Type Parameters
    Name Description
    T

    The value type.

    GetValue<T>()

    Get value of type T if found, otherwise null.

    Declaration
    public T GetValue<T>()
        where T : class
    Returns
    Type Description
    T

    The value of type T if found, otherwise null.

    Type Parameters
    Name Description
    T

    The value type.

    HasValue<T>()

    Determine if the value of type T exists.

    Declaration
    public bool HasValue<T>()
        where T : class
    Returns
    Type Description
    Boolean

    true if value is found, false otherwise.

    Type Parameters
    Name Description
    T

    The value type.

    RemoveValue<T>()

    Remove value of type T from this BuildContext.

    Declaration
    public bool RemoveValue<T>()
        where T : class
    Returns
    Type Description
    Boolean

    true if the value was removed, otherwise false.

    Type Parameters
    Name Description
    T

    The value type.

    SetValue<T>(T)

    Set value of type T to this BuildContext.

    Declaration
    public void SetValue<T>(T value)
        where T : class
    Parameters
    Type Name Description
    T value

    The value to set.

    Type Parameters
    Name Description
    T

    The value type.

    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023