ScriptableObject学习笔记

不同与C#提供的Serializable序列化功能,ScriptableObject是Unity3D提供的一个数据存储类,我们接下来学习一下这个类的功能。

官方文档

http://docs.unity3d.com/Manual/class-ScriptableObject.html
http://docs.unity3d.com/ScriptReference/ScriptableObject.html

使用情景

在Unity3D中,我们记录游戏的配置数据可以使用文件文件(XML、JSON等格式),也可以使用二进制文件(自定义格式),两种方式都需要自己进行解析,而Unity比较贴心,为我们提供了另外一种格式的数据记录方式,就是ScriptableObject。

简单的示例

下面我们来看一个简单的示例。

首先我们需要创建记录配置的类,如下:

ShopConfig,这个类是会被作为配置数据打包到AssetBundle中的类,所以必须要继承自ScriptableObject,同时要注意文件名必须和类名一致:

using System.Collections.Generic;
using UnityEngine;

/// <summary>
/// 商品配置表.
/// </summary>
public class ShopConfig : ScriptableObject
{
    /// <summary>
    /// 商品页签枚举.
    /// </summary>
    public enum ShopTag
    {
        hot,
        item,
        weapon
    }

    /// <summary>
    /// 商品列表.
    /// </summary>
    public List<ShopListInfo> ShopList;
}

ShopListInfo,这个类被ShopConfig引用也会被打包到AssetBundle中,但是其不会作为打包的数据类型所以不用继承ScriptableObject,但是必须添加[System.Serializable]的Attribute:

using System.Collections.Generic;

/// <summary>
/// 指定页签的商品列表.
/// </summary>
[System.Serializable]
public class ShopListInfo
{
    /// <summary>
    /// 页签.
    /// </summary>
    public ShopConfig.ShopTag tag;

    /// <summary>
    /// 商品列表.
    /// </summary>
    public List<ShopItemInfo> list;
}

ShopItemInfo,同上:

/// <summary>
/// 商品.
/// </summary>
[System.Serializable]
public class ShopItemInfo
{
    /// <summary>
    /// 名称.
    /// </summary>
    public string name;

    /// <summary>
    /// 价格.
    /// </summary>
    public int price;
}

下面我们要创建用于打包的脚本:

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

public class CreateConfig
{
    [MenuItem("Tools/CreateConfig")]
    private static void Create()
    {
        CreateShopConfig();
    }

    private static void CreateShopConfig()
    {
        ShopConfig shopConfig = ScriptableObject.CreateInstance<ShopConfig>();

        //填充数据, 可以从外部有策划配置好的配置表(如CSV、XML、JSON甚至是二进制文件)中通过通用代码读取所有数据来进行填充
        //这里只是测试就直接手写了(⊙﹏⊙)b

        shopConfig.ShopList = new List<ShopListInfo>();

        ShopListInfo list = new ShopListInfo();
        list.tag = ShopConfig.ShopTag.hot;
        list.list = new List<ShopItemInfo>();
        list.list.Add(new ShopItemInfo { name = "优你弟内裤", price = 10000 });
        list.list.Add(new ShopItemInfo { name = "扣扣死内裤", price = 5000 });
        list.list.Add(new ShopItemInfo { name = "内裤", price = 100 });
        shopConfig.ShopList.Add(list);

        list = new ShopListInfo();
        list.tag = ShopConfig.ShopTag.item;
        list.list = new List<ShopItemInfo>();
        list.list.Add(new ShopItemInfo { name = "金疮药", price = 250 });
        list.list.Add(new ShopItemInfo { name = "和合散", price = 500 });
        shopConfig.ShopList.Add(list);

        list = new ShopListInfo();
        list.tag = ShopConfig.ShopTag.weapon;
        list.list = new List<ShopItemInfo>();
        list.list.Add(new ShopItemInfo { name = "轩辕剑", price = 1 });
        list.list.Add(new ShopItemInfo { name = "桃木剑", price = 5 });
        list.list.Add(new ShopItemInfo { name = "小李飞刀", price = 213 });
        list.list.Add(new ShopItemInfo { name = "大李飞刀", price = 313 });
        shopConfig.ShopList.Add(list);

        //填充好数据后就可以打包到 AssetBundle 中了
        //第一步必须先创建一个保存了配置数据的 Asset 文件, 后缀必须为 asset
        AssetDatabase.CreateAsset(shopConfig, "Assets/ShopConfig.asset");

        //第二步就可以使用 BuildPipeline 打包了
        BuildPipeline.BuildAssetBundle(null, new[]
            {
                AssetDatabase.LoadAssetAtPath("Assets/ShopConfig.asset", typeof(ShopConfig))
            },
            Application.streamingAssetsPath + "/Config.assetbundle",
            BuildAssetBundleOptions.CollectDependencies | BuildAssetBundleOptions.CompleteAssets | BuildAssetBundleOptions.UncompressedAssetBundle,
            BuildTarget.StandaloneWindows64);
    }
}

我们运行一下,就可以打包出AssetBundle了,这里要注意两点:

继承自ScriptableObject的类不能使用new来创建,要使用ScriptableObject.CreateInstance<T>()方法来创建;
必须先创建对应的Asset文件才能打包,同时Asset文件的后缀必须是asset,否则Unity不能识别;
打包好了,我们弄个脚本加载看看,如下:

using UnityEngine;
using System.Collections;

public class TestScript : MonoBehaviour
{
    void Start()
    {
        AssetBundle assetBundle = AssetBundle.CreateFromFile(Application.streamingAssetsPath + "/Config.assetbundle");

        ShopConfig shopConfig = assetBundle.Load("ShopConfig", typeof(ShopConfig)) as ShopConfig;
        Debug.Log(shopConfig.ShopList.Count);
    }
}

挂到摄像机就行了,我们看看结果:

image

数据正确没问题。

Asset文件

等等,我们好像忘了啥,创建出的Asset文件有啥用呢,我们点击该文件可以直接在Inspector窗口直接编辑!

image

这个绝了,策划直接连Excel啥别的配置工具都不需要,用Unity就可以直接编辑和配置了,不过唯一的缺点就是打出来的数据也就Unity能用了,其它语言比如后台要使用得先弄清楚Asset文件的数据结构才行(后台总不能用Unity写吧)。

总结

优点

  1. 除了支持float、int、string等常见的类型外,还支持List等复杂数据类型,最重要的支持Unity的Vector3等数据;
  2. 创建出来的文件可以直接在Unity中编辑;

缺点

  1. 其它语言要解析数据需要了解详细的格式,而且要花时间编写解析代码;
  2. 对于大量的数据还是Excel用起来舒服一点;
  3. 我要是配置表的结构改变了,asset文件中填好的数据是不是就要报废了?

使用方式

我认为有两种使用方式:

  1. 使用Excel啥的进行配置,保存为csv,打包数据时读取csv表的数据填充asset文件;
  2. 创建空的asset文件直接在Unity中编辑;
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,293评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,604评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,958评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,729评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,719评论 5 366
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,630评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,000评论 3 397
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,665评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,909评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,646评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,726评论 1 330
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,400评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,986评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,959评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,197评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,996评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,481评论 2 342

推荐阅读更多精彩内容

  • 最近网友通过网站搜索Unity3D在手机及其他平台下占用内存太大. 这里写下关于unity3d对于内存的管理与优化...
    杨树叶的杨阅读 1,061评论 0 0
  • 首先附上原文链接:https://unity3d.com/cn/learn/tutorials/topics/be...
    Bonging阅读 764评论 0 0
  • 1、什么是AssetBundle AssetBundle 是Unity pro提供的一种用来存储资源的文件格式,它...
    好怕怕阅读 7,498评论 1 8
  • 翻译:莫铭原文地址:AssetBundle usage patterns 本系列中的上一篇文章覆盖了AssetBu...
    莫铭阅读 5,220评论 1 12
  • Unity3D 里有两种动态加载机制:一个是Resources.Load,另外一个通过AssetBundle,其实...
    IongX阅读 1,724评论 0 5