自定义ProjectSettings设置项

2024-03-08 04:30
文章标签 设置 自定义 projectsettings

本文主要是介绍自定义ProjectSettings设置项，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

基于ScriptableObject资源和SettingsProvider特性方式实现

1.实现ScriptableObject数据设计


/// <summary>
/// 用于存储我们的设置配置
/// </summary>
public class EditorLearnSettings : ScriptableObject
{/// <summary>/// 用于我们设置的保存位置/// </summary>private const string SettingsFile= "Assets/Settings/EditorLearnSetting.asset";#region 此处可以存储我们自定义的配置信息/// <summary>/// 模拟我们的配置/// </summary>public int m_ConfigVersionCode = 1;#endregion
}

2.提供配置文件内容的全局实例方法 

在我们的EditorLearnSettings类提供以下方法，为我们提供全局配置信息。

    /// <summary>/// 这里提供一个配置对象/// </summary>/// <returns></returns>public static EditorLearnSettings GetOrCreateSettings(){var settings = AssetDatabase.LoadAssetAtPath<EditorLearnSettings>(SettingsFile);if (settings == null){settings = ScriptableObject.CreateInstance<EditorLearnSettings>();settings.m_ConfigVersionCode = 0;if (!Directory.Exists(Path.GetDirectoryName(SettingsFile))){Directory.CreateDirectory(Path.GetDirectoryName(SettingsFile));}AssetDatabase.CreateAsset(settings, SettingsFile);AssetDatabase.SaveAssets();}return settings;}/// <summary>/// 提供一个SerializedObject的对象/// </summary>/// <returns></returns>public static SerializedObject GetSerializedSettings(){return new SerializedObject(GetOrCreateSettings());}
  • 当资源配置被创建出来我们可以直接进行配置，如果不想通过资源配置文件配置，可以为其制定一个CustomEditor。
[CustomEditor(typeof(EditorLearnSettings))]
public class EditorLearnSettingsView:Editor
{protected override void OnHeaderGUI(){GUILayout.Label("请从Project Settings配置");}public override void OnInspectorGUI() { }
}

3.编写一个提供SettingsProvider数据的静态方法。

我们继续在EditorLearnSettings类提供以下方法。

    /// <summary>/// 这里主要是制定我们的Settings路径/// </summary>private const string ProjectSettingPtah = "Project/编辑器学习";/// <summary>/// 将我们的Setting提供给Unity/// </summary>/// <returns></returns>[SettingsProvider]public static SettingsProvider CreateEditorLearnSettingsProvider(){///创建一个SettingsProvidervar provider = new SettingsProvider(ProjectSettingPtah, SettingsScope.Project){guiHandler = (searchContext) =>{///searchContext：提供用户搜索的信息///这里是一个gui的处理行为var settings = EditorLearnSettings.GetSerializedSettings();EditorGUILayout.PropertyField(settings.FindProperty("m_ConfigVersionCode"), new GUIContent("版本码："));settings.ApplyModifiedPropertiesWithoutUndo();},// 用于搜索的关键字，在Project 可以搜索对应的配置keywords = new HashSet<string>(new[] { "Learn", "KTGame" })};return provider;}

 4.到此我们就可以在Project Setting看见我们自定义的配置模块了。

5.完整代码

using System.Collections.Generic;
using UnityEditor;
using UnityEngine;
using System.IO;[CustomEditor(typeof(EditorLearnSettings))]
public class EditorLearnSettingsView:Editor
{protected override void OnHeaderGUI(){GUILayout.Label("请从Project Settings配置");}public override void OnInspectorGUI() { }
}/// <summary>
/// 用于存储我们的设置配置
/// </summary>
public class EditorLearnSettings : ScriptableObject
{/// <summary>/// 用于我们设置的保存位置/// </summary>private const string SettingsFile= "Assets/Settings/EditorLearnSetting.asset";#region 此处可以存储我们自定义的配置信息/// <summary>/// 模拟我们的配置/// </summary>public int m_ConfigVersionCode = 1;#endregion/// <summary>/// 这里提供一个全局的设置获取方式/// </summary>/// <returns></returns>public static EditorLearnSettings GetOrCreateSettings(){var settings = AssetDatabase.LoadAssetAtPath<EditorLearnSettings>(SettingsFile);if (settings == null){settings = ScriptableObject.CreateInstance<EditorLearnSettings>();settings.m_ConfigVersionCode = 0;if (!Directory.Exists(Path.GetDirectoryName(SettingsFile))){Directory.CreateDirectory(Path.GetDirectoryName(SettingsFile));}AssetDatabase.CreateAsset(settings, SettingsFile);AssetDatabase.SaveAssets();}return settings;}/// <summary>/// 提供一个SerializedObject的获取/// </summary>/// <returns></returns>public static SerializedObject GetSerializedSettings(){return new SerializedObject(GetOrCreateSettings());}/// <summary>/// 这里主要是制定我们的Settings路径/// </summary>private const string ProjectSettingPtah = "Project/编辑器学习";/// <summary>/// 将我们的Setting提供给Unity/// </summary>/// <returns></returns>[SettingsProvider]public static SettingsProvider CreateEditorLearnSettingsProvider(){///创建一个SettingsProvidervar provider = new SettingsProvider(ProjectSettingPtah, SettingsScope.Project){guiHandler = (searchContext) =>{///searchContext：提供用户搜索的信息///这里是一个gui的处理行为var settings = EditorLearnSettings.GetSerializedSettings();EditorGUILayout.PropertyField(settings.FindProperty("m_ConfigVersionCode"), new GUIContent("版本码："));settings.ApplyModifiedPropertiesWithoutUndo();},// 用于搜索的关键字，在Project 可以搜索对应的配置keywords = new HashSet<string>(new[] { "Learn", "KTGame" })};return provider;}
}

基于继承SettingsProvider的实现方式。

1.同样需要一个配置文件。

配置文件我们直接使用上面的文件。

/// <summary>
/// 用于存储我们的设置配置
/// </summary>
public class EditorLearnSettings : ScriptableObject
{/// <summary>/// 用于我们设置的保存位置/// </summary>private const string SettingsFile= "Assets/Settings/EditorLearnSetting.asset";#region 此处可以存储我们自定义的配置信息/// <summary>/// 模拟我们的配置/// </summary>public int m_ConfigVersionCode = 1;#endregion/// <summary>/// 这里提供一个全局的设置获取方式/// </summary>/// <returns></returns>public static EditorLearnSettings GetOrCreateSettings(){var settings = AssetDatabase.LoadAssetAtPath<EditorLearnSettings>(SettingsFile);if (settings == null){settings = ScriptableObject.CreateInstance<EditorLearnSettings>();settings.m_ConfigVersionCode = 0;if (!Directory.Exists(Path.GetDirectoryName(SettingsFile))){Directory.CreateDirectory(Path.GetDirectoryName(SettingsFile));}AssetDatabase.CreateAsset(settings, SettingsFile);AssetDatabase.SaveAssets();}return settings;}/// <summary>/// 提供一个SerializedObject的获取/// </summary>/// <returns></returns>public static SerializedObject GetSerializedSettings(){return new SerializedObject(GetOrCreateSettings());}
}

2.继承 SettingsProvider

首先我们创建EditorLearnSettingsProvider类并继承SettingsProvider。

public class EditorLearnSettingsProvider: SettingsProvider{}

实现SettingsProvider构造函数。

public EditorLearnSettingsProvider(string path, SettingsScope scope) : base(path, scope) { }

重写OnGUI和OnActivate

    /// <summary>/// 当模块被激活时被调用/// </summary>/// <param name="searchContext">用户搜索的内容</param>/// <param name="rootElement">UIElements根节点。如果添加到此，则 SettingsProvider 使用 UIElements 而不是调用 SettingsProvider.OnGUI 来构建 UI。如果不添加到此 VisualElement，则必须使用 IMGUI 来构建 UI。</param>public override void OnActivate(string searchContext, VisualElement rootElement){serializedObject = EditorLearnSettings.GetSerializedSettings();}public override void OnGUI(string searchContext){EditorGUILayout.PropertyField(serializedObject.FindProperty("m_ConfigVersionCode"), new GUIContent("版本码："));}

3.通过SettingsProvider方法特性注册到SettingsProvider中

    [SettingsProvider]public static SettingsProvider CreateMyCustomSettingsProvider(){var provider = new EditorLearnSettingsProvider(ProjectSettingPtah, SettingsScope.Project);provider.keywords = new[] { "Learn", "KTGame" };return provider;}

4.完整代码

using UnityEditor;
using UnityEngine;
using System.IO;
using UnityEngine.UIElements;[CustomEditor(typeof(EditorLearnSettings))]
public class EditorLearnSettingsView:Editor
{protected override void OnHeaderGUI(){GUILayout.Label("请从Project Settings配置");}public override void OnInspectorGUI() { }
}/// <summary>
/// 用于存储我们的设置配置
/// </summary>
public class EditorLearnSettings : ScriptableObject
{/// <summary>/// 用于我们设置的保存位置/// </summary>private const string SettingsFile= "Assets/Settings/EditorLearnSetting.asset";#region 此处可以存储我们自定义的配置信息/// <summary>/// 模拟我们的配置/// </summary>public int m_ConfigVersionCode = 1;#endregion/// <summary>/// 这里提供一个全局的设置获取方式/// </summary>/// <returns></returns>public static EditorLearnSettings GetOrCreateSettings(){var settings = AssetDatabase.LoadAssetAtPath<EditorLearnSettings>(SettingsFile);if (settings == null){settings = ScriptableObject.CreateInstance<EditorLearnSettings>();settings.m_ConfigVersionCode = 0;if (!Directory.Exists(Path.GetDirectoryName(SettingsFile))){Directory.CreateDirectory(Path.GetDirectoryName(SettingsFile));}AssetDatabase.CreateAsset(settings, SettingsFile);AssetDatabase.SaveAssets();}return settings;}/// <summary>/// 提供一个SerializedObject的获取/// </summary>/// <returns></returns>public static SerializedObject GetSerializedSettings(){return new SerializedObject(GetOrCreateSettings());}
}public class EditorLearnSettingsProvider: SettingsProvider
{private const string ProjectSettingPtah = "Project/编辑器学习";public EditorLearnSettingsProvider(string path, SettingsScope scope) : base(path, scope) { }private SerializedObject serializedObject;/// <summary>/// 当模块被激活时被调用/// </summary>/// <param name="searchContext">用户搜索的内容</param>/// <param name="rootElement">UIElements根节点。如果添加到此，则 SettingsProvider 使用 UIElements 而不是调用 SettingsProvider.OnGUI 来构建 UI。如果不添加到此 VisualElement，则必须使用 IMGUI 来构建 UI。</param>public override void OnActivate(string searchContext, VisualElement rootElement){serializedObject = EditorLearnSettings.GetSerializedSettings();}public override void OnGUI(string searchContext){EditorGUILayout.PropertyField(serializedObject.FindProperty("m_ConfigVersionCode"), new GUIContent("版本码："));}[SettingsProvider]public static SettingsProvider CreateMyCustomSettingsProvider(){var provider = new EditorLearnSettingsProvider(ProjectSettingPtah, SettingsScope.Project);provider.keywords = new[] { "Learn", "KTGame" };return provider;}
}

总结

  • SettingsScope共有两项，User显示在Preferences 窗口；Project显示在Project Settings窗口。
  • 这里我们使用的是ScriptableObject方式对配置进行存储，我们也可以使用其它的方式存储在非工程里或者存在ProjectSettings文件夹里。
  • 我们存储的配置目标尽可能的保证全局的唯一性。
  • 关于Project Settings配置模块和Preferences 配置我们还是最好进行一个统一的管理。
  • AssetDatabase.CreateAsset创建资源时要保证路径有效。
  • 此主题所有代码都是编辑器代码应该放在Editor下。
  • 如果我们需要提交多个配置模块可以使用SettingsProviderGroup，你的方法应该提供一个SettingsProvider[]。

这篇关于自定义ProjectSettings设置项的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！

原文地址:https://blog.csdn.net/l100142548/article/details/125406990
本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.chinasem.cn/article/785979。

相关文章

如何关闭 Mac 触发角功能或设置修饰键? mac电脑防止误触设置技巧

如何关闭 Mac 触发角功能或设置修饰键? mac电脑防止误触设置技巧

《如何关闭Mac触发角功能或设置修饰键?mac电脑防止误触设置技巧》从Windows换到iOS大半年来，触发角是我觉得值得吹爆的MacBook效率神器，成为一大说服理由，下面我们就来看看mac电... MAC 的「触发角」功能虽然提高了效率，但过于灵敏也让不少用户感到头疼。特别是在关键时刻，一不小心就可能触
阅读更多...
SpringBoot自定义注解如何解决公共字段填充问题

SpringBoot自定义注解如何解决公共字段填充问题

《SpringBoot自定义注解如何解决公共字段填充问题》本文介绍了在系统开发中,如何使用AOP切面编程实现公共字段自动填充的功能,从而简化代码,通过自定义注解和切面类,可以统一处理创建时间和修改时间... 目录1.1 问题分析1.2 实现思路1.3 代码开发1.3.1 步骤一1.3.2 步骤二1.3.3
阅读更多...
dubbo3 filter(过滤器)如何自定义过滤器

dubbo3 filter(过滤器)如何自定义过滤器

《dubbo3filter(过滤器)如何自定义过滤器》dubbo3filter（过滤器）类似于javaweb中的filter和springmvc中的intercaptor,用于在请求发送前或到达前进... 目录dubbo3 filter（过滤器）简介dubbo 过滤器运行时机自定义 filter第一种 @A
阅读更多...
Nginx配置系统服务&设置环境变量方式

Nginx配置系统服务&设置环境变量方式

《Nginx配置系统服务&设置环境变量方式》本文介绍了如何将Nginx配置为系统服务并设置环境变量,以便更方便地对Nginx进行操作,通过配置系统服务,可以使用系统命令来启动、停止或重新加载Nginx... 目录1.Nginx操作问题2.配置系统服android务3.设置环境变量总结1.Nginx操作问题
阅读更多...
grom设置全局日志实现执行并打印sql语句

grom设置全局日志实现执行并打印sql语句

《grom设置全局日志实现执行并打印sql语句》本文主要介绍了grom设置全局日志实现执行并打印sql语句,包括设置日志级别、实现自定义Logger接口以及如何使用GORM的默认logger,通过这些... 目录gorm中的自定义日志gorm中日志的其他操作日志级别Debug自定义 Loggergorm中的
阅读更多...
前端 CSS 动态设置样式：:class、:style 等技巧(推荐)

前端 CSS 动态设置样式：:class、:style 等技巧(推荐)

《前端CSS动态设置样式：:class、:style等技巧(推荐)》：本文主要介绍了Vue.js中动态绑定类名和内联样式的两种方法：对象语法和数组语法，通过对象语法，可以根据条件动态切换类名或样式；通过数组语法，可以同时绑定多个类名或样式，此外，还可以结合计算属性来生成复杂的类名或样式对象，详细内容请阅读本文，希望能对你有所帮助...
阅读更多...
MySQL8.0设置redo缓存大小的实现

MySQL8.0设置redo缓存大小的实现

《MySQL8.0设置redo缓存大小的实现》本文主要在MySQL8.0.30及之后版本中使用innodb_redo_log_capacity参数在线更改redo缓存文件大小,下面就来介绍一下,具有一... mysql 8.0.30及之后版本可以使用innodb_redo_log_capacity参数来更改
阅读更多...
Nginx设置连接超时并进行测试的方法步骤

Nginx设置连接超时并进行测试的方法步骤

《Nginx设置连接超时并进行测试的方法步骤》在高并发场景下,如果客户端与服务器的连接长时间未响应,会占用大量的系统资源,影响其他正常请求的处理效率,为了解决这个问题,可以通过设置Nginx的连接... 目录设置连接超时目的操作步骤测试连接超时测试方法：总结：设置连接超时目的设置客户端与服务器之间的连接
阅读更多...
mybatis和mybatis-plus设置值为null不起作用问题及解决

mybatis和mybatis-plus设置值为null不起作用问题及解决

《mybatis和mybatis-plus设置值为null不起作用问题及解决》Mybatis-Plus的FieldStrategy主要用于控制新增、更新和查询时对空值的处理策略,通过配置不同的策略类型... 目录MyBATis-plusFieldStrategy作用FieldStrategy类型每种策略的作
阅读更多...
CSS弹性布局常用设置方式

CSS弹性布局常用设置方式

《CSS弹性布局常用设置方式》文章总结了CSS布局与样式的常用属性和技巧,包括视口单位、弹性盒子布局、浮动元素、背景和边框样式、文本和阴影效果、溢出隐藏、定位以及背景渐变等,通过这些技巧,可以实现复杂... 一、单位元素vm 1vm 为视口的1%vh 视口高的1%vmin 参照长边vmax 参照长边re
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2