AnalysisParams
Represents an object which can be passed to an instance of ProjectAuditor to specify how analysis should be performed and to provide delegates to be called when analysis steps have completed. AnalysisParams defaults to values which instruct ProjectAuditor to analyze everything in the project for the current build target, but instances can be populated with custom data in an object initializer to provide additional constraints.
Read time 1 minuteLast updated 6 days ago
Definition
- Type: Class
- Namespace: Unity.ProjectAuditor.Editor
- Assembly: UnityEditor
public class AnalysisParams
Fields
Value | Description |
|---|---|
| AssemblyNames | Assemblies to analyze. If null, all compiled assemblies will be analyzed. |
| Categories | Issue Categories to include in the audit. If null, the analysis will include all categories. |
| CodeAnalysisFlags | The Compilation flags to use during code analysis. |
| CodeOptimization | Code optimization mode. The default is CodeOptimization.Release. |
| DiagnosticParams | The DiagnosticParams object which defines the customizable thresholds for reporting certain diagnostics. By default, this makes a copy of ProjectAuditorSettings. |
| OnCompleted | Notifies that all Modules completed their analysis. |
| OnIncomingIssues | Reports a batch of new issues. Note that this be called multiple times per analysis. |
| OnModuleCompleted | Notifies that a Module completed its analysis. |
| OnStarted | Notifies that an analysis has started. |
Constructors
Constructor | Description |
|---|---|
| AnalysisParams(System.Boolean) | AnalysisParams constructor. |
| AnalysisParams(Unity.ProjectAuditor.Editor.AnalysisParams) | Copy constructor. |
Properties
Property | Description |
|---|---|
| Platform | Analysis platform. The default platform is the currently active build target. |
Methods
Method | Description |
|---|---|
| WithAdditionalDiagnosticRules | Adds a list of additional Rules which will be applied during analysis. |