Unity でサービスロケーターを使う

はじめに

例えば GameManager のような、どこからでもアクセスしたい・一つだけ存在していてほしいクラスを Unity で実装する場合、よく使われるのは【シングルトン】というデザインパターンです。

シングルトンは非常にシンプルでお手軽に実装でき、小規模なプロジェクトでは大変便利なものではありますが、LevelManager とか SaveLoadManager とか LanguageManager とかといった感じでマネージャークラスが増えてくると、いろんなシングルトンがいろんなクラスから好き勝手にアクセスされるようになり、クラス間の依存関係がぐちゃぐちゃになってしまいがちです。*1

そこで登場するのが【サービスロケーター】で、簡単に言うと、

  • どこからでもアクセスできる「格納場所*2」を一つだけ用意し、
  • GameManager や LevelManager などをそこに登録し、
  • 他のクラスからは GameManager などに直接アクセスするのではなく、「格納場所」を経由してアクセスするようにする

という代物です。こうすることで、クラス間の依存を「格納場所」に集約でき、依存関係が追いやすくなるというわけです。

(👇この解説動画が分かりやすかったです)

www.youtube.com

実装

それでは実装です。

サービスロケーター本体のクラス

まず、サービスロケーター本体のスクリプトは以下のようになります。

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

public static class ServiceLocator
{
    /// <summary>
    /// インスタンスを登録する辞書。
    /// </summary>
    static readonly Dictionary<Type, object> instances = new Dictionary<Type, object>();

    /// <summary>
    /// インスタンスの登録をすべて解除します。
    /// </summary>
    [RuntimeInitializeOnLoadMethod(RuntimeInitializeLoadType.SubsystemRegistration)]
    static void Initialize()
    {
        instances.Clear();
    }

    /// <summary>
    /// インスタンスを登録します。すでに同じ型のインスタンスが登録されている場合は登録できませんので、先に Unregister を行ってください。
    /// </summary>
    /// <param name="instance">登録するインスタンス。</param>
    /// <typeparam name="T">登録するインスタンスの型。</typeparam>
    public static void Register<T>(T instance) where T : class
    {
        var type = typeof(T);

        if (instances.ContainsKey(type))
        {
            Debug.LogWarning($"すでに同じ型のインスタンスが登録されています:{type.Name}");
            return;
        }

        instances[type] = instance;
    }

    /// <summary>
    /// インスタンスの登録を解除します。インスタンスが登録されていなかった場合は警告が出ます。
    /// </summary>
    /// <param name="instance">登録を解除するインスタンス。</param>
    /// <typeparam name="T">登録を解除するインスタンスの型。</typeparam>
    public static void Unregister<T>(T instance) where T : class
    {
        var type = typeof(T);

        if (!instances.ContainsKey(type))
        {
            Debug.LogWarning($"要求された型のインスタンスが登録されていません:{type.Name}");
            return;
        }

        if (!Equals(instances[type], instance))
        {
            Debug.LogWarning($"登録されている要求された型のインスタンスと渡されたインスタンスが一致しません:{type.Name}");
            return;
        }

        instances.Remove(type);
    }

    /// <summary>
    /// 指定された型のインスタンスがすでに登録されているかをチェックします。
    /// </summary>
    /// <typeparam name="T">登録を確認するインスタンスの型。</typeparam>
    /// <returns>指定された型のインスタンスがすでに登録されている場合は true を返します。</returns>
    public static bool IsRegistered<T>() where T : class
    {
        return instances.ContainsKey(typeof(T));
    }

    /// <summary>
    /// 渡されたインスタンスがすでに登録されているかをチェックします。
    /// </summary>
    /// <param name="instance">登録を確認するインスタンス。</param>
    /// <typeparam name="T">登録を確認するインスタンスの型。</typeparam>
    /// <returns>渡されたインスタンスが既に登録されている場合は true を返します。</returns>
    public static bool IsRegistered<T>(T instance) where T : class
    {
        var type = typeof(T);

        return instances.ContainsKey(type) && Equals(instances[type], instance);
    }

    /// <summary>
    /// インスタンスを取得します。取得できなかった場合はエラーになります。
    /// </summary>
    /// <typeparam name="T">取得したいインスタンスの型。</typeparam>
    /// <returns>取得したインスタンスを返します。取得できなかった場合は null を返します。</returns>
    public static T GetInstance<T>() where T : class
    {
        var type = typeof(T);

        if (instances.ContainsKey(type))
        {
            return instances[type] as T;
        }

        Debug.LogError($"要求された型のインスタンスが登録されていません:{type.Name}");
        return null;
    }

    /// <summary>
    /// インスタンスを取得し、渡された引数に代入します。取得できなかった場合は null が入ります。
    /// </summary>
    /// <param name="instance">取得したインスタンスを入れる変数。</param>
    /// <typeparam name="T">取得したいインスタンスの型。</typeparam>
    /// <returns>取得が成功したら true を返します。</returns>
    public static bool TryGetInstance<T>(out T instance) where T : class
    {
        var type = typeof(T);

        instance = instances.ContainsKey(type) ? instances[type] as T : null;

        return instance != null;
    }
}

Dictionary<Type, object> instances が「格納場所」で、ここに GameManager などを詰めていきます。

サービスロケーターに格納するクラス(各種マネージャーなど)

お次は、GameManager などといった外部からアクセスしたいクラスを、サービスロケーターに登録する手順です。

using UnityEngine;

/// <summary>
/// マネージャークラス。
/// </summary>
public class GameManager : MonoBehaviour, IGameManager
{
    /// <summary>
    /// 外部から使いたいメソッド。
    /// </summary>
    public void DoSomething()
    {
        Debug.Log("I am GameManager!");
    }

    void Awake()
    {
        // サービスロケーターに自身を登録
        ServiceLocator.Register<IGameManager>(this);
    }

    void OnDestroy()
    {
        // サービスロケーターから自身の登録を解除
        ServiceLocator.Unregister<IGameManager>(this);
    }
}

/// <summary>
/// マネージャークラスのインターフェイス。
/// </summary>
public interface IGameManager
{
    /// <summary>
    /// 外部から使いたいメソッド。
    /// </summary>
    void DoSomething();
}

登録する型が GameManager ではなく IGameManager というインターフェイスになっていますが、こうすることで外部からアクセスできるメソッドを限定することができるので、なるべくインターフェイスを定義して実装するのをおすすめします。

この例だと DoSomething() しかないので恩恵を感じられませんが、実際にはいろいろなメソッドやプロパティが実装されるはずなので、アクセス可能な対象を限定しておくことは決して悪いことではありません。

外部からサービスロケーターにアクセスするクラス

最後に、サービスロケーターへアクセスする外部のクラスです。

using UnityEngine;

public class Foo : MonoBehaviour
{
    void Start()
    {
        var gameManager = ServiceLocator.GetInstance<IGameManager>();

        gameManager.DoSomething();
    }
}

ServiceLocator.GetInstance<IGameManager>() で、格納された GameManager を取得できます。取得できたら、あとは普通にメソッドを実行することができます✨

いちいち GetInstance でインスタンスを取得しないといけないのが面倒に感じるかもしれませんが、逆に言うと GetInstance が無い場合はマネージャークラスとは無関係だということが保証されるので、スクリプトの理解がしやすくなります。

なお、GameManager の登録は Awake() で行うので、他のクラスからは Start() 以降にアクセスする必要があります。

補遺

インスタンスを一つのみに制限する

さて、サービスロケーターを使うことで「どこからでもアクセスしたい」は実現できましたが、「一つだけ存在していてほしい」は実現できていません。

これは、「サービスロケーターへの登録時に、すでに同じ型のインスタンスが登録されていたら自身を破棄する」という処理を追加することで実現できます。

具体的にはこのように書きます。

public class GameManager : MonoBehaviour, IGameManager
{
    public void DoSomething()
    {
        Debug.Log("I am GameManager!");
    }

    void Awake()
    {
        // すでに IGameManager がサービスロケーターに登録されていたら、自身を破棄して終了
        if (ServiceLocator.IsRegistered<IGameManager>())
        {
            Destroy(gameObject);
            return;
        }

        ServiceLocator.Register<IGameManager>(this);
    }

    void OnDestroy()
    {
        ServiceLocator.Unregister<IGameManager>(this);
    }
}

GetInstance と TryGetInstance

今回紹介したスクリプトでは、 GetInstance でインスタンスを取得できなかった場合はエラーになるようにしています。

Unity でよく使われる GetComponent などは取得に失敗してもエラーにならないので、それに倣ったほうが良いという意見もあるとは思うのですが、自分のコーディングだと、

  • 基本的に GetComponent は必ずそのコンポーネントを取得できる想定の時しか使わない
  • 取得できなかった場合も処理を続行したい場合は TryGetComponent を使う

という理由から、今回はエラーになる仕様を採用しました。なお、TryGetComponent に相当するメソッドとして TryGetInstance を用意しています。

Awake と Start

記事中にも書きましたが、サービスロケーターへの登録は Awake() で行っているので、アクセスは Start() 以降でないとできません。

これが嫌だという方もいらっしゃるかもしれませんが、 Awake() の時点では他のオブジェクトの初期化が完了していない場合があるので、今回の例に限らず、そもそも Awake() 内で他のオブジェクトに働きかけるのは避けたほうが良いでしょう。

おわりに

サービスロケーターを使えば、依存関係の複雑化を回避しつつ、どこからでもアクセスできるクラスを作ることができます。サービスロケーターを使いこなして、シングルトンを駆逐していきましょう!

*1:そもそもこんなに「○○マネージャー」を作るの自体が良くない? それはそう🙂

*2:Dictionary 型が使われることが多い気がします。

ルートに変更された Prefab があるかどうかを調べるエディター拡張

Prefab の Apply や Revert をし忘れていないかいつも心配になるので、それをチェックするエディター拡張を作成しました。

自分のワークフローだとルートに存在している Prefab だけをチェックするようにしたほうが都合が良かったのでそうしていますが、子孫含めたすべての Prefab をチェックしたい場合は、rootGameObjects = ...の部分を適宜書き換えてください。

using System.Collections.Generic;
using System.Linq;
using UnityEditor;
using UnityEditor.Experimental.SceneManagement;
using UnityEngine;
using UnityEngine.SceneManagement;

public static class GcTools
{
    [MenuItem("GcTools/Check if Root Prefabs have Changed")]
    public static void CheckIfRootPrefabsHaveChanged()
    {
        IEnumerable<GameObject> rootGameObjects;

        var currentPrefabStage = PrefabStageUtility.GetCurrentPrefabStage();

        if (currentPrefabStage == null)
        {
            // Prefab Mode でない場合、シーンのルートにある GameObject を取得
            rootGameObjects = SceneManager.GetActiveScene().GetRootGameObjects();
        }
        else
        {
            // Prefab Mode の場合、ルートの Prefab の 1 階層下にある GameObject を取得 
            rootGameObjects = currentPrefabStage.prefabContentsRoot.transform.Cast<Transform>()
                .Select(child => child.gameObject);
        }

        // 変更されている Prefab Instance を抽出
        var overriddenPrefabInstances = rootGameObjects
            .Where(PrefabUtility.IsAnyPrefabInstanceRoot)
            .Where(x => PrefabUtility.HasPrefabInstanceAnyOverrides(x, false))
            .Select(x => (Object)x)
            .ToArray();

        foreach (var instance in overriddenPrefabInstances)
        {
            Debug.Log($"ルートの Prefab が変更されています:{instance}");
        }

        if (!overriddenPrefabInstances.Any())
        {
            Debug.Log("ルートに変更された Prefab はありませんでした。");
        }

        // 変更されている Prefab Instance が存在していたら、それらを選択
        Selection.objects = overriddenPrefabInstances;
    }
}

Unity WebGL の実行環境が PC かモバイル端末かを判別するスクリプトを公開しました

PC モバイル

はじめに

  • PC では Post Processing を有効にしたいけど、モバイル端末では重たいので無効にしたい。
  • モバイル端末の場合はOnPointer*を切ってInput.Touchesを使いたい。

……というように、PC とモバイル端末で処理を分けたいという場合がたまにあります。そんな時、このスクリプトを導入することで、実行環境が PC かモバイル端末かを判別することができます。

github.com

使い方

CheckIfMobileForUnityWebgl.jslib内のIsMobile()を呼ぶと、モバイル端末ならtrue、PC ならfalseが返ってきます。以下のように呼び出してください。

    bool isMobile;

#if !UNITY_EDITOR && UNITY_WEBGL
    [System.Runtime.InteropServices.DllImport("__Internal")]
    static extern bool IsMobile();
#endif

    void CheckIfMobile()
    {
#if !UNITY_EDITOR && UNITY_WEBGL
        isMobile = IsMobile();
#endif
    }

インストール

Package Manager

https://github.com/Gigacee/check-if-mobile-for-unity-webgl.git?path=Assets/Plugins/check-if-mobile-for-unity-webgl

手動

Assets/Plugins/check-if-mobile-for-unity-webgl/CheckIfMobileForUnityWebgl.jslibを、自分のプロジェクトにコピーしてください。

※ 必ずAssets/Plugins/に配置してください。でないと機能しません。

Unity のビルド時刻を表示するスクリプトを公開しました

github.com

f:id:Gigacee:20210108003920p:plain

使い方

  1. このパッケージをインポートした状態でゲームをビルドすると、ビルドが開始された時刻を int のフィールドで保持した ScriptableObject がAssets/BuildTimestampDisplay/BuildTimestamp.assetに生成されます。 f:id:Gigacee:20210108004009p:plain
  2. uGUI の Text にBuild Timestamp Displayをアタッチし*1BuildTimestamp.assetをセットします。 f:id:Gigacee:20210108004024p:plain
    • 表示フォーマットや時差を設定することもできます。日本時間の場合は「Utc Offset Hours」に「9」を入力します。
  3. そしてシーンを再生すると、Text がビルド日時に上書きされ、画面に表示されます。

インストール

Package Manager

https://github.com/Gigacee/build-timestamp-display-for-unity.git?path=Assets/BuildTimestampDisplay

手動

Assets/BuildTimestampDisplay/ を、自分のプロジェクトにコピーしてください。

*1: Add Component > Gigacee > Build Timestamp Display とクリックしてアタッチできます。

モバイルにも対応した、Unity WebGL からツイートができるスクリプトを公開しました

はじめに

先日リリースした『ねねちーのお昼ご飯大作戦ある!』では、スクリーンショット付きで結果をツイートすることができます。

f:id:Gigacee:20201004223441p:plain
こんな感じ。

そしてこのたび、ここで使用したスクリプトを切り出して、GitHub にて公開いたしました。

github.com

使い方

テキストのみツイートする

TweetFromUnityWebgl.jslib 内の TweetFromUnity() を実行することでツイートができます。以下のように呼び出してください。

#if !UNITY_EDITOR && UNITY_WEBGL
    [System.Runtime.InteropServices.DllImport("__Internal")]
    static extern string TweetFromUnity(string rawMessage);
#endif

    public void Tweet()
    {
#if !UNITY_EDITOR && UNITY_WEBGL
        TweetFromUnity("ツイートメッセージです");
        return;
#endif
    }

PC 環境で実行すると、twitter.com の投稿画面がブラウザで開きます。モバイル環境だと、Twitter アプリが起動します。

Sample1_Tweet シーンにこの例がありますので、ご参照ください。

スクリーンショット付きでツイートする

ゲームのスクリーンショット付きでツイートすることもできます。Imgur を使用した例を以下に示します。

Imgur のクライアント ID が必要です。

    [SerializeField] string imgurClientId;

#if !UNITY_EDITOR && UNITY_WEBGL
    [System.Runtime.InteropServices.DllImport("__Internal")]
    static extern string TweetFromUnity(string rawMessage);
#endif

    public IEnumerator TweetWithScreenshot()
    {
        yield return new WaitForEndOfFrame();

        var tex = ScreenCapture.CaptureScreenshotAsTexture();

        var wwwForm = new WWWForm();
        wwwForm.AddField("image", Convert.ToBase64String(tex.EncodeToJPG()));
        wwwForm.AddField("type", "base64");

        // Upload to Imgur
        var www = UnityWebRequest.Post("https://api.imgur.com/3/image.xml", wwwForm);
        www.SetRequestHeader("AUTHORIZATION", "Client-ID " + imgurClientId);

        yield return www.SendWebRequest();

        var uri = "";

        if (!www.isNetworkError)
        {
            var xDoc = XDocument.Parse(www.downloadHandler.text);
            uri = xDoc.Element("data")?.Element("link")?.Value;

            if (uri != null)
            {
                // Remove ext
                uri = uri.Remove(uri.Length - 4, 4);
            }
        }

#if !UNITY_EDITOR && UNITY_WEBGL
        TweetFromUnity($"ツイートメッセージです%0a{uri}");
        yield break;
#endif
    }

Sample2_TweetWithScreenshot シーンにこの例がありますので、ご参照ください。

特殊文字

改行やハッシュタグをツイート文に含めたい場合は、以下のようにしてください。

  • 改行 : %0a
  • ハッシュタグ (#) : %23

例:

TweetFromUnity("ツイートメッセージに、改行や%0aハッシュタグを含めることもできます!%0a%0a%23TweetFromUnityWebGL");

ツイートメッセージに、改行や
ハッシュタグを含めることもできます!

#TweetFromUnityWebGL

インストール

Package Manager

https://github.com/Gigacee/tweet-from-unity-webgl.git?path=Assets/Plugins/tweet-from-unity-webgl

手動

Assets/Plugins/tweet-from-unity-webgl/TweetFromUnityWebgl.jslib を、自分のプロジェクトにコピーしてください。

※ 必ず Assets/Plugins/ に配置してください。でないと機能しません。

余談:このスクリプトができるまで

Unity WebGL からツイートするための方法は、ネットで調べるといくつかの情報がヒットします。ですがその多くが、すでに廃止されている Application.ExternalEval() を使用したもので、最新の Unity で動作するようなスクリプトは見つけることができませんでした。

とはいえ、Unity WebGL から JavaScript の関数を呼び出すこと自体は、前作の『かえちゃんジャンプ!!』でやったことがあります。その応用で、Unity 内で生成した文字列を JavaScript に渡し、twitter.com を開けばツイートできるのでは? と考え、最初に書いたコードが以下のようなものです。

// TweetFromUnityWebgl.jslib

mergeInto(LibraryManager.library, {
    TweetFromUnity: function (rawMessage) {
        var message = Pointer_stringify(rawMessage);
        window.open("https://twitter.com/intent/tweet?text=" + message, "_blank");
    },
});

Pointer_stringify() は、Unity 内の文字列を JavaScript 文字列に変換するためのものらしいです。

あとは Unity 内から TweetFromUnity("ツイート文だよ~") という感じで呼び出せば、 window.open(uri) で twitter.com の投稿画面が開き、ツイートができる! 完璧!! ……と思っていたのですが、iOS の Safari でゲームを実行すると、ポップアップブロック機能が働いてしまい、投稿画面が開いてくれませんでした。かと言って、 location.href = uri で遷移すると、ゲームを実行しているタブと同じタブで投稿画面が開いてしまい、ゲームが終了してしまいます。

どうしたものか……としばらく考え、モバイル端末なら大抵 Twitter アプリが入っているはずだから、そのアプリを直接起動すれば良いのでは??? と考えました。つまり、こんなコードです。

// TweetFromUnityWebgl.jslib

mergeInto(LibraryManager.library, {
    TweetFromUnity: function (rawMessage) {
        var message = Pointer_stringify(rawMessage);
        location.href = "twitter://post?message=" + message;
    },
});

モバイル環境で twitter://post?message= を実行すると、Twitter アプリが開きます。この URI (?) を調べるのに、だいぶ苦労しました……。

ですがこれだと、今度は PC でツイート画面が開けませんから、どうにかして実行環境が PC かモバイルかを判別しなくてはなりません。これに関してはネットに豊富な情報がありましたので、苦労せず実装することができました。

// TweetFromUnityWebgl.jslib

mergeInto(LibraryManager.library, {
    TweetFromUnity: function (rawMessage) {
        var message = Pointer_stringify(rawMessage);
        var mobilePattern = /Android|iPhone|iPad|iPod/i;

        if (window.navigator.userAgent.search(mobilePattern) !== -1) {
            // Mobile
            location.href = "twitter://post?message=" + message;
        } else {
            // PC
            window.open("https://twitter.com/intent/tweet?text=" + message, "_blank");
        }
    },
});

ユーザーエージェントを取得し、その中に「Android」「iPhone」「iPad」「iPod」のいずれかが含まれていたらモバイル端末、というように判別します。これで、すべての環境*1でツイートをすることができるようになりました!🎉 めでたしめでたし😊


追記(2020.10.18)

あとから知ったのですが、iOS 13.0 以降の iPad*2だと、ユーザーエージェントに「iPad」の文字列が入ってないんですね……。そのため、上記のコードだと iPad で Twitter アプリが開きません。iPad でも Twitter アプリが開くよう、以下のように修正しました。

// TweetFromUnityWebgl.jslib

<feff>mergeInto(LibraryManager.library, {
    TweetFromUnity: function (rawMessage) {
        var message = Pointer_stringify(rawMessage);
        var mobilePattern = /android|iphone|ipad|ipod/i;

        var ua = window.navigator.userAgent.toLowerCase();

        if (ua.search(mobilePattern) !== -1 || (ua.indexOf("macintosh") !== -1 && "ontouchend" in document)) {
            // Mobile
            location.href = "twitter://post?message=" + message;
        } else {
            // PC
            window.open("https://twitter.com/intent/tweet?text=" + message, "_blank");
        }
    },
});

ua.indexOf("macintosh") !== -1 で「Macintosh」の文字列を見つけ、なおかつ "ontouchend" in document でタッチ操作がサポートされているかを調べます。タッチ操作ができる Macintosh => iPad というわけですね。

なお、この PC かモバイルかを判別するスクリプトをさらに切り出したものを公開しているので、もしよければそちらもご覧になってください。

*1:モバイル端末で Twitter アプリがインストールされていない場合? そんなものは知らん🙄

*2:mini を除く。

最高の Hierarchy Window を目指して ~QHierarchy & Hierarchy Folders~

f:id:Gigacee:20200801030624p:plain


この記事は「Unity アセット真夏のアドベントカレンダー 2020 Summer!」2 日目の記事になります。

昨日のアドカレは、汗人柱さんの「Massive Clouds Atmosなど雲、天候、昼夜が美しい空アセット8連発!グラフィック & 機能比較まとめ」でした。

明日のアドカレは、k1t(外神) さんの「すぐに遊べるダンジョンを自動生成 (Dungeon Architect & Multistory Dungeons)」です。


はじめに

Asset Store には、Unity Editor の機能を拡張して開発の手助けをしてくれるユーティリティが数多く公開されています。

今回はその中でも、Hierarchy Window をパワーアップしてくれる 2 つのアセット、QHierarchyHierarchy Folders をご紹介します。

QHierarchy

Hierarchy Windows に表示される情報を増やしてくれる QHierarchy は、長年多くの Unity ユーザーに親しまれている定番とも言えるアセットです。難しい設定は不要で、様々な情報をワンクリックで表示できるようになります。

インストールすると、まず Hierarchy にツリー( のような罫線)とストライプが表示されるようになります。

f:id:Gigacee:20200801025124p:plain

さらに、設定画面から表示させる情報を選択することができます。中でも Components と Visiblity は特に便利なので、ぜひ有効にしておきましょう。

f:id:Gigacee:20200801025131p:plain

設定画面は、メニューの Tools > QHierarchy > Settings で開くことができます。

Components

Components を有効にすると、各 GameObject にアタッチされているコンポーネントのアイコンが表示されるようになります。通常は名前でしか区別することができなかった GameObject を、持っている機能によって視覚的に判別できるようになり、編集が非常に捗ります。

さらに、アイコンをクリックすることでコンポーネントの有効・無効を切り替えることができます。無効になっているコンポーネントはアイコンが暗くなりますので、今どのコンポーネントが機能しているのかが簡単に判ります。

f:id:Gigacee:20200801025143p:plain

Visiblity

Visiblity を有効にすると、目のアイコンが表示されるようになります。これをクリックすることで、GameObject の有効・無効を切り替えることができます。

Hierarchy の左端にも元々同じような目のアイコンがありますが、こちらが Scene ビュー上で非表示になるだけなのに対し、Visiblity アイコンは GameObejct 自体が無効になります(SetActive(false)をしたのと同じ)。

f:id:Gigacee:20200801025053p:plain

補足

他にも、GameObject に設定したアイコンやタグ名・レイヤー名など、表示できる項目はまだまだ豊富にありますので、自分の好みに合わせてカスタマイズしてみてください。

なお、初期状態では「MonoBehaviour Icon」という項目が有効になっています。これは、MonoBehaviour を持つ GameObject の名前の左に半透明の青い四角を表示させる機能なのですが、やや見づらいのに加え、Components を有効にしていれば必要性の薄い機能なので、オフにしておくのをおすすめします。

Hierarchy Folders

Hierarchy を整理する手法として、空の GameObject を区切り線やフォルダとして使うというハックがありますが、これは実行時のパフォーマンスに少なからず悪影響が出る*1ので、できればやりたくありません。とは言えシーンが大きくなってくると、区切り線やフォルダ無しでは厳しい場面も多くなってくるでしょう。そんな時に役立つのが Hierarchy Folders です。

Hierarchy Folders は、その名のとおり Hierarchy にフォルダを追加することができるアセットです。このフォルダは、ビルド時に自動で削除されるため、気兼ねなく使うことができます。

f:id:Gigacee:20200801030642p:plain

カスタマイズ

フォルダのアイコンは、好きな画像に変更することもできます。

フォントのカラーを変更するような機能はありませんが、そこは自分で拡張すれば問題ありません。以下は、フォルダのフォントをグレーにするエディター拡張です。

// HierarchyFolderColoring.cs

using Sisus.HierarchyFolders;
using UnityEditor;
using UnityEngine;

public class HierarchyFolderColoring : Editor
{
    static readonly Vector2 offset = new Vector2(18f, 0);
    static readonly Color separatorColor = Color.HSVToRGB(0f, 0f, 0.5f);

    [InitializeOnLoadMethod]
    static void AddHierarchyItemOnGUI()
    {
        EditorApplication.hierarchyWindowItemOnGUI += HierarchyWindowItemOnGUI;
    }

    static void HierarchyWindowItemOnGUI(int instanceId, Rect selectionRect)
    {
        var gameObject = EditorUtility.InstanceIDToObject(instanceId) as GameObject;

        if (gameObject == null)
        {
            return;
        }

        var hierarchyFolder = gameObject.GetComponent<HierarchyFolder>();

        if (hierarchyFolder == null)
        {
            return;
        }

        var offsetRect = new Rect(selectionRect.position + offset, selectionRect.size);

        EditorGUI.LabelField(offsetRect, gameObject.name, new GUIStyle
        {
            normal = new GUIStyleState
            {
                textColor = separatorColor
            }
        });
    }
}

区切り線として使う

フォルダに格納すれば見た目はスッキリしますが、個人的にはフォルダをいちいち開くのが若干面倒なので、自分は区切り線として使っています。アイコンを「_」のような画像に差し替えれば、良い感じの区切り線になってくれます。

f:id:Gigacee:20200801030255p:plain

もちろん、区切り線とフォルダを併用することも可能です。その場合、アイコンはデフォルトのものにしておくのが良いでしょう。

補足

なお、フォルダは Unity Editor でシーンを再生したときにも削除されますが、この機能はオフにすることもできます。個人的には、再生中であっても区切り線があったほうが見やすいので、オフにしています。

さいごに

ここで紹介した 2 つのアセット以外にも、Asset Store には Hierarchy Window を拡張するユーティリティが数多くあります。ぜひ好みの拡張を探して使ってみてください!

*1:"空" だと思っているのは我々だけで、実際は Transform を持った有効な実体としてゲーム中に展開されてしまいます。

TopDown Engine 入門 Part 14 ~効果音編~

【フィードバック】

キャラクターがジャンプした時の効果音、魔法を放った時のエフェクト、ダメージを受けた時の画面の振動――こういったゲーム中で何かが起こった時に再生する演出のことを、TopDown Engine では【フィードバック】と呼んでいます。

今回は基本的なフィードバックとして、プレイヤーキャラクターがジャンプした時に、効果音が鳴るようにしてみます。

MMFeedbacks

まず、キャラクターの子に JumpStartFeedback という名称で GameObject を生成し、Add Component から MMFeedbacks をアタッチします。

f:id:Gigacee:20200729185353p:plain

Inspector の「Add new feedback...」をクリックすると、Audio を始めとした様々なフィードバックのリストが出てきます。今回はその中の、Audio > Sound を選択します。すると、「Sound」というバーが「Feedbacks」に追加されます。

f:id:Gigacee:20200729185407p:plain

バーをクリックして展開すると、とても長い設定項目が出てきます。その中頃にある「Sound」グループの「Sfx」に、任意のオーディオクリップを設定してください。

f:id:Gigacee:20200729185401p:plain

最後に、親の Character Jump 2D 内にある「Jump Start Feedback」に、作成した JumpStartFeedback を設定します。

f:id:Gigacee:20200729185344p:plain

これで手順は完了です。シーンを再生し、ジャンプ時に効果音が鳴るかどうか確かめてください。


PREVTopDown Engine 入門 Part 13 ~アニメーション編~


The coloring of this site is Dracula PRO🧛🏻‍♂️
This website uses the FontAwesome icons licensed under CC BY 4.0.

2020 GIGA CREATION