AssetSettingsProvider 是 SettingsProvider 类的特例,用于将传统设置转换为统一设置。传统设置包括使用检查器修改自身的任何设置,例如 ProjectSettings 文件夹下的 *.asset 文件。在幕后,AssetSettingsProvider 为特定资产创建 Editor,并通过包装 Editor.OnInspectorGUI 函数构建设置窗口的 UI。
我们在内部使用此类来包装我们现有的设置。
using UnityEditor; using UnityEngine;
// Create a new type of Settings Asset. class MyCustomSettings : ScriptableObject { public const string k_MyCustomSettingsPath = "Assets/Editor/MyCustomSettings.asset";
[SerializeField] private int m_Number;
[SerializeField] private string m_SomeString;
internal static SerializedObject GetSettings() { var settings = AssetDatabase.LoadAssetAtPath<MyCustomSettings>(k_MyCustomSettingsPath); if (settings == null) { settings = ScriptableObject.CreateInstance<MyCustomSettings>(); settings.m_Number = 42; settings.m_SomeString = "The answer to the universe"; AssetDatabase.CreateAsset(settings, k_MyCustomSettingsPath); }
return new SerializedObject(settings); } }
[CustomEditor(typeof(MyCustomSettings))] class MyCustomSettingsEditor : Editor { // Nothing to do, this uses the Generic Editor to display MyCustomSettings properties }
class AssetSettingsProviderRegister { [SettingsProvider] public static SettingsProvider CreateFromFilePath() { // Create an AssetSettingsProvider from a file path: var provider = AssetSettingsProvider.CreateProviderFromAssetPath("Project/AssetSettings/FromFile", MyCustomSettings.k_MyCustomSettingsPath);
// Register keywords from the properties of MyCustomSettings provider.keywords = SettingsProvider.GetSearchKeywordsFromSerializedObject(new SerializedObject(AssetDatabase.LoadAllAssetsAtPath(MyCustomSettings.k_MyCustomSettingsPath))); return provider; }
[SettingsProvider] public static SettingsProvider CreateFromSettingsObject() { // Create an AssetSettingsProvider from a settings object (UnityEngine.Object): var settingsObj = AssetDatabase.LoadAssetAtPath<UnityEngine.Object>(MyCustomSettings.k_MyCustomSettingsPath); var provider = AssetSettingsProvider.CreateProviderFromObject("Project/AssetSettings/FromObject", settingsObj);
// Register keywords from the properties of MyCustomSettings provider.keywords = SettingsProvider.GetSearchKeywordsFromSerializedObject(new SerializedObject(settingsObj)); return provider; }
[SettingsProvider] public static SettingsProvider CreateFromSettingsFromFunctor() { // Create an AssetSettingsProvider from a functor that must return a UnityEngine.Object: var provider = new AssetSettingsProvider("Project/AssetSettings/FromFunctor", () => Editor.CreateEditor(AssetDatabase.LoadAssetAtPath<UnityEngine.Object>(MyCustomSettings.k_MyCustomSettingsPath)));
// Register keywords from the properties of MyCustomSettings provider.keywords = SettingsProvider.GetSearchKeywordsFromSerializedObject(new SerializedObject(AssetDatabase.LoadAllAssetsAtPath(MyCustomSettings.k_MyCustomSettingsPath))); return provider; } }
settingsEditor | 提供用于修改设置的 UI 的编辑器。 |
AssetSettingsProvider | 创建一个新的 AssetSettingsProvider,以便您可以包装传统设置(即以前出现在检查器中的设置)。 |
OnActivate | 覆盖此 AssetSettingsProvider 的 SettingsProvider.OnActivate。 |
OnDeactivate | 覆盖此 AssetSettingsProvider 的 SettingsProvider.OnDeactivate。 |
OnFooterBarGUI | 覆盖此 AssetSettingsProvider 的 SettingsProvider.OnFooterBarGUI。 |
OnGUI | 覆盖此 AssetSettingsProvider 的 SettingsProvider.OnGUI。 |
OnTitleBarGUI | 覆盖此 AssetSettingsProvider 的 SettingsProvider.OnTitleBarGUI。这将绘制包含“添加到预设”和“帮助”按钮的按钮栏。 |
CreateProviderFromAssetPath | 从资产路径创建 AssetSettingsProvider。 |
CreateProviderFromObject | 从设置对象创建 AssetSettingsProvider。 |
CreateProviderFromResourcePath | 从资产资源路径创建 AssetSettingsProvider。 |
activateHandler | 覆盖 SettingsProvider.OnActivate。 |
deactivateHandler | 覆盖 SettingsProvider.OnDeactivate。 |
footerBarGuiHandler | 覆盖 SettingsProvider.OnFooterBarGUI。 |
guiHandler | 覆盖 SettingsProvider.OnGUI。 |
hasSearchInterestHandler | 覆盖 SettingsProvider.HasSearchInterest。 |
inspectorUpdateHandler | 覆盖 SettingsProvider.OnInspectorUpdate。 |
keywords | 获取或设置要与用户正在搜索的内容进行比较的关键字列表。当用户在设置窗口的搜索框中输入值时,SettingsProvider.HasSearchInterest 会尝试将这些关键字与该列表匹配。搜索不区分大小写。 |
label | 获取或设置 SettingsProvider 在设置窗口中显示的名称。如果未设置,设置窗口将使用 SettingsProvider.settingsPath 的最后一个标记。 |
scope | 获取 SettingsProvider 的范围。范围决定 SettingsProvider 是显示在首选项窗口中(SettingsScope.User)还是设置窗口中(SettingsScope.Project)。 |
settingsPath | 获取用于将 SettingsProvider 放置在设置窗口树视图中的路径。该路径应在所有其他设置路径中唯一,并应使用“/”作为分隔符。 |
titleBarGuiHandler | 覆盖 SettingsProvider.OnTitleBarGUI。 |
HasSearchInterest | 检查当用户在设置窗口搜索框中键入内容时,是否应显示 SettingsProvider。SettingsProvider 尝试将搜索词(即使部分)与任何 SettingsProvider.keywords 匹配。搜索不区分大小写。 |
OnInspectorUpdate | OnInspectorUpdate 每秒调用 10 次,以便检查器有机会更新。有关详细信息,请参阅 EditorWindow.OnInspectorUpdate。 |
Repaint | 请求 SettingsWindow 进行重绘。 |
GetSearchKeywordsFromGUIContentProperties | 从特定类型的所有公共静态成员中提取搜索关键字。 |
GetSearchKeywordsFromPath | 从特定路径下资产的序列化属性中提取搜索关键字。 |
GetSearchKeywordsFromSerializedObject | 从 SerializedObject 的序列化属性中提取搜索关键字。 |