资料
Scripting/Create modular game architecture in Unity with ScriptableObjects
脚本文档
基础
SO是一个Unity对象,继承UnityEngine.Objec,
SO最大的特点是实例文件可共享,有点类似静态数据,同一个实例文件可被多个对象引用;
实例对象可放置到Inspector窗口(可序列化);
So实例文件保存在项目文件夹中,文件内容格式为yaml;
在编辑器中,当退出播放模式时,对ScriptableObject值的更改不重置。
发布后,运行程序修改SO值,关闭程序后SO值不会保存。重新运行程序,SO值是发布时的状态。
So不仅能包含数据也可以包含方法。
实例化
编辑器中实例化,添加[CreateAssetMenu],右键创建SO实例文件;
运行时创建,ScriptableObject.CreateInstance()。
Mono脚本 Vs So脚本
相同之处
- 继承 UnityEngine.Object
- 可以序列化 显示在Inspector中
不同之处
- Mono脚本接收来自Unity的回调很多;So脚本接收少的Unity回调
- Monobehaviours必须在运行时附加到游戏对象;So脚本不附加在任何游戏对象上
- Mono保存时,保存到场景或预制体中;每个So脚本实例保存在项目文件夹中
- 编辑器中,改变mono脚本的值,离开播放器,数值会重置;
编辑器中,当退出播放模式时,对ScriptableObject值的更改不重置。
So使用
So实例作为数据容器
多个对象共享一份So实例,多个对象共享的数据可提取出来作为so实例,减少重复,节约内存。
可扩展mono脚本,直接在游戏对象上编辑So实例
双重序列化
JSON和XML等文件格式可能很难在编辑器中修改,在Unity外,使用文本编辑都可轻松修改。
SO在Unity中修改容易,Unity外不方便修改。
结合两者特点,可将SO数据存储在JSON中,修改时,直接修改JSON文件;运行时,将json文件转换为SO使用。
观察者模式
利用SO实例共享的特点,结合委托使用。
例如,下面创建了一个无参数无返回值的EventChannel,
新建一份So实例,代表一种委托类型。
需要监听或触发该委托的对象可获取该So实例,监听者注册方法,广播者触发方法。
此外可拓展So脚本,直接触发方法,方便测试。
此外Unity新版输入系统使用的是类似思路。
[CreateAssetMenu(menuName = "Events/Void Event Channel")]
public class VoidEventChannelSO : ScriptableObject
{
public event UnityAction OnEventRaised;
public void RaiseEvent()
{
if (OnEventRaised != null)
OnEventRaised.Invoke();
}
}
Runtime Sets 运行时集合
利用共享的特点,结合Mono脚本使用。
So脚本中定义一个集合,并实现添加和移除集合元素的方法。
Mono获用So实例,添加和移除集合元素。
运行时,即可根据So实例获取集合元素。
注意,So脚本无法在Inspector窗口显示场景中的引用对象(无法序列化场景对象)。
So脚本可正常使用,但显示不正确,集合元素显示为“Type mismatch”。
using System.Collections.Generic;
using UnityEngine;
[CreateAssetMenu(menuName = "GameObject Runtime Set", fileName
= "GORuntimeSet")]
public class GameObjectRuntimeSetSO : ScriptableObject
{
private List<GameObject> items = new List<GameObject>();
public List<GameObject> Items => items;
public void Add(GameObject thingToAdd)
{
if (!items.Contains(thingToAdd))
items.Add(thingToAdd);
}
public void Remove(GameObject thingToRemove)
{
if (items.Contains(thingToRemove))
items.Remove(thingToRemove);
}
}