「宴」実装時に得られたUnityプログラムノウハウ
•
114 likes•64,360 views
AssetStoreで公開中のUnity用ADV制作ツール「宴」 その実装時に得られたUnityプログラムのノウハウのまとめ
Recommended
Recommended
More Related Content
What's hot
What's hot (20)
Viewers also liked
Similar to 「宴」実装時に得られたUnityプログラムノウハウ
Similar to 「宴」実装時に得られたUnityプログラムノウハウ (20)
More from Ryohei Tokimura
「宴」実装時に得られたUnityプログラムノウハウ
- 2. 概要 • Unityにおけるプログラム一般（ C# ） • これが重要！どうやって探して、どこに渡す？ • シリアライズ • コルーチン • エディタ拡張 • より具体的なプログラムについて • 2D • 画面サイズに対応 • プロジェクト設定 • ADVエンジン（シナリオ解析） • エクセルの読み込み • リソースのDLとメモリ管理 • セーブロード
- 10. コンポーネント ならではの使い方
- 11. • 一番素直なのはインスペクターを使う GameManagerと Playerのオブジェ クトが別々の場合 ドラッグ＆ドロップでGameManagerの インスペクターにPlayerを設定してやる
- 13. 他の手段は なにがある？
- 22. ここまでが基本
- 23. もうちょい頑張る
- 24. 遅い処理はキャッシュしよう • FindやGetComponentは遅い 参考 http://docs.unity3d.com/410/Documentation/ScriptReference/index.Performance_Optimization.html プロパティと null 合体演算子を使うと コードがスッキリする！ オススメ！ 一度みつけたら、変数として保存（キャッシュ）しておくと 二回目以降はすぐ呼び出せる
- 25. 遅い処理はキャッシュしよう • Transformは注意 Transformの==はカスタムされているのが原因 参考 http://blogs.unity3d.com/2014/05/16/custom-operator-should-we-keep-it/ this.transformは内部でGetComponentしてるようなので、 処キャッシュしたほうがいい。 ただし、 null 合体演算子だとバグる！ こうする
- 30. • 普通は、メソッドを呼べばいい
- 35. • SendMessage、SendMessage ・・・ 引数をGgamaObjectにすると、「誰から呼ばれたか」 も制約せずに柔軟に使える。 引数をGgamaObject にしても、GetComponentを使 えば、コンポーネントを取得することもできる。 SendMessageからSendMessageを呼ぶことも可能。
- 38. SendMessage GameObjectに対して名前指定で処理を呼ぶ。引数を一つだけ持たせ られる。 • メリット • 名前指定なので、ソースコードを変えずに呼び出し先を変えるのに使える。 • たとえば、「ボタンを押されたら呼び出す処理名」などをインスペクターに登録しやすい。 • 複数のコンポーネントに対しても個別に処理をさせらる。 • BroadCastを使えば子階層のオブジェクトにも処理をさせられる。 • デメリット • 返り値がもてない。 • 複数処理がされる場合は、処理順が制御できない？ • 非アクティブなオブジェクトには使えない。（ので、初期化処理などには使いづらい）
- 39. Func,Actionなどのデリゲード(コールバック) C#の標準的な仕組み。 メリット • 型指定なので、ある程度複雑な処理も安全に使いやすい。 • ロード終了時など、「タイミングが来たらこの処理を呼んで」という形で使える。 • 「追加の独自拡張」を想定する場合にも使える。 • 返り値がもてる • デメリット • プログラムとして記述しなければ使えない。 （SendMessageのように「インスペクター上に記述された文字列の処理を呼ぶ」ということはで きない。）
- 41. シリアライズって？ • Wikiより引用 • コンピュータプログラミングにおいて、シリアライズ、もしくはシリアル 化 (serialize) という用語は、次のような異なる2つの意味を有する。 • ある一つの資源を、複数の主体が利用しようとするときに、それを調 整（同期）して、一つの時点では一つの主体だけがそれを利用する ようにすること。この意味では逐次化という訳語が用いられる。対義 語は並列化である。 • ある環境に存在しているオブジェクトをバイト列やXMLフォーマットに 変換すること。この意味では直列化という訳語が用いられる。同義 語にMarshallingがある。対義語は直列化復元ないしデシリアライズ である。
- 42. Unityのシリアライズ • シーンやプレハブの情報はYAMLという書式で保存している AssetServer使っているなら、 対象のAssetを選択→右クリック→Compare Binary で 中身がみれる。 どこを変えると、どう変わるか見てみるのも一興 参考 http://docs-jp.unity3d.com/Documentation/Manual/FormatDescription.html
- 43. Unityのシリアライズ 基本
- 45. 何がいいことあるの？ • シーンやプレハブ、Assetとしてデータを編集・保存できるようになる • インスペクター上のGUIで編集できるようになるので楽 • シリアライズできない＝Unityエディタ上では扱いづらいと考えてOK 参考 http://docs-jp.unity3d.com/Documentation/ScriptReference/SerializeField.html
- 46. どうすればいい？ • 基本的に対象になるクラスは • MonoBehaviourを継承するクラス（コンポーネント） • ScriptableObjectを継承するクラス • 通常のC#クラスも[Serializable]を使えばOK • 対象になるメンバ変数は • Public • [SerializeField]を適用すれば、privateな型でもOK 参考 http://docs-jp.unity3d.com/Documentation/ScriptReference/SerializeField.html
- 49. 似てるけど違う コンポーネントとScriptableObject • コンポーネント（MonoBehavior） • オブジェクトにアタッチする「機能」 • ScriptableObject • データの塊（独自定義のAsset） • 宴での使用例「ADVのシナリオデータ、フォント定義、描画順定義･･・など」 ・・・という感じで使い分けるとよさげ。 （本来はScriptableObject はUnityの基本データクラスみたいなもの MonoBehabiorやEditorWindowもScriptableObject を継承しているハズ）
- 50. シリアライズのための記述方法まとめ • [Serializable] • 独自定義のクラスをシリアライズ 可能にする • クラスに定義する • C#の標準的な機能 • [SerializeFiled] • 非publicなメンバ変数をシリアライズ の対象にする • 変数に定義する • Unity独自の機能 似てるのでまとめ。 使っていればたぶんすぐ慣れる。 参考 http://docs-jp.unity3d.com/Documentation/ScriptReference/SerializeField.html
- 52. Unityのシリアライズ 一歩先
- 53. Dictionaryのシリアライズ • Unity（というかC#）では、 Dictionaryはシリアライズ不可 （ Dictionaryはジェネリックの入れ子 的な使い方をしているせい。詳細は 割愛） • 使用頻度は高いので、シリアラ イズ可能なDictionaryを作った。 • ただしキーは文字列のみとする 参考ソース Utage¥Scripts¥GameLib¥Dictionary
- 54. ジェネリックのシリアライズ • ジェネリックを使う場合の注意 クラス定義を型ごとにすること MyGenecricClass<int>はダメ class MyGenecricClassInt : MyGenecricClass<int>{} と定義すれば使えるようになる。 参考 http://answers.unity3d.com/questions/214300/serializable-class-using-generics.html
- 55. ネームスペース＆デフォルト引数は禁止 • ネームスペースを使った場合、デフォルト引数を使ったメソッドを持つ クラスはシリアライズができなくなる。 • デフォルト引数は使わないように修正。 • コルーチンにデフォルト引数を使っている場合はちょっと注意。 https://www.facebook.com/groups/unityuserj/permalink/620981311295146/? comment_id=621128654613745&offset=0&total_comments=7 参考 https://www.facebook.com/permalink.php?story_fbid=541323405927604&id=167184853341463 Unity4.5では問題なく使える模様 http://terasur.blog.fc2.com/blog-entry-795.html
- 56. 子 親 親子参照でバグ？ • ScriptableObject内親子構 造にある[Serializable]なク ラスに互いへの参照をも たせた • なぜかUnityエディタがこ とあるごとに遅くなった。 （コンパイルで一分以上 かかる） • アプリの起動時は特に影 響なし。エディタのみ？ 参考ソース Utage¥Scripts¥GameLib¥StringGrid こうすると 妙に重い コールバックで参照する というよくわからない処 理にしたら解消。 Unityのバグ？
- 58. DLL化 • C#のプログラムをDLL化して使うこと ができる。 • 体験版などでコードを隠蔽する場合 や、複数プロジェクトにまたがる共 通ライブラリを作る場合に使える。 参考 http://docs-jp.unity3d.com/Documentation/Manual/UsingDLL.html http://terasur.blog.fc2.com/blog-entry-312.html
- 63. Missingを避けるための、リネームの法則 リネームしていいか？ シリアライズが関係ないクラス名やメンバー名 ○ コンポーネントとScriptableObjectのクラス名 ○ コンポーネントとScriptableObjectの [SerializeField]またはpublicなメンバー変数名 × [Seriazible]なクラス名 × [Seriazible]なクラスの[SerializeField]またはpublicなメンバー変数名 × 基本的にシリアライズが絡むなら、コンポーネントとScriptableObjectのクラス名以外は変えてはいけない。 それ以外は、リネームするとシーンやプレハブに設定された値は初期値にリセットされる。 シーンやプレハブに設定された値を残したまま、インスペクター上の表示名だけ変えたい場合は エディタ拡張をするしかない。 シーンやプレハブに設定せずに、AddComponentなどで動的に生成する場合は、リネームしてもOK （シーンやプレハブに設定されたメタデータの問題なので･･･）
- 66. コルーチン ～ その裏技 ～
- 67. コルーチンからコルーチンを呼ぶ void Load() { StartCoroutine( CoLoad ()); } IEnumerator CoLoad() { yield return StartCoroutine(CoLoadSub1()); yield return StartCoroutine(CoLoadSub2()); } IEnumerator CoLoadSub1() { yield return new WWW(url1); } IEnumerator CoLoadSub2() { yield return new WWW(url2); } コルーチン内部で yield return StartCoroutine() とする。 この例では → CoLoadSub1()が終わってから、 CoLoadSub2()が始まる
- 68. コルーチンをMonovehavior以外で使う裏技 public class MainClass : MonoBehaviour { SubClass sub = new SubClass(); void Load1() { StartCoroutine(sub.CoLoad1()); } void Load2() { StartCoroutine(sub.CoLoad2(this)); } } //コルーチンをもつ通常のクラス public class SubClass { //コルーチン public IEnumerator CoLoadSub1() { yield return new WWW(url1); } //コルーチン内部でStartCoroutineを使うには、MonoBehaviourを渡す public IEnumerator CoLoadSub2(MonoBehaviour parent) { yield return parent.StartCoroutine(CoLoadSub1()); yield return new WWW(url2); } } StartCoroutineはMonovehaviorからしか呼べ ない。 IEnumerator で宣言するコルーチン自体 は通常のC#のクラスでもOK。 その内部でさらにStartCoroutineをした いなら、Monobehaviorを渡してやるとい う手もある。
- 69. 止め方に注意 • StopAllCoroutinesを呼んでも、 呼び出したコルーチンはそのフ レームの最後までは動くので 注意。 IEnumerator CoLoadSub2() { while(true) { if(isEnd) { StopAllCoroutines(); //ここで止めても } Debug.Log("!"); //ここは呼ばれる yield return 0; } }
- 71. OnValidateが便利 /// <summary> /// インスペクターから値が変更された場合 /// </summary> void OnValidate() { dataTbl.RefreshDictionary(); } リファレンス http://docs-jp.unity3d.com/Documentation/ScriptReference/MonoBehaviour.OnValidate.html インスペクターのエディタ拡張をせずに、 インスペクターで値が変えられたときの 操作を記述できる。 簡単な処理ならこれでOK 参考ソース Utage¥Scripts¥GameLib¥CustomProjectSetting¥Node2DSortData.cs
- 72. OnValidate ＋MarkAsChangedパターン 参考ソース Utage¥Scripts¥GameLib¥2D¥2D¥Node2D.cs /// <summary> /// インスペクターから値が変更された場合 /// </summary> protected virtual void OnValidate() { MarkAsChanged(); } /// <summary> /// 毎フレームの最後の更新 /// </summary> protected virtual void LateUpdate() { if ( CachedTransform.parent != lastParent || hasChanged ) {//構造に変化があった Refresh(); } } インスペクターでの変更だけなく、 ・スクリプト内部からのsetなどで変更されうる ・パラメーターが多く、かつ更新による負荷が大きい など、ある程度複雑になる場合は 「変更があった」というフラグのみ設定して、 LateUpdateやUpdateでチェックして一度だけ変更す るという手もある。
- 73. EditorGUILayout.PropertyFieldを使うと楽 参考ソース Utage¥Editor¥Scripts¥Inspector UtageEditorToolKit.PropertyField(serializedObject, "engine", "Engine"); UtageEditorToolKit.PropertyField(serializedObject, "isAutomaticPlay", "Is Automatic Play"); UtageEditorToolKit.PropertyField(serializedObject, "startScenario", "Start Scenario Label"); public static void PropertyField(SerializedObject serializedObject, string propertyPath, string label, params GUILayoutOption[] options) { SerializedProperty property = serializedObject.FindProperty(propertyPath); if (property == null) { Debug.LogError(propertyPath + " is Not Found"); } else { EditorGUILayout.PropertyField(property, new GUIContent(label), options); } } メンバ変数名 インスペクターに表示する名前 EditorGUILayout.PropertyFieldを使 うと、stringやMonobehavior、 Vector3、enumなどの型によらず 適切なGUIで表示してくれる。 細かい制限をかけない（エディタ 拡張しないでよい）パラメーターに 関してはこれで書いたほうが楽 エディタ拡張をする場合でも、なるべく簡単に書く。
- 74. Property Drawerを使う リファレンス http://docs-jp.unity3d.com/Documentation/Components/editor-PropertyDrawers.html 参考ソース Utage¥Editor¥Scripts¥Attribute¥EnumFlagsAttributeDrawer.cs EnumFlagsという、フラグを表示する Property Drawerを作成しておく こう書くと [System.Flags] enum DebugOutPut { Log = 0x01, Waiting = 0x02, CommandEnd = 0x04, }; [SerializeField] [EnumFlags] DebugOutPut debugOutPut = 0; Property Drawerを使うと、コンポーネ ントごとにエディタ拡張をしなくても、 特定の表示パターンを指定できる。 Enumとして表示さ れてしまう フラグ操作に適したUIで表示
- 75. より具体的な プログラム
- 89. 共通で使う値を、一元管理したい • ゲーム内で共通で使うデータを一元管理したい • 描画順のテーブル • ローカライズ用のキーワード • エディタ上からもいつでもロードして使いたい
- 90. 共通で使う値を、一元管理したい 参考ソース Utage¥Scripts¥GameLib¥CustomProjectSetting カスタムプロジェクト 設定を作って 起動時に読み込むようにした
- 91. しかし、どうにもバグというかスッキリしない まだ検討の余地あり • 課題 • カステムプロジェクト設定といってもプロジェクト内に必ず一つと決められない。 ツールとして提供するときは、サンプル設定データが必要になる 多言語対応も考えると、もっとややこしかったり • エディタ中でも参照するためシーンを開いていないときですら、参照したい。 • 色々やり方はあるが、（初回起動時など）どうしても読み込めないときが出てきてしまう。 • この辺のノウハウが欲しい・・・
- 95. Npoi使えば楽 • 各Cellの文字列を読み 込むのは楽 • あとは文字列を解析す るだけ 参考 http://terasur.blog.fc2.com/blog-entry-511.html 参考ソース Utage¥Assets¥Utage¥Editor¥Scripts¥ExcelParser.cs
- 102. 実際にはもう少し複雑 • ジャンプ命令や、既読スキップ、シーン回想への対応など • 特にセーブがらみはわりと面倒。 • 「いつでもセーブできる」とした場合、演出の途中でセーブロードするのが凄 く大変 • シーンの冒頭など「セーブポイント」でしかセーブできない代わりに、「動的な 演出に凝れるモード」もあったほうがいいかも？ • 動的な演出についてはこのまとめがわかりやすい http://www.slideshare.net/tunacook/ss-35094307
- 103. オートセーブ • 基本は改ページの直後の状態をセーブデータとして記録し ておく • スプライトやサウンドなど、「シーンのそのときの状態」をセーブ データとして利用する。 • わりと簡単に作れる。 • コマンドを追加拡張するごとにセーブデータの拡張も必要になる可能性 がある。 • 宴ではこっちを採用 • これとは別に、シナリオのページラベルをキーにして、「そのページ の状態」をシナリオデータから再現できるようにするという手もある。 • こっちは難しいが、柔軟に使えるという利点もある。 • コマンドを拡張しても、セーブデータ自体はいじらないですむ場合もある IOの仕組みは後述
- 105. リソースのロード • ロード待ちを減らすため、あらかじめ素材をロードする • 今のコマンドだけではなく、この先数ページぶんのコマンドのロードだけ先に やっておく。（いわゆる裏読み・バックグラウンドロード） • これがADVエンジン制作の一番難易度が高いポイント･･･と思ってる • UnityではResouces.Loadが同期しかなかったり、ロード後のリソース の初期化とかは同期だったりするので、実際はどうしてもロードによ る処理落ちができる。
- 107. 「宴」のAssetファイルマネージャー • 目標 • ダウンロード機能をつける • AssetBundleを使わない（UnityBasicで動くようにする） • なるべく早くロードする • 必要以上のメモリを使わない 参考ソース Utage¥Scripts¥GameLib¥File¥AssetFileManager.cs
- 109. ファイルロードの課題 • Resouces.Loadは？ • ダウンロードできない • アプリサイズが増える • リソースの修正にはアプリ自体のアップデートが必要になる • AssetBundleは？ • UnityProじゃないとAssetBundleの作成ができない • Unityのアップデートによっては、過去のAssetBundleと互換性が取れない • サウンドのStream再生ができない。（メモリ消費が大きい） • WWWは？ • 毎回ダウンロードすることになる 参考ソース Utage¥Scripts¥GameLib¥File¥AssetFileWork.cs
- 110. 「宴」のAssetファイルマネージャー • 目標 • WWWとResoureces.Load両方でロードできるようにする • ロード＆メモリ管理機能をつける • WWWでロードする場合はキャッシュ機能をつける • 一度DLしたファイルはキャッシュファイルとして保存・再利用する • ロードした後のリソースはプール機能をつけて管理する • 一度ロードしたAssetは、メモリ内に残しておいて再利用する • メモリ不足になったら、使っていない古いAssetをアンロードする 参考ソース Utage¥Scripts¥GameLib¥File¥AssetFileWork.cs
- 111. デバイスキャッシュ 参考ソース Utage¥Scripts¥GameLib¥File¥AssetFileManager.cs Tool>Utage>Open Output Foloder>Cache キャッシュファイルを保存しているフォルダ が開く キャッシュファイルは連番でファイル名がつく。 そのリソースがバージョンアップしたら、新し いファイルを書き込んで、古いファイルは消 す。 WebPlayerではファイルIOができないので、 キャッシュ機能は実装できない
- 113. • 目的は、LoadFromCacheOrDownload と殆ど同じ • つまり、ファイルのバージョン管理つきのDLとローカルへの保存 • ただし、アセットバンドルではなく.pngや.wavなど汎用的なファイルを扱う • メリット • アセットバンドル化しないので、pngなどはサイズが小さいままDLできる • Unityのバージョンアップに左右されない • →アセットバンドルはUnityのバージョンアップでDLしなおしになる可能性がある • デメリット • 今のところアセットバンドルに未対応 • つまり、3DモデルなどはDLできない • 将来的にはアセットバンドルも併用したいけど検討中。 デバイスキャッシュ 参考ソース Utage¥Scripts¥GameLib¥File¥AssetFileManager.cs
- 119. けっこう作るのは面倒
- 122. PlayerPrefsは手軽だけど、柔軟には使いづ らい・・・ • 大規模になると管理がつらい • 数が少ないうちはいいが、セーブする要素が増えたりすると困る • サイズ可変の配列だったり、セーブデータを複数もったり･･･ • 遅いとか、レジストリをいじるとか、困る面もある。
- 123. C#のシリアライズは･･･iOSで使えない • セーブデータはやはりバイナリで作りたいところだが・・・ • C#のクラスを自動でバイナリ化してくれるBinaryFormatter を使う？ 参考ソース http://forum.unity3d.com/threads/140606-iOS-Basic-BinaryFormatter public static void SaveToBinaryFile(object obj, string path) { FileStream fs = new FileStream(path, FileMode.Create, FileAccess.Write); BinaryFormatter bf = new BinaryFormatter(); //シリアル化して書き込む bf.Serialize(fs, obj); fs.Close(); } iOSでは使えない （使える場合もあるようだが、 非常に限定的なので非対応 と思ったほうがいい）
- 124. バイナリデータを作成 • BinaryReader＆ BinaryWriterで手作業でバイナリ化処理を • コードを書くのは面倒だけど、バージョンアップ対応など細かい融通は利く 参考ソース Utage¥Scripts¥ADV¥Save¥AdvSystemSaveData.cs
- 127. その他のプラグラム紹介
- 129. 構文解析 • ADVを作るためには 「構文解析」が色々必要になる • <Color>タグつきのテキスト • “Point+=1”という「文字列」を数式として処理したり • その他いろいろ 詳しくはソースを確認してほしい