docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Interface IUserSetting

    Types implementing IUserSetting are eligible for use with UserSettingAttribute, which enables fields to automatically populate the UserSettingsProvider interface.

    Namespace: UnityEditor.SettingsManagement
    Assembly: solution.dll
    Syntax
    public interface IUserSetting

    Properties

    Name Description
    key
    scope
    settings
    settingsRepositoryName

    The name of the ISettingsRepository that this setting should be associated with. If null, the first repository matching the scope will be used.

    type

    Methods

    Name Description
    ApplyModifiedProperties()

    When the inspected type is a reference value, it is possible to change properties without affecting the backing setting. ApplyModifiedProperties provides a method to force serialize these changes.

    Delete(bool)

    Delete the saved setting. Does not clear the current value.

    GetDefaultValue()

    Get the default value for this setting.

    GetValue()

    Get the stored value. If you are implementing IUserSetting it is recommended that you cache this value.

    Reset(bool)

    Set the current value back to the default.

    SetValue(object, bool)

    Set the value for this setting.

    In This Article
    Back to top
    Copyright © 2024 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)