Class UserSettingAttribute

Register a static field of type IUserSetting with the UserSettingsProvider window.

Inheritance
object
Attribute
UserSettingAttribute
Implements
Inherited Members
Namespace: UnityEditor.SettingsManagement
Assembly: Unity.Settings.Editor.dll
Syntax
[AttributeUsage(AttributeTargets.Field)]
public sealed class UserSettingAttribute : Attribute, _Attribute

Constructors

UserSettingAttribute()

Register a static field as a setting. Field must be of a type implementing IUserSetting.

Declaration
public UserSettingAttribute()

UserSettingAttribute(string, string, string)

Register a static field as a setting and create an entry in the UI. Field must be of a type implementing IUserSetting.

Declaration
public UserSettingAttribute(string category, string title, string tooltip = null)
Parameters
Type Name Description
string category
string title
string tooltip

Properties

category

Settings that are automatically scraped from assemblies are displayed in groups, organized by category.

Declaration
public string category { get; }
Property Value
Type Description
string

The title of the group of settings that this setting will be shown under.

title

Declaration
public GUIContent title { get; }
Property Value
Type Description
GUIContent

The label to show for this setting.

visibleInSettingsProvider

Declaration
public bool visibleInSettingsProvider { get; }
Property Value
Type Description
bool

True if this field should be shown in the UserSettingsProvider interface, false if not.

Implements