宴のParameterデータをローカルセーブ・ロードする機能の実装例

　宴アセットにおいて保存されている Parameter データをローカルセーブ・ロードする方法です。
Parameter を保持しておくことができれば、Unity 側に変数を用意しなくてもフラグなどの管理が行えます。

利用する機能

　
　Parameter データをローカルセーブ・ロードには、宴の用意している AdvEngine ゲームオブジェクトにアタッチされている AdvSaveManager クラスの機能を利用します。

参考サイト
Unity用ビジュアルノベルツール「宴」
Adv Save Manager

宴の AdvEngine 管理クラス

　宴のサイトに提示されているサンプルコードをベースにしたクラスの作成例です。
ここではゲームの開始時に、宴の起動を待ってから、Parameter の情報を取得するようにロジックを組んでいます。

SampleAdvEngineController.cs

<= クリックすると開きます。

using System;
using System.Collections;
using UnityEngine;
using Utage;

public class SampleAdvEngineController : MonoBehaviour {

    // ADVエンジン
    public AdvEngine AdvEngine { get { return advEngine; } }
    [SerializeField]
    protected AdvEngine advEngine;

    //再生中かどうか
    public bool IsPlaying { get; private set; }

    float defaultSpeed = -1;

    /// <summary>
    /// Debug 用
    /// </summary>
    /// <returns></returns>
    IEnumerator Start() {

        // AdcEngine の準備が整うまで待機する必要があるので、非同期処理で実行する
        // IsWaitBootLoading が false になれば起動して準備完了の状態
        yield return new WaitUntil(() => !advEngine.IsWaitBootLoading);

        // Awake ではやらないこと(UTAGE 側のデータが Awake では動いていないため)
        ReadSaveData();
    }

    /// <summary>
    /// 外部からの実行用(直接コルーチンメソッドは呼び出さない)
    /// エントリーポイントとなるクラスの Start メソッド内から実行させる
    /// UTAGE のセーブデータの取得準備
    /// </summary>
    public void PrepareLoadUtageSaveData() {

        // AdcEngine の準備が整うまで待機する必要があるので、非同期処理で実行する
        // IsWaitBootLoading が false になれば起動して準備完了の状態
        StartCoroutine(WaitUntilAdvEnginePrepared());


        /// <summary>
        /// UTAGE の準備が整うまで待機してからセーブデータを読み込むローカル関数
        /// </summary>
        /// <returns></returns>
        IEnumerator WaitUntilAdvEnginePrepared() {
            // AdcEngine の準備が整うまで待機
            yield return new WaitUntil(() => !advEngine.IsWaitBootLoading);

            // セーブデータのロード
            ReadSaveData();
        }
    }

    /// <summary>
    /// UTAGE の中でオートセーブしているデータを読み込む
    /// データは AdvEngine ではなく、AdvEngine 起動時に読み込まれて、AdvSaveManager に保持されている
    /// この AdvSaveManager クラスは AdvEngine と同じく、AdvEngine ゲームオブジェクトに最初からアタッチされている
    /// Prama だけではなく、設定などの情報も取得できる
    /// データ自体は UTAGE 内に準備できているので、この処理自体は非同期化する必要(待機させる必要)はない
    /// </summary>
    private void ReadSaveData() {
        // オートセーブデータをロード
        advEngine.SaveManager.ReadAutoSaveData();

        if (advEngine.SaveManager.AutoSaveData == null || !advEngine.SaveManager.AutoSaveData.IsSaved) {
            // オートセーブデータのロード失敗
            Debug.LogError("AutoLoad is not yet load");
        } else {
            // オートセーブデータでゲーム開始
            advEngine.OpenLoadGame(advEngine.SaveManager.AutoSaveData);
            Debug.Log("AutoLoad is Successed!");
        }
    }

    //指定のラベルのシナリオを再生する
    public void JumpScenario(string label) {
        StartCoroutine(JumpScenarioAsync(label, null));
    }

    //指定のラベルのシナリオを再生する
    //終了した時にonCompleteが呼ばれる
    public void JumpScenario(string label, Action onComplete) {

        StartCoroutine(JumpScenarioAsync(label, onComplete));
    }

    public IEnumerator JumpScenarioAsync(string label, Action onComplete) {
        IsPlaying = true;
        AdvEngine.JumpScenario(label);
        while (!AdvEngine.IsEndOrPauseScenario) {
            yield return null;
        }
        IsPlaying = false;
        if (onComplete != null) onComplete();
        // TODO SAVE機能の追加
    }

    //指定のラベルのシナリオを再生する
    //ラベルがなかった場合を想定
    public void JumpScenario(string label, Action onComplete, Action onFailed) {
        JumpScenario(label, null, onComplete, onFailed);
    }

    //指定のラベルのシナリオを再生する
    //ラベルがなかった場合を想定
    public void JumpScenario(string label, Action onStart, Action onComplete, Action onFailed) {
        if (string.IsNullOrEmpty(label)) {
            if (onFailed != null) onFailed();
            Debug.LogErrorFormat("シナリオラベルが空です");
            return;
        }
        if (label[0] == '*') {
            label = label.Substring(1);
        }
        if (AdvEngine.DataManager.FindScenarioData(label) == null) {
            if (onFailed != null) onFailed();
            Debug.LogErrorFormat("{0}はまだロードされていないか、存在しないシナリオです", label);
            return;
        }

        if (onStart != null) onStart();
        JumpScenario(
            label,
            onComplete);
    }

    //シナリオの呼び出し以外に、
    //AdvEngineを操作する処理をまとめておくと、便利
    //何が必要かはプロジェクトによるので、場合によって増やしていく

    //以下、メッセージウィンドのテキスト表示速度を操作する処理のサンプル

    //メッセージウィンドのテキスト表示の速度を指定のスピードに
    public void ChangeMessageSpeed(float speed) {
        if (defaultSpeed < 0) {
            defaultSpeed = AdvEngine.Config.MessageSpeed;
        }
        AdvEngine.Config.MessageSpeed = speed;
    }
    //メッセージウィンドのテキスト表示の速度を元に戻す
    public void ResetMessageSpeed() {
        if (defaultSpeed >= 0) {
            AdvEngine.Config.MessageSpeed = defaultSpeed;
        }
    }

    internal void JumpScenario(object @string, string label) {
        throw new NotImplementedException();
    }


    //宴3.9.8以降では内部でのボクシングも発生しない。
    //string str = 
    //engine.Param.GetParameterString("String型のパラメーター名");
    //bool flag = engine.Param.GetParameterBoolean("Bool型のパラメーター名");
    //int point = engine.Param.GetParameterInt("Int型のパラメーター名");
    //float f = engine.Param.GetParameterFloat("Float型のパラメーター名");

}

　スクリプトを作成したらセーブします。

ゲームを実行して動作を確認する

　インスペクターに宴の Parameter の情報を表示してから、ゲームを実行します。
まずは最初に宴の会話イベントを発生させて、Parameter の値の更新を行います。
Parameter が更新されると、宴側では自動セーブが実行されます。
　
　一度、ゲームを停止して、再度、ゲームを実行します。
このタイミングで宴にセーブされている Parameter の値がロードされて復元されるかを確認します。

＜ロード前(ゲーム実行前)のインスペクター画像＞

＜ロード後(ゲーム実行後)のインスペクター画像＞

　以上になります。

このページを編集するこのページを元に新規ページを作成

印刷する

コメント（0）

宴のParameterデータをローカルセーブ・ロードする機能の実装例 - i-school 先頭へ

コメントをかく

名前	ユーザIDを使用しないで書き込む	ユーザーIDを使う	ログインする
画像コード	画像に記載されている文字を下のフォームに入力してください。
備考	「http://」を含む投稿は禁止されています。
本文
利用規約をご確認のうえご記入下さい

i-school