Class BuildCallbacks | Scriptable Build Pipeline | 1.5.10
docs.unity3d.com
    Show / Hide Table of Contents

    Class BuildCallbacks

    Inheritance
    Object
    BuildCallbacks
    Namespace: UnityEditor.Build.Pipeline
    Syntax
    public class BuildCallbacks : IDependencyCallback, IPackingCallback, IWritingCallback, IScriptsCallback, IContextObject

    Properties

    PostDependencyCallback

    Func delegate for the callback after dependency calculation has occurred.

    Declaration
    public Func<IBuildParameters, IDependencyData, ReturnCode> PostDependencyCallback { get; set; }
    Property Value
    Type Description
    Func<IBuildParameters, IDependencyData, ReturnCode>

    PostPackingCallback

    Func delegate for the callback after packing has occurred.

    Declaration
    public Func<IBuildParameters, IDependencyData, IWriteData, ReturnCode> PostPackingCallback { get; set; }
    Property Value
    Type Description
    Func<IBuildParameters, IDependencyData, IWriteData, ReturnCode>

    PostScriptsCallbacks

    Func delegate for the callback after scripts have been compiled.

    Declaration
    public Func<IBuildParameters, IBuildResults, ReturnCode> PostScriptsCallbacks { get; set; }
    Property Value
    Type Description
    Func<IBuildParameters, IBuildResults, ReturnCode>

    PostWritingCallback

    Func delegate for the callback after writing content has occurred.

    Declaration
    public Func<IBuildParameters, IDependencyData, IWriteData, IBuildResults, ReturnCode> PostWritingCallback { get; set; }
    Property Value
    Type Description
    Func<IBuildParameters, IDependencyData, IWriteData, IBuildResults, ReturnCode>

    Methods

    PostDependency(IBuildParameters, IDependencyData)

    Processes all the callbacks after dependency calculation step.

    Declaration
    public ReturnCode PostDependency(IBuildParameters buildParameters, IDependencyData dependencyData)
    Parameters
    Type Name Description
    IBuildParameters buildParameters
    IDependencyData dependencyData

    Results from the dependency calculation step.

    Returns
    Type Description
    ReturnCode

    Return code from processing the callbacks.

    Implements
    IDependencyCallback.PostDependency(IBuildParameters, IDependencyData)

    PostPacking(IBuildParameters, IDependencyData, IWriteData)

    Processes all the callbacks after packing step.

    Declaration
    public ReturnCode PostPacking(IBuildParameters buildParameters, IDependencyData dependencyData, IWriteData writeData)
    Parameters
    Type Name Description
    IBuildParameters buildParameters
    IDependencyData dependencyData

    Results from the dependency calculation step.

    IWriteData writeData

    Results from the packing step.

    Returns
    Type Description
    ReturnCode

    Return code from processing the callbacks.

    Implements
    IPackingCallback.PostPacking(IBuildParameters, IDependencyData, IWriteData)

    PostScripts(IBuildParameters, IBuildResults)

    Processes all the callbacks after script building step.

    Declaration
    public ReturnCode PostScripts(IBuildParameters parameters, IBuildResults results)
    Parameters
    Type Name Description
    IBuildParameters parameters

    Parameters passed into the build pipeline.

    IBuildResults results

    Results from the script building step.

    Returns
    Type Description
    ReturnCode

    Return code from processing the callbacks.

    Implements
    IScriptsCallback.PostScripts(IBuildParameters, IBuildResults)

    PostWriting(IBuildParameters, IDependencyData, IWriteData, IBuildResults)

    Processes all the callbacks after writing step.

    Declaration
    public ReturnCode PostWriting(IBuildParameters parameters, IDependencyData dependencyData, IWriteData writeData, IBuildResults results)
    Parameters
    Type Name Description
    IBuildParameters parameters

    Parameters passed into the build pipeline.

    IDependencyData dependencyData

    Results from the dependency calculation step.

    IWriteData writeData

    Results from the packing step.

    IBuildResults results

    Results from the writing step.

    Returns
    Type Description
    ReturnCode

    Return code from processing the callbacks.

    Implements
    IWritingCallback.PostWriting(IBuildParameters, IDependencyData, IWriteData, IBuildResults)
    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