【Unity】使用ScriptableObject存储数据

news2024/11/18 19:31:10

1.为什么要用ScriptableObject？

在游戏开发中，有大量的配置数据需要存储，这个时候就需要ScriptableObject来存储数据了。
很多人会说我可以用json、xml、txt，excel等等
但是你们有没有想过，假设你使用的是json，那你在加载json后，还要去解析，还需要把它转换为合适的数据结构。
但是ScriptableObject就可以“免”去这一步，因为我可以把配置数据解析放在游戏启动之前。
而且ScriptableObject可以添加一些自定义的方法，十分方便。

2.什么是 ScriptableObject？

ScriptableObject 是一个类，继承自 UnityEngine.Object 。要想使用它，需要我们写个脚本去继承。
ScriptableObject 类的实例会被保存为资源文件（.asset文件），和其他预制体、材质球、图片等文件类似。如下图
在这里插入图片描述

3.如何创建 ScriptableObject？

①声明自定义的数据容器
新建一个脚本ItemData.cs，继承 ScriptableObject，然后声明成员。

using System.Collections;
using System.Collections.Generic;
using UnityEngine;

public class ItemData : ScriptableObject
{
    //道具ID
    public int id;
    //道具名称
    public string strName;
    //道具图标
    public string icon;
    //道具类型
    public int type;
}

②创建数据文件
方法一：为类添加 CreateAssetMenu 特性

[CreateAssetMenu(fileName = "ItemData", menuName = "ScriptableObject/道具数据", order = 0)]

在这里插入图片描述点击文件夹空白处，选择创建

在这里插入图片描述 方法二：静态方法创建数据对象
新建一个EditorTool 脚本。不用继承 MonoBehavoiur，也不用挂载到游戏物体上。
引入 UnityEditor 命名空间：
需要特别注意：引入 UnityEditor 命名空间的脚本，必须放入任意一个命名为“Editor”的文件夹下，以便打包过滤

using UnityEngine;
using UnityEditor;
public class EditorTool  
{
    [MenuItem("Tool/创建道具数据")]
    public static void CreateMyData()
    {
        //得到需要创建的数据结构类型
        ItemData asset = ScriptableObject.CreateInstance<ItemData>();
        //创建一个数据资源文件，第二个参数为存储路径
        AssetDatabase.CreateAsset(asset, "Assets/Resources/Data/ItemData.asset");
        //保存创建的资源
        AssetDatabase.SaveAssets();
        //刷新界面
        AssetDatabase.Refresh();
    }
}

此时在菜单栏可以看到多了刚刚定义的按钮，点击即可创建
在这里插入图片描述
创建完就长这样，刚刚申明的成员也到可以看到。

4.项目中的 ScriptableObject

ScriptableObject已经创建完毕了，但实际开发中，数据结构可能很复杂，所以都会根据不同的功能，有所改变。
①比如，这是一个存储地形数据的配置，那么数据量就可能非常大，可能有几万行。这时候我们可以加HideInInspector来隐藏面板显示。隐藏的好处是选择当前配置不卡顿，不然数据多，选中会非常卡。

[HideInInspector]
public int[] data;

②嵌套使用，正常的配置可能都是数组，那可能就需要使用如下这种结构了

using UnityEngine;
 
public class ItemData : ScriptableObject
{
    public Item[] list;

}
[System.Serializable]
public class Item
{
    //道具ID
    public int id;
    //道具名称
    public string strName;
    //道具图标
    public string icon;
    //道具类型
    public int type;

    [HideInInspector]
    public int[] data;
}

③封装一些方法，方便其他功能使用

public class ItemData : ScriptableObject
{
    public Item[] list;

    //根据道具ID获取数据
    public Item GetSheet(int id)
    {
        for (int i = 0;i < list.Length;i++)
        {
            if (list[i].id == id)
            {
                return list[i];
            }
        }
        return null;
    }
}
[

5.加载 ScriptableObject

    void Start()
    {
        string path = "Data/ItemData";
        Object obj = Resources.Load(path, typeof(ScriptableObject));
        if (obj != null)
        {
            ItemData mItemData = obj as ItemData;
        }

    }