[Unity] UniRxを使ったマルチシーンの利用方法を考えたけど微妙だった

お世話になっております。
しゃまとんです。

今回は、UniRxを使ったマルチシーンの利用方法について考えていてやってみたけど微妙になってしまった話です。

最近はZenjectがいいという話からちょっと触ってみたりしているのですが、やっぱマルチシーンの初期化時に引数的なものを渡して何かしたいよねと思っていたのが発端でググるとneueccさんの記事がヒットするので、それを参考にもう少し扱いやすくできないかなぁと実装してみました。

Unity 5.3のMulti Scene EditingをUniRxによるシーンナビゲーションで統合する

詳しい処理の流れは上記記事を参考にしていただくとして、変更した点は

・GameObject.FindObjectOfTypeはジェネリック変数Tで行う
→　シーンを複数同時に読んだときに引数がアレしそう
・Argをobject asしないようにした
→　毎回 as がめんどくさげ

2点で理由は書いたとおりです。

で…. Argに何でもつっこめて勝手に動作して最高だぜ！と思って使っていたのですが、とりあえず使ってみるとコードの読みづらさや、あれ…ここ同期まちさせたい…というような状況になり、うーーーーん後から見返したときにやばそうとなった次第です。

簡単なサンプルを含めたコードはこんな感じです。

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

using UniRx;

/////////////////////////////////////////////////////////////////////////////////////////////////
/// <summary>
/// シーンローダーと連携するシーン管理基底クラス
/// </summary>
/////////////////////////////////////////////////////////////////////////////////////////////////
public abstract class SceneBase<T> : PresenterBase {
  // 初期化引数
  public T Arg { get; private set; }

  // ロードしたシーン名
  private string loadedSceneName;
  public string LoadedSceneName {
    get {
      return loadedSceneName;
    }
  }

  // ロード済みフラグ
  public bool IsLoaded { get; private set; }

  /////////////////////////////////////////////////////////////////////////////////////////////////
  /// <summary>
  /// Initialize前にコールする
  /// </summary>
  /// <returns>The async.</returns>
  /////////////////////////////////////////////////////////////////////////////////////////////////
  public virtual IObservable<Unit> PrepareAsync() {
    return Observable.Return(Unit.Default);
  }

  /////////////////////////////////////////////////////////////////////////////////////////////////
  /// <summary>
  /// 生成時処理
  /// </summary>
  /////////////////////////////////////////////////////////////////////////////////////////////////
  protected override void OnAwake() {
    // 完了時にフラグを立てておく
    this.InitializeAsObservable().Subscribe(_ => IsLoaded = true);
  }

  /////////////////////////////////////////////////////////////////////////////////////////////////
  /// <summary>
  /// シーン名を設定
  /// </summary>
  /////////////////////////////////////////////////////////////////////////////////////////////////
  public void SetSceneName(string sceneName) {
    loadedSceneName = sceneName;
  }

  /////////////////////////////////////////////////////////////////////////////////////////////////
  /// <summary>
  /// 初期化値を設定
  /// </summary>
  /// <param name="arg">Argument.</param>
  /////////////////////////////////////////////////////////////////////////////////////////////////
  public void SetArg(T arg) {
    Arg = arg;
  }
}

using System.Collections;

using System.Collections.Generic;

using UnityEngine;

using UnityEngine.SceneManagement;

using UniRx;

/////////////////////////////////////////////////////////////////////////////////////////////////

/// <summary>

/// シーンローダーと連携するシーン管理基底クラス

/// </summary>

/////////////////////////////////////////////////////////////////////////////////////////////////

public abstract class SceneBase<T> : PresenterBase {

// 初期化引数

public T Arg { get; private set; }

// ロードしたシーン名

private string loadedSceneName;

public string LoadedSceneName {

get {

return loadedSceneName;

}

// ロード済みフラグ

public bool IsLoaded { get; private set; }

/////////////////////////////////////////////////////////////////////////////////////////////////

/// <summary>

/// Initialize前にコールする

/// </summary>

/// <returns>The async.</returns>

/////////////////////////////////////////////////////////////////////////////////////////////////

public virtual IObservable<Unit> PrepareAsync() {

return Observable.Return(Unit.Default);

}

/////////////////////////////////////////////////////////////////////////////////////////////////

/// <summary>

/// 生成時処理

/// </summary>

/////////////////////////////////////////////////////////////////////////////////////////////////

protected override void OnAwake() {

// 完了時にフラグを立てておく

this.InitializeAsObservable().Subscribe(_ => IsLoaded = true);

}

/////////////////////////////////////////////////////////////////////////////////////////////////

/// <summary>

/// シーン名を設定

/// </summary>

/////////////////////////////////////////////////////////////////////////////////////////////////

public void SetSceneName(string sceneName) {

loadedSceneName = sceneName;

}

/////////////////////////////////////////////////////////////////////////////////////////////////

/// <summary>

/// 初期化値を設定

/// </summary>

/// <param name="arg">Argument.</param>

/////////////////////////////////////////////////////////////////////////////////////////////////

public void SetArg(T arg) {

Arg = arg;

}

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

using UniRx;

/////////////////////////////////////////////////////////////////////////////////////////////////
/// <summary>
/// SceneBaseクラスを利用したシーンのロード管理
/// </summary>
/////////////////////////////////////////////////////////////////////////////////////////////////
public static class SceneBaseLoader {

  /////////////////////////////////////////////////////////////////////////////////////////////////
  /// <summary>
  /// シーンを非同期にロード
  /// </summary>
  /////////////////////////////////////////////////////////////////////////////////////////////////
  public static IObservable<Unit> LoadAsync<T, T_Arg>(string sceneName, T_Arg argument, LoadSceneMode mode = LoadSceneMode.Single)
    where T : SceneBase<T_Arg>
  {
    return Observable.FromCoroutine<Unit>(observer => initRoutine(SceneManager.LoadSceneAsync(sceneName, mode), observer))
      .SelectMany(_ =>
        {
          // シーンを取得
          T[] scenes = GameObject.FindObjectsOfType<T>();

          // 同じシーンを重複して読まないようにする
          if (scenes.Length != 1) {
            Debug.LogErrorFormat(typeof(T).Name + " component must set only one in scene !!");
          }

          T loadedScene = scenes[0];

          // ロード済み
          if (loadedScene.IsLoaded) {
            Debug.LogErrorFormat(sceneName + " has alreay been loaded !!");
          }

          // ロード済みにして
          loadedScene.SetArg(argument);
          loadedScene.SetSceneName(sceneName);

          // 一旦非Activeにして止める
          loadedScene.gameObject.SetActive(false); 

          // PrepareAsyncが完了するまで待つ
          return loadedScene.PrepareAsync() 
            .Do(__ => {
              // Activeにして動かしはじめる
              loadedScene.gameObject.SetActive(true);
            });
        });
  }

  /////////////////////////////////////////////////////////////////////////////////////////////////
  /// <summary>
  /// 初期化ルーチン
  /// </summary>
  /////////////////////////////////////////////////////////////////////////////////////////////////
  static IEnumerator initRoutine(AsyncOperation operation, IObserver<Unit> observer) {

    // ロード待機
    if (!operation.isDone) yield return operation;

    // 初期化処理する
    observer.OnNext(Unit.Default);

    // 完了
    observer.OnCompleted();
  }
}

using System;

using System.Collections;

using System.Collections.Generic;

using UnityEngine;

using UnityEngine.SceneManagement;

using UniRx;

/////////////////////////////////////////////////////////////////////////////////////////////////

/// <summary>

/// SceneBaseクラスを利用したシーンのロード管理

/// </summary>

/////////////////////////////////////////////////////////////////////////////////////////////////

public static class SceneBaseLoader {

/////////////////////////////////////////////////////////////////////////////////////////////////

/// <summary>

/// シーンを非同期にロード

/// </summary>

/////////////////////////////////////////////////////////////////////////////////////////////////

public static IObservable<Unit> LoadAsync<T, T_Arg>(string sceneName, T_Arg argument, LoadSceneMode mode = LoadSceneMode.Single)

where T : SceneBase<T_Arg>

{

return Observable.FromCoroutine<Unit>(observer => initRoutine(SceneManager.LoadSceneAsync(sceneName, mode), observer))

.SelectMany(_ =>

{

// シーンを取得

T[] scenes = GameObject.FindObjectsOfType<T>();

// 同じシーンを重複して読まないようにする

if (scenes.Length != 1) {

Debug.LogErrorFormat(typeof(T).Name + " component must set only one in scene !!");

}

T loadedScene = scenes[0];

// ロード済み

if (loadedScene.IsLoaded) {

Debug.LogErrorFormat(sceneName + " has alreay been loaded !!");

}

// ロード済みにして

loadedScene.SetArg(argument);

loadedScene.SetSceneName(sceneName);

// 一旦非Activeにして止める

loadedScene.gameObject.SetActive(false);

// PrepareAsyncが完了するまで待つ

return loadedScene.PrepareAsync()

.Do(__ => {

// Activeにして動かしはじめる

loadedScene.gameObject.SetActive(true);

});

}

/////////////////////////////////////////////////////////////////////////////////////////////////

/// <summary>

/// 初期化ルーチン

/// </summary>

/////////////////////////////////////////////////////////////////////////////////////////////////

static IEnumerator initRoutine(AsyncOperation operation, IObserver<Unit> observer) {

// ロード待機

if (!operation.isDone) yield return operation;

// 初期化処理する

observer.OnNext(Unit.Default);

// 完了

observer.OnCompleted();

}

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

using UniRx;

public class Scene1 : MonoBehaviour {
    
  void Update() {
    if (Input.GetKeyDown(KeyCode.A)) {
      Scene2Arg arg = new Scene2Arg();
      arg.mesasge = "Scene2をロードしました！";
      SceneBaseLoader.LoadAsync<Scene2, Scene2Arg>("Scene2", arg, LoadSceneMode.Additive).Subscribe();
    }
  }
}

using System.Collections;

using System.Collections.Generic;

using UnityEngine;

using UnityEngine.SceneManagement;

using UniRx;

public class Scene1 : MonoBehaviour {

void Update() {

if (Input.GetKeyDown(KeyCode.A)) {

Scene2Arg arg = new Scene2Arg();

arg.mesasge = "Scene2をロードしました！";

SceneBaseLoader.LoadAsync<Scene2, Scene2Arg>("Scene2", arg, LoadSceneMode.Additive).Subscribe();

}

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

using UniRx;

public class Scene2 : SceneBase<Scene2Arg> {

  [SerializeField] private Text text;


  protected override IPresenter[] Children {
    get { return EmptyChildren; }
  }

  protected override void BeforeInitialize()
  {
    // 何もしない
  }

  protected override void Initialize()
  {
    if (Arg != null) {
      text.text = Arg.mesasge;
    }
  }
}

public class Scene2Arg {
  public string mesasge = "";
}

using System.Collections;

using System.Collections.Generic;

using UnityEngine;

using UnityEngine.UI;

using UniRx;

public class Scene2 : SceneBase<Scene2Arg> {

[SerializeField] private Text text;

protected override IPresenter[] Children {

get { return EmptyChildren; }

}

protected override void BeforeInitialize()

{

// 何もしない

}

protected override void Initialize()

{

if (Arg != null) {

text.text = Arg.mesasge;

}

public class Scene2Arg {

public string mesasge = "";

}

挙動例はこれ。

もっと理解していたらきれいに使えるかもなんですが、今はちょっとなーという感じになってしまいました。一旦はシンプルな使い方にとどめておこうかと思います。

以上です。

[Unity] UniRxを使ったマルチシーンの利用方法を考えたけど微妙だった

関連記事

[Unity] Colliderの比較するのは何がいいのか

[cocos2dx]内部でテクスチャを作成して、クリッピングする

[Unity] DoTweenでuGUIにバウンドさせてみる

[golang]標準入力を受け取りつつ、システムコマンド(mysqlなど)を実行する

[Golang] EchoのUseの挙動について