Unity使用ScriptableObject配置数据
如何使用
先看下效果:
只需要定义单行数据结构如下:
数据结构定义就能获得如下的效果
运行效果达到的效果:
1. 单项配置可以收缩成一行,显示id和注释信息方便查找,又能显示尽量多的信息。
2. 自定义显示属性名,还可以根据前面的值显示不同的属性名。
3. 支持下拉框和数值区域限定。
4. 由attribute指定这些特性,不影响代码逻辑与美观。
5. 支持运行时修改属性(这是ScriptableObject自带特性,油管上有个解释ScriptableObject替代MonoBehaviour的很好的视频)。
6. 自动生成Editor代码。
优势与劣势
一般的游戏项目配置数据都是csv或xlsx。借助于Excel工具来配置,优势是行列结构明显。劣势是不方便验证数据类型,不方便添加内部数组结构,也不方便显示数值范围;而且要编写专门的代码来读取数据(即使能自动生成也颇为麻烦);依赖外部工具不方便而且不方便转化为lua这样的可更新资源。
用ScriptableObject配置这些问题都没有。可以使用C#的反射把任何数据类型转化为lua配置数据方便更新。
这个还是有劣势的:如果已有数据配置项,这时候又要修改数据结构,就只能去修改asset文件。
实现方式
这个借鉴了xlua中生成C#代码的方式。编写一种tpl文件。这种文件是由3中文件片段组成:
1. 普通的文本片段最终会直接变成C#代码片段
2. <%=lua_val%>这是lua_val被包裹的赋值片段,lua_val在lua执行时的值会直接复制到C#代码片段中来。
3. <%lua_run_code%>(注意没有'=')这是被包裹起来的lua执行代码。本身不会复制进C#代码片段。
依照这种方式写的代码生成模板,简单直观和最终生成的代码结构一致,缩进也一致。非常巧妙。
然后通过反射获取字段的attribute来生成Editor。
已发布在github上。