Version: 2023.1

AssetSettingsProvider

class in UnityEditor

/

继承自:SettingsProvider

切换到手册

描述

AssetSettingsProvider 是 SettingsProvider 类的一种特化表示,可将旧版设置转换为统一设置 (Unified Settings)。旧版设置包括使用 Inspector 自行修改的任何设置,例如 ProjectSettings 文件夹下的 *.asset 文件。在后台,AssetSettingsProvider 为特定的资源创建 Editor,并通过封装 Editor.OnInspectorGUI 函数为 Settings 窗口构建 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,以便可以封装旧版设置(即先前在 Inspector 中显示的设置)。

公共函数

OnActivate覆盖此 AssetSettingsProvider 的 SettingsProvider.OnActivate。
OnDeactivate覆盖此 AssetSettingsProvider 的 SettingsProvider.OnDeactivate。
OnFooterBarGUI覆盖此 AssetSettingsProvider 的 SettingsProvider.OnFooterBarGUI。
OnGUI覆盖此 AssetSettingsProvider 的 SettingsProvider.OnGUI。
OnTitleBarGUI覆盖此 AssetSettingsProvider 的 SettingsProvider.OnTitleBarGUI。这将绘制包含“add to preset”和“help”按钮的按钮栏。

静态函数

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获取或设置关键字列表,以便将这些关键字与用户正在搜索的内容进行比较。当用户在 Settings 窗口的搜索框中输入值时,SettingsProvider.HasSearchInterest 会尝试将这些关键字与此列表进行匹配。
label获取或设置 SettingsProvider 在 Settings 窗口中的显示名称。如果未设置,Settings 窗口将改用 SettingsProvider.settingsPath 的最后一个标记。
scope获取 SettingsProvider 的范围。该范围确定 SettingsProvider 显示在 Preferences 窗口 (SettingsScope.User) 中还是显示在 Settings 窗口 (SettingsScope.Project) 中。
settingsPath获取用于将 SettingsProvider 放置在 Settings 窗口的树视图中的路径。该路径在所有其他设置路径中应该具有唯一性,并且应该将“/”用作分隔符。
titleBarGuiHandler重载 SettingsProvider.OnTitleBarGUI。

公共函数

HasSearchInterest检查用户在 Settings 窗口搜索框中键入内容时是否应显示 SettingsProvider。SettingsProvider 尝试将搜索词(甚至搜索词一部分)与任何 SettingsProvider.keywords 匹配。该搜索不区分大小写。
OnInspectorUpdateOnInspectorUpdate 以每秒 10 帧的速度调用,以便检视面板有机会进行更新。有关更多详细信息,请参阅 EditorWindow.OnInspectorUpdate。
Repaint请求 SettingsWindow 以进行重绘。

静态函数

GetSearchKeywordsFromGUIContentProperties从特定类型的所有公共静态成员中提取搜索关键字。
GetSearchKeywordsFromPath从特定路径中资源的序列化属性提取搜索关键字。
GetSearchKeywordsFromSerializedObject从 SerializedObject 的序列化属性提取搜索关键字。