Class SettingsKeyAttribute
A custom attribute for registering a field with Settings, but without automatically creating a property field in the SettingsProvider. Unlike UserSettingAttribute, this attribute is valid for instance properties as well as static. These values don't appear in the SettingsProvider. Unity clears their stored values when "Reset All" is invoked.
Implements
Inherited Members
Namespace: UnityEditor.SettingsManagement
Assembly: Unity.Settings.Editor.dll
Syntax
[AttributeUsage(AttributeTargets.Field)]
public sealed class SettingsKeyAttribute : Attribute, _Attribute
Constructors
SettingsKeyAttribute(string, SettingsScope)
Registers a field as a setting. This allows the UserSettingsProvider to reset its value and display it in debugging modes.
Declaration
public SettingsKeyAttribute(string key, SettingsScope scope = SettingsScope.Project)
Parameters
| Type | Name | Description |
|---|---|---|
| string | key | The key for this setting. |
| SettingsScope | scope | The scope in which this setting is serialized. |
Properties
key
Gets the key for this value.
Declaration
public string key { get; }
Property Value
| Type | Description |
|---|---|
| string | The key used to identify this settings value from the repository. |
scope
Gets the location where this setting is serialized.
Declaration
public SettingsScope scope { get; }
Property Value
| Type | Description |
|---|---|
| SettingsScope | Indicates whether this is a Project setting or a User preference. |