Unity - Scripting API: AnalysisContext
class in Unity.ProjectAuditor.Editor.Core
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.
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.
Description
Base class for a context object passed by a Module to an Analyzer's Analyze() method.
AnalysisContext provides information to the Analyze() method which is used to decide which issues to report. It also provides helper methods to build Issues or Insights.
Properties
| Property | Description |
|---|---|
| Params | The AnalysisParams object that was passed to (or created by) the ProjectAuditor's Audit() method. |
Public Methods
| Method | Description |
|---|---|
| CreateInsight | Create a ReportItemBuilder for an Insight: A ReportItem collected for informational purposes. |
| CreateIssue | Create a ReportItemBuilder for an Issue: a potential problem in the project, with an actionable recommendation to resolve it. |
| IsDescriptorEnabled | Checks whether a given Descriptor is enabled for the current analysis. |