docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class BuildPipelineBase

    Inheritance
    object
    BuildPipelineBase
    ClassicPipelineBase
    DotsRuntimeBuildPipelineBase
    Inherited Members
    object.ToString()
    object.Equals(object)
    object.Equals(object, object)
    object.ReferenceEquals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    Namespace: Unity.Build
    Assembly: solution.dll
    Syntax
    public abstract class BuildPipelineBase

    Constructors

    Name Description
    BuildPipelineBase()

    Default constructor.

    BuildPipelineBase(BuildStepCollection)

    Construct build pipeline from build step collection.

    Properties

    Name Description
    BuildSteps

    Optional list of build steps used by this build pipeline.

    UsedComponents

    List of build component types used by this build pipeline.

    Methods

    Name Description
    Build(BuildConfiguration, BuildProgress)

    Build this build pipeline using the specified build configuration.

    BuildIncremental(BuildConfiguration, BuildProgress)

    Start an incremental build of this build pipeline using the specified build configuration. The Update() method needs to be called until it returns false, indicating that the build has completed. The BuildResult can then be queried from the Result property.

    CanBuild(BuildConfiguration)

    Determine if the build pipeline satisfy requirements to build.

    CanRun(BuildConfiguration, params RunTargetBase[])

    Determine if the build pipeline satisfy requirements to run the last build.

    Clean(BuildConfiguration)

    Clean the build result from building the build pipeline of this build configuration.

    GetOutputBuildDirectory(BuildConfiguration)

    Directory containing final build files.

    OnBuild(BuildContext)

    Provides implementation to build this build pipeline using the specified build configuration. When using BuildIncremental(BuildConfiguration, BuildProgress), this method is called repeatedly until a build result is returned.

    OnCanBuild(BuildContext)

    Provides additional implementation to determine if the build pipeline satisfy requirements to build.

    OnCanRun(RunContext)

    Provides additional implementation to determine if the build pipeline satisfy requirements to run the last build.

    OnClean(CleanContext)

    Provides implementation to clean files produced by the build of this build pipeline corresponding to the specified build configuration.

    OnRun(RunContext)

    Provides implementation to run the last build of this build pipeline corresponding to the specified build configuration.

    Run(BuildConfiguration, params RunTargetBase[])

    Run the last build of this build pipeline corresponding to the specified build configuration.

    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)