docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class UserSettingAttribute

    A custom attribute for registering a static field of type IUserSetting for the UserSettingsProvider window.

    Inheritance
    object
    Attribute
    UserSettingAttribute
    Implements
    _Attribute
    Inherited Members
    Attribute.Equals(object)
    Attribute.GetCustomAttribute(Assembly, Type)
    Attribute.GetCustomAttribute(Assembly, Type, bool)
    Attribute.GetCustomAttribute(MemberInfo, Type)
    Attribute.GetCustomAttribute(MemberInfo, Type, bool)
    Attribute.GetCustomAttribute(Module, Type)
    Attribute.GetCustomAttribute(Module, Type, bool)
    Attribute.GetCustomAttribute(ParameterInfo, Type)
    Attribute.GetCustomAttribute(ParameterInfo, Type, bool)
    Attribute.GetCustomAttributes(Assembly)
    Attribute.GetCustomAttributes(Assembly, bool)
    Attribute.GetCustomAttributes(Assembly, Type)
    Attribute.GetCustomAttributes(Assembly, Type, bool)
    Attribute.GetCustomAttributes(MemberInfo)
    Attribute.GetCustomAttributes(MemberInfo, bool)
    Attribute.GetCustomAttributes(MemberInfo, Type)
    Attribute.GetCustomAttributes(MemberInfo, Type, bool)
    Attribute.GetCustomAttributes(Module)
    Attribute.GetCustomAttributes(Module, bool)
    Attribute.GetCustomAttributes(Module, Type)
    Attribute.GetCustomAttributes(Module, Type, bool)
    Attribute.GetCustomAttributes(ParameterInfo)
    Attribute.GetCustomAttributes(ParameterInfo, bool)
    Attribute.GetCustomAttributes(ParameterInfo, Type)
    Attribute.GetCustomAttributes(ParameterInfo, Type, bool)
    Attribute.GetHashCode()
    Attribute.IsDefaultAttribute()
    Attribute.IsDefined(Assembly, Type)
    Attribute.IsDefined(Assembly, Type, bool)
    Attribute.IsDefined(MemberInfo, Type)
    Attribute.IsDefined(MemberInfo, Type, bool)
    Attribute.IsDefined(Module, Type)
    Attribute.IsDefined(Module, Type, bool)
    Attribute.IsDefined(ParameterInfo, Type)
    Attribute.IsDefined(ParameterInfo, Type, bool)
    Attribute.Match(object)
    Attribute.TypeId
    object.Equals(object, object)
    object.GetType()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: UnityEditor.SettingsManagement
    Assembly: Unity.Settings.Editor.dll
    Syntax
    [AttributeUsage(AttributeTargets.Field)]
    public sealed class UserSettingAttribute : Attribute, _Attribute

    Constructors

    UserSettingAttribute()

    Registers a static field as a setting. Fields must be of a type that implements IUserSetting.

    Declaration
    public UserSettingAttribute()

    UserSettingAttribute(string, string, string)

    Registers a static field as a setting and creates an entry in the UI. The field must be of a type that implements IUserSetting.

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

    The category to assign this setting to.

    string title

    The display text for this setting in the UI.

    string tooltip

    Optional. The tooltip for this setting.

    Properties

    category

    Gets the name of the group (category) to assign this settings value to. When Unity finds settings values in assemblies, it displays them in groups, organized by category.

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

    The group or category where this setting appears in the UI.

    title

    Gets the label to show for this setting.

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

    The label that appears beside this setting in the UI.

    visibleInSettingsProvider

    True to show this field in the UserSettingsProvider interface; false if not.

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

    Implements

    _Attribute
    In This Article
    Back to top
    Copyright © 2026 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)