docs.unity3d.com
    Show / Hide Table of Contents

    Interface IBuildLogger

    Interface for monitoring the build process. Several tasks will log details of their progress through this interface. See the Build Logging documentation for more details.

    Namespace: UnityEditor.Build.Pipeline.Interfaces
    Syntax
    public interface IBuildLogger : IContextObject

    Methods

    AddEntry(LogLevel, String)

    Adds details to the active build step

    Declaration
    void AddEntry(LogLevel level, string msg)
    Parameters
    Type Name Description
    LogLevel level

    The log level of this entry.

    String msg

    The message to add.

    BeginBuildStep(LogLevel, String, Boolean)

    Should be called when beginning a build step.

    Declaration
    void BeginBuildStep(LogLevel level, string stepName, bool subStepsCanBeThreaded)
    Parameters
    Type Name Description
    LogLevel level

    The log level of this step.

    String stepName

    A name associated with the step. It is recommended that this name does not include specific context about the step; dynamic context should be added under the step as an entry.

    Boolean subStepsCanBeThreaded

    True if within this build step the IBuildLogger will be used on multiple threads.

    EndBuildStep()

    Ends the build step.

    Declaration
    void EndBuildStep()

    Extension Methods

    BuildLoggerExternsions.AddEntrySafe(IBuildLogger, LogLevel, String)
    BuildLoggerExternsions.ScopedStep(IBuildLogger, LogLevel, String, Boolean)
    BuildLoggerExternsions.ScopedStep(IBuildLogger, LogLevel, String, String)
    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