Class SettingsKeyAttribute | Settings Manager | 1.0.1
docs.unity.cn
    Show / Hide Table of Contents

    Class SettingsKeyAttribute

    Register a field with Settings, but do not automatically create a property field in the SettingsProvider. Unlike UserSettingAttribute, this attribute is valid for instance properties as well as static. These values will not be shown in the SettingsProvider, but will have their stored values cleared when "Reset All" is invoked.

    Inheritance
    Object
    Attribute
    SettingsKeyAttribute
    Namespace: UnityEditor.SettingsManagement
    Syntax
    [AttributeUsage(AttributeTargets.Field)]
    public sealed class SettingsKeyAttribute : Attribute, _Attribute

    Constructors

    SettingsKeyAttribute(String, SettingsScope)

    Register a field as a setting. This allows the UserSettingsProvider to reset it's value and display it's value in debugging modes.

    Declaration
    public SettingsKeyAttribute(string key, SettingsScope scope = null)
    Parameters
    Type Name Description
    String key

    The setting key.

    SettingsScope scope

    The scope in which this setting is serialized.

    Properties

    key

    Declaration
    public string key { get; }
    Property Value
    Type Description
    String

    The key for this value.

    scope

    Declaration
    public SettingsScope scope { get; }
    Property Value
    Type Description
    SettingsScope

    Where this setting is serialized.

    Back to top Copyright © 2019 Unity Technologies
    Generated by DocFX