EditorUserSettings

存储用于Unity Editor环境的自定义配置数据，可以控制是否在项目间共享这些配置数据。
Store custom settings data for Unity Editor environment, and control whether to share these settings data between projects.

支持的Unity版本
Supported Unity Versions

Unity 2019.4及更新版本。
Unity 2019.4 or higher.

安装方式
Installation

使用 OpenUPM 安装此包，或者直接克隆此仓库到项目中。
Install this package via OpenUPM, or clone this repository directly into the Packages folder of your project.

如何使用
How to Use

API

static class CustomEditorUserSettings
{
    bool Has<T>(string key, bool isSharedAcrossProjects = false);

    T Get<T>(string key, T defaultValue, bool isSharedAcrossProjects = false);
    bool TryGet<T>(string key, out T value);

    void Set<T>(string key, T value, bool isSharedAcrossProjects = false);

    bool Remove<T>(string key, bool isSharedAcrossProjects = false);
    bool RemoveAll<T>(bool isSharedAcrossProjects = false);
  
    void Clear(bool isSharedAcrossProjects = false);

    BatchingScope StartBatching(bool isSharedAcrossProjects = false);
    void EndBatching(bool isSharedAcrossProjects = false);
}

• 当 isSharedAcrossProjects 为 false 时，数据只供当前项目使用。
  When isSharedAcrossProjects is false, the settings is only for the current project.
  • 默认情况下，数据会保存在 ${Application.dataPath}/../UserSettings/CustomEditorUserSettingsStorage.asset 中。
    By default settings will be saved in ${Application.dataPath}/../UserSettings/CustomEditorUserSettingsStorage.asset.
  • 如果项目中定义了 GBG_EDITOR_USER_SETTINGS_USE_LIBRARY 预编译指令，则数据会保存在 ${Application.dataPath}/../Library/UserSettings/CustomEditorUserSettingsStorage.asset 中。
    If the GBG_EDITOR_USER_SETTINGS_USE_LIBRARY preprocessor directive is defined in the project, the settings will be saved in ${Application.dataPath}/../Library/UserSettings/CustomEditorUserSettingsStorage.asset.
• 当 isSharedAcrossProjects 为 true 时，数据可以跨项目共享，会保存在 ${InternalEditorUtility.unityPreferencesFolder}/UserSettings/CustomEditorUserSettingsStorage.asset 中。
  When isSharedAcrossProjects is true, the settings can be shared across projects, and will be saved in ${InternalEditorUtility.unityPreferencesFolder}/UserSettings/CustomEditorUserSettingsStorage.asset.

菜单项
Menu Items

• Tools/Bamboo/Editor User Settings
  • 检视项目配置存储对象：Inspect Storage Object for Project
  • 在文件夹中显示项目配置存储对象：Show Storage Object for Project in Folder
  • 检视跨项目配置存储对象：Inspect Storage Object Shared Across Projects
  • 在文件夹中显示跨项目配置存储对象：Show Storage Object Shared Across Projects in Folder

已知问题
Known Issues

1. 读写跨项目配置数据时，没有添加文件锁机制，同时读写时，可能会导致数据丢失。
   When reading and writing data across projects, there is no file lock mechanism added, and data may be lost when reading and writing at the same time.
2. 读写跨项目配置数据时，低版本Unity可能无法读取某些高版本Unity存储的数据。
   When reading and writing data across projects, lower versions of Unity may not be able to read some data stored by higher versions of Unity.
3. 不能存储继承自 UnityEngine.Object 的数据（若需要，可以存储guid、路径或 GlobalObjectId ）。
   Cannot store data inherited from UnityEngine.Object (if needed, you can store guid, path or GlobalObjectId )。