Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


Descriptor

Descriptor defines a potential problem and a recommended course of action.
Read time 1 minuteLast updated 13 days ago

Definition

public sealed class Descriptor : IEquatable<Descriptor>

Fields

Value

Description

AreasAffected areas
DefaultSeverityDefault Severity of the issue.
DescriptionDescription of the issue.
DocumentationUrlURL to documentation.
FixerOptional Auto-Fixer
FixerLabelThe Auto-Fixer can have a custom label
IdAn unique identifier for the issue. IDs must have exactly 3 upper case characters, followed by 4 digits.
IsEnabledByDefaultReturns true if the issue is enabled by default.
MaximumVersionMaximum Unity version this issue applies to. If not specified, the issue applies to all versions.
MessageFormatMessage used to describe a specific instance of the issue.
MethodName of the method of a known code API issue.
MinimumVersionMinimum Unity version this issue applies to. If not specified, the issue applies to all versions.
PlatformsAffected platforms. If null, the issue applies to all platforms.
RecommendationRecommendation to fix the issue.
ReturnTypeReturn type of a known code API issue. See https://jira.unity3d.com/browse/PROFB-318 for more details on why this is useful.
TitleIssue title
TypeName of the type (namespace and class/struct) of a known code API issue.
ValueThe evaluated value of a know code API issue.

Constructors

Constructor

Description

Descriptor(System.String,System.String,Unity.ProjectAuditor.Editor.Areas,System.String,System.String)Initializes and returns an instance of Descriptor.

Methods

Method

Description

EqualsReturns true if the Descriptor is equal to a given object, false otherwise.
GetHashCodeReturns the hash code for the Descriptor's Issue ID.