冬天吃雪糕的博客

Unity 数据容器类 ScriptableObject

冬天吃雪糕2022年9月15日
大约 7 分钟

Unity 数据容器类 ScriptableObject

参考资料

Unity进阶：ScriptableObject使用指南_YY-nb的博客open in new window

ScriptableObject

在游戏的开发过程中，我们经常需要跟数据打交道，尤其是为游戏对象配置数据。

假设现在要做一个“打飞机”的游戏，玩家操控的飞机在吃了不同道具后会发射不同类型的子弹，这些子弹的飞行速度和伤害各不相同。那么显然我要为每一种子弹配置好它的属性值。

实现方式有很多，比如可以为每种子弹创建预制体，然后通过脚本的成员变量来定义子弹的各个属性。为了方便配置和调试，还需要把这些变量设置为 public，以便在 Inspector 面板中对数据进行改动。

这么做主要有以下缺点：

  1. 每次实例化子弹预制件的时候，都会产生单独的数据副本。实际上在绝大多数情况下，同一种子弹的属性数据应该是相同的，因此这些同样的数据副本是多余的，造成内存浪费。
  2. 如果我们在运行模式下修改子弹的数据，那么在退出游戏后会还原。
  3. 数据无法持久化存储，难以在项目之间、场景之间共享。

为了解决这样的问题，Unity 提供了一个专门用于独立存储大量数据的基类ScriptableObject。

  • ScriptableObject是一个基类，继承自UnityEngine.Object，因此我们在使用时要自定义类来继承它。要注意的是，与MonoBehaviour不同，不能将ScriptableObject挂载到游戏对象上。
  • 多个对象共用相同的数据时，可以使用同一个ScriptableObject实例，共用一份数据。
  • ScriptableObject类的实例会被保存成资源文件（.asset文件），和预制体、材质球、音频文件等类似，存放在 Assets 文件夹中。因此可以持久化存储，并在项目之间、场景之间共享。
  • 在运行模式下修改ScriptableObject实例的数据，在游戏推出后也会被保存下来（毕竟其实是在修改资源）。

注意

在 Editor 中，可以在编辑模式或运行模式下修改ScriptableObject实例的数据，修改的结果会保存在磁盘上，实现持久化存储。但是在发布构建后运行时，即使在游戏过程中修改了ScriptableObject实例的数据，也不会保存在本地，重新打开运行时还是配置的初始数据。

因此ScriptableObject适合使用在开发期间配置和调试数据。

创建 ScriptableObject

继承 ScriptableObject 声明自定义数据容器类

首先我们要创建一个脚本继承自ScriptableObject类，并在该类中声明成员，这些成员表示该数据容器需要保存哪些数据。为了后续在 Inspector 面板中可以看到这些数据，需要将它们声明为 public。

public class BulletDate : ScriptableObject
{
    public float speed;
    public float damage;
}

为数据容器类添加创建实例（.asset数据资源文件）的方法

上一节中声明的数据容器类相当于一个数据的模板，接下来就要根据这个模板创建具体的数据。因为这个模板是类，所以具体的数据文件其实就是实例。由于数据文件在 Editor 中是以资源的形式存在的，因此一般也使用类似于创建其他资源（材质球、动画等）的方式来创建数据资源文件。

为此需要CreateAssetMenu属性。

[CreateAssetMenu(fileName = "BulletDate", menuName = "ScriptableObjects/BulletDate", order = 1)]
public class BulletDate : ScriptableObject
{
    public float speed;
    public float damage;
}
  • fileName 表示创建的数据文件默认文件名为 BulletDate
  • menuName 表示会在 Assets/Create 菜单下增加 ScriptableObjects/BulletDate 的选项
  • order 表示该选项的排序（从0开始）

现在通过 Editor 的 Assets/Create 菜单（可以通过上方菜单栏的 Assets 或者在 Project 面板右键等方式访问）找到 ScriptableObjects/BulletDate，点击该选项后，就会创建一个数据资源文件。选中该文件，就可以在 Inspector 面板中配置数据了。

使用 ScriptableObject

在创建好数据资源文件后，我们就可以像使用其他资源文件一样使用它。

例如在不使用ScriptableObject的时候，在子弹预制体上可能挂载着这样的脚本:

public class Bullet : MonoBehaviour
{
    public float speed;
    public float damage;

    void Update() {
      // 通过成员变量直接访问子弹的属性数据
    }
}

使用ScriptableObject之后就改成这样：

public class Bullet : MonoBehaviour
{
    public BulletDate bulletDate;

    void Update() {
      // 通过 bulletDate 访问子弹的属性数据
    }
}

然后在 Inspector 面板中将创建好的数据资源文件拖拽赋值给 bulletDate 即可（注意是数据资源文件，而不是数据容器类脚本）。

实现非持久化数据

通过上面的介绍，我们知道了ScriptableObject可以实现数据持久化，只要我们在 Editor 中手动创建了一个数据资源文件，就相当于在磁盘中真正创建了一个文件。

但是在有些时候，我们只是希望运行期间在内存中临时生成一组共用的数据，退出游戏后就可以释放掉生成的数据资源。例如在游戏过程中根据环境因素临时生成一种子弹。

此时可以利用ScriptableObject类中的静态方法CreateInstance<>()，该方法可以在运行时创建出指定的ScriptableObject子类的实例，该实例只存在于内存中。

public class Bullet : MonoBehaviour
{
    public BulletDate bulletDate;

    void Start() {
      bulletDate = ScriptableObject.CreateInstance<BulletDate>();
      bulletDate.speed *= 0.5f;
      bulletDate.damage *= 2;
    }
}

使用 ScriptableObject 配置事件

除了配置数据属性外，有时候还需要配置自定义事件。还是以子弹为例子，不同类型的子弹在命中时可能有不同的效果，可能是造成伤害，附加异常状态等。虽然通用的效果可以使用参数化的方式来配置，但还是避免不了要自己写方法。这时候就需要在子弹的数据资源文件上绑定方法，然后在游戏对象就可以通过访问该资源文件来调用它。

根据目前查到的资料，只能通过反射来实现。

[CreateAssetMenu(fileName = "BulletDate", menuName = "ScriptableObjects/BulletDate", order = 1)]
public class BulletDate : ScriptableObject
{
    public float speed;
    public float damage;
    public string impactName;
}





 

在ScriptableObject中增加一个字符串类型的属性，用来存储执行具体方法的类名。

之后定义一个接口，在其中定义要调用的方法

public interface IImpact
{
    void Execute(BulletDate bulletDate, GameObject target);
}

之后根据需求编写实现该接口的类，注意类名要和BulletDate.impactName的字符串一致。

例如有如下的Blaster类，则在BulletDate的impactName处也要填写 "Blaster"(区分大小写)。

public class Blaster : IImpact
{
    public void Execute(BulletDate bulletDate, GameObject target)
    {
        // do something here
        print("Blaster execute");
    }
}

然后利用 C# 的反射来创建指定类的实例。

public class Bullet : MonoBehaviour
{
    public BulletDate bulletDate;
    public IImpact impact;

    void Awake() {
      Type type = Type.GetType(bulletDate.impactName);
      impact = Activator.CreateInstance(type) as IImpact;
    }

    void OnBulletHit(GameObject target) {
        impact.Execute(target);
    }
}

上面的例子可以工作，但是会导致一个问题，现在每一个子弹 Bullet 实例都会持有一个 IImpact 的实例。因为该效果是与数据资源文件相关的，数据资源文件是唯一的，那 IImpact 实例也应该是唯一的，而这个实例应该由数据资源文件（ScriptableObject实例）来持有。

根据这个思路，可以将上面的代码做一些改造。

[CreateAssetMenu(fileName = "BulletDate", menuName = "ScriptableObjects/BulletDate", order = 1)]
public class BulletDate : ScriptableObject
{
    public float speed;
    public float damage;
    public string impactName;

    private IImpact _impact;
    public IImpact impact
    {
        get {
            if (_impact == null) 
            {
                Type type = Type.GetType(impactName);
                _impact = Activator.CreateInstance(type) as IImpact;
            }
            return _impact;
        };
    }
}

public class Bullet : MonoBehaviour
{
    public BulletDate bulletDate;

    void OnBulletHit(GameObject target) {
        bulletDate.impact.Execute(target);
    }
}

从上面的代码可以看出，由于ScriptableObject其实也是一个 C# 类，所以自然也可以在其中编写自定义的变量、属性和方法。此外和MonoBehaviour类似，ScriptableObject也有其生命周期中自动调用的事件函数，例如Awake、OnEnable、OnDestroy等，但比MonoBehaviour要少很多。

经过上面的改造之后，现在每一个子弹 Bullet 持有的都是同一个 bulletDate 实例，而该 bulletDate 实例持有一个 IImpact 实例，在 Bullet 的代码中可以访问并调用 IImpact 的方法。

上次编辑于: 2022/9/30 06:22:57
贡献者: WingSnow
Copyright © 2022 冬天吃雪糕