Unity3D之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); } }
掛到攝像機就行了,我們看看結果:
資料正確沒問題。
Asset檔案
等等,我們好像忘了啥,創建出的Asset檔案有啥用呢,我們點選該檔案可以直接在Inspector視窗直接編輯!
這個絕了,策劃直接連Excel啥別的配置工具都不需要,用Unity就可以直接編輯和配置了,不過唯一的缺點就是打出來的資料也就Unity能用了,其它語言比如後臺要使用得先弄清楚Asset檔案的資料結構才行(後臺總不能用Unity寫吧)。
總結
優點
- 除了支援float、int、string等常見的型別外,還支援List等複雜資料型別,最重要的支援Unity的Vector3等資料;
- 創建出來的檔案可以直接在Unity中編輯;
缺點
- 其它語言要解析資料需要了解詳細的格式,而且要花時間編寫解析程式碼;
- 對於大量的資料還是Excel用起來舒服一點;
- 我要是配置表的結構改變了,asset檔案中填好的資料是不是就要報廢了?
使用方式
我認為有兩種使用方式:
- 使用Excel啥的進行配置,儲存為csv,打包資料時讀取csv表的資料填充asset檔案;
- 建立空的asset檔案直接在Unity中編輯;
天道酬勤,功不唐捐!