Version: Unity 6.4 Alpha (6000.4)
LanguageEnglish
  • C#

AnalysisParams

class in Unity.ProjectAuditor.Editor

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

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.

Properties

Property 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.
CodeOptimization Code optimization mode. The default is CodeOptimization.Release.
CompilationMode The Compilation mode to use during code analysis. The default is CompilationMode.Player.
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.
Platform Analysis platform. The default platform is the currently active build target.

Constructors

Constructor Description
AnalysisParams AnalysisParams constructor.

Public Methods

Method Description
WithAdditionalDiagnosticRules Adds a list of additional Rules which will be applied during analysis.