Class ProjectAuditor

The ProjectAuditor class is responsible for auditing the Unity project.

Inheritance

object

ProjectAuditor

Implements

IPostprocessBuildWithReport

IOrderedCallback

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Unity.ProjectAuditor.Editor

Assembly: Unity.ProjectAuditor.Editor.dll

Syntax

public sealed class ProjectAuditor : IPostprocessBuildWithReport, IOrderedCallback

Constructors

ProjectAuditor()

ProjectAuditor default constructor

Declaration

public ProjectAuditor()

Properties

callbackOrder

Returns the relative callback order for callbacks. Callbacks with lower values are called before ones with higher values.

Declaration

public int callbackOrder { get; }

Property Value

Type	Description
int

Methods

Audit(AnalysisParams, IProgress)

Performs static analysis of the project, using the supplied analysis parameters.

Declaration

public Report Audit(AnalysisParams analysisParams, IProgress progress = null)

Parameters

Type	Name	Description
AnalysisParams	analysisParams	Parameters to control the audit process
IProgress	progress	Progress bar, if applicable

Returns

Type	Description
Report	Generated report

Audit(IProgress)

Performs static analysis of the project, using default parameters.

Declaration

public Report Audit(IProgress progress = null)

Parameters

Type	Name	Description
IProgress	progress	Progress bar, if applicable

Returns

Type	Description
Report	Generated report

AuditAsync(AnalysisParams, IProgress)

Performs asynchronous static analysis of the project, using the supplied analysis parameters. Provide a callback to the OnCompleted Action in analysisParams to obtain the Report when analysis is completed.

Declaration

public void AuditAsync(AnalysisParams analysisParams, IProgress progress = null)

Parameters

Type	Name	Description
AnalysisParams	analysisParams	Parameters to control the audit process
IProgress	progress	Progress bar, if applicable

OnPostprocessBuild(BuildReport)

Callback function which is called after a build is completed. If UserPreferences.AnalyzeAfterBuild is true, performs a full audit and logs the number of issues found.

Declaration

public void OnPostprocessBuild(BuildReport report)

Parameters

Type	Name	Description
BuildReport	report	A report containing information about the build, such as its target platform and output path.

Implements

IPostprocessBuildWithReport

IOrderedCallback