Class BuildLoggerExternsions

Contains extension methods for the IBuildLogger interface

Inheritance

object

BuildLoggerExternsions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: UnityEditor.Build.Pipeline.Interfaces

Assembly: Unity.ScriptableBuildPipeline.Editor.dll

Syntax

public static class BuildLoggerExternsions

Methods

AddEntrySafe(IBuildLogger, LogLevel, string)

Adds details to the active build step

Declaration

public static void AddEntrySafe(this IBuildLogger log, LogLevel level, string msg)

Parameters

Type	Name	Description
IBuildLogger	log	The build log.
LogLevel	level	The log level of this entry.
string	msg	The message to add.

ScopedStep(IBuildLogger, LogLevel, string, bool)

Begins a new build step and returns an ScopedBuildStep which will end the build step when disposed. It is recommended to use this in conjunction with the using statement.

Declaration

public static ScopedBuildStep ScopedStep(this IBuildLogger log, LogLevel level, string stepName, bool multiThreaded = false)

Parameters

Type	Name	Description
IBuildLogger	log	The build log.
LogLevel	level	The log level of this step.
string	stepName	A name associated with the step.
bool	multiThreaded	True if within this build step the IBuildLogger will be used on multiple threads.

Returns

Type	Description
ScopedBuildStep	Returns a ScopedBuildStep that will end the build step when it is disposed.

ScopedStep(IBuildLogger, LogLevel, string, string)

Begins a new build step and returns an ScopedBuildStep which will end the build step when disposed. It is recommended to use this in conjunction with the using statement.

Declaration

public static ScopedBuildStep ScopedStep(this IBuildLogger log, LogLevel level, string stepName, string context)

Parameters

Type	Name	Description
IBuildLogger	log	The build log.
LogLevel	level	The log level of this step.
string	stepName	A name associated with the step.
string	context	Adds an entry message the build step. This allows attaching specific context data without changing the stepName.

Returns

Type	Description
ScopedBuildStep	Returns a ScopedBuildStep that will end the build step when it is disposed.