２Ｄタップシューティングゲーム　発展４０ - i-school

　引き続き音楽の面でのゲームの演出を追加していきます。

　この手順ではタイミングに合わせて SE を再生する処理を実装していきます。

発展４０　－SEの再生－

８１．SE 用のオーディオファイルをインポートし、SoundDataSO スクリプトを修正して、SE 用のオーディオデータを登録する
８２．SoundManager スクリプトを修正し、SE 用の再生・停止処理を追加する
８３．適宜なタイミングに合わせて SE を再生する処理を実装する

　新しい学習内容は、以下の通りです。

　・オーディオファイルの容量圧縮やメモリ使用の設定

８１．SE 用のオーディオファイルをインポートし、SoundDataSO スクリプトを修正して、SE 用のオーディオデータを登録する

１．設計

　SE とは効果音のことです。要所要所タイミングよく SE が鳴ることによって、ゲームの臨場感を増す演出が出来ます。

　無料の音楽サイトや持っている音源などをUnityへインポートして、ゲーム内で音楽を鳴らすための準備をします。

　まずはどのタイミング・シーンで SE を鳴らすかを想定し、その種類分の SE が必要になることを把握します。
今回想定しているのは以下の３種類です。左側が想定するファイル名、右側が SE を鳴らす場面です。

＜SE リスト＞

　１．BulletDamage_1       --  エネミーにプレイヤーのバレットが接触したタイミング
　２．GameClear  　  　　  --  ゲームクリア時のUI表示のタイミング
　３．GameOver             --  ゲームオーバー時のUI表示のタイミング

　今後、SE を鳴らしたいタイミングが増えた場合には、上記に追加をして検討してください。

　なお今回は、キャラのバレットの発射時や、エネミーから攻撃を受けた際の効果音についてはボイスを利用しています。
それらについてボイスではなくて SE で対応を行う場合には、それらの種類も列挙子として登録をしてください。

２．SE を再生する場面をイメージして、オーディオファイルを探してダウンロードする

　無料の音源ダウンロードサイトなどへアクセスして、頭の中で場面を思い浮かべながら、どんな SE がよいか、視聴しながら決めていきましょう。
先ほど提示した場面に合わせて、合計で３種類のオーディオファイルを用意をしてください。

　ダウンロードしたオーディオファイルは、上記のSEリストを参考にファイル名を変更しておきましょう。

３．オーディオファイルをUnityへインポートする

　Unityへオーディオファイルをインポートする方法は、画像ファイルと同じです。
Unityへドラッグアンドドロップしてフォルダへ移動することでインポートされます。

　今回は Audio フォルダ内の SE フォルダ内に全ファイルをインポートしています。

Audio/SE フォルダ画像

　無料サイトからダウンロードした場合にはオーディオファイルが圧縮されている可能性がありますので、必ず解凍を行った上でUnityへインポートしてください。
解凍されていないオーディオファイルはインポートが行えません。

４．SoundDataSO スクリプトを修正して、SE 管理用のクラスを新しく追加する

　
　SoundDataSO スクリプトを修正して、BGM と同じように、SE 専用のクラスを作成して、
クラス単位で、オーディオファイルを登録したり、SE の種類を登録できるようにしましょう。

　enum、クラスの構成、List など、すべて BGM の際と同じ構成での製作になります。

　必要な情報を考えてから実装してみましょう。

　記述する順番には任意ですが、enum の情報(SE の種類)を SeData クラスで利用し、完成した SeData クラスを List にするので、
下記のような順番で記述していくとよいでしょう。

＜スクリプト内に実装する内容の例＞

　１．SE 用の enum。BulletDamage、GameOver といった再生するタイミングや、シーン名で列挙子を登録しておく
　２．SE を管理する１つ単位でのデータ(通し番号、ボリューム、オーディオファイル、【１】で作成した enum による SE の種類などのデータ群)を扱うクラス
　３．【２】の SE 用のクラスのデータを複数作成してまとめる List(リスト)

SoundDataSO.cs

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

[CreateAssetMenu(fileName = "SoundDataSO", menuName = "Create SoundDataSO")]
public class SoundDataSO : ScriptableObject
{
    /// <summary>
    /// BGM の種類
    /// </summary>
    public enum BgmType {
        Main,
        Boss,
        Silence = 999
    }

　　/// <summary>
    /// BGM 関連の情報を管理するクラス
    /// </summary>
    [Serializable]
    public class BgmData {
        public int no;　　　　　　　　　　// BGM の通し番号
        public BgmType bgmType;　　　　　 // BGM の種類
        public float volume = 0.05f;　　　// BGM のボリューム
        public AudioClip bgmAudioClip;　　// BGM として鳴らすオーディオファイル
    }

    public List<BgmData> bgmDataList = new List<BgmData>();


////*  ここから追加  *////


    /// <summary>
    /// SE の種類
    /// </summary>
    public enum SeType {
        // SE用の列挙子をゲームに合わせて登録
        BulletDamage_1,
        GameClear,
        GameOver,
    }

    /// <summary>
    /// SE 関連の情報を管理するクラス
    /// </summary>
    [Serializable]
    public class SeData {
        public int no;
        public SeType seType;
        public float volume = 0.5f;
        public AudioClip seAudioClip;
    }

    public List<SeData> seDataList = new List<SeData>();


////*  ここまで  *////


}

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

５．SoundDataSO スクリプタブル・オブジェクトに SE 用のデータの設定を行う

　Datas フォルダ内にある SoundDataSO スクリプタブル・オブジェクトを選択してインスペクターを確認します。
SoundDataSO スクリプトにて宣言した seDataList 変数がインスペクターに表示されて、 Sizeが 0 になっています。
SE の種類として登録した列挙子の数に合わせて、seDataList 変数の Size を 3 に変更してください。Element 0 ～ 2 が下に作成されます。

　下記の画像のように設定を行ってみてください。
オーディオファイルは Audio フォルダにある SE 用のオーディオファイルをドラッグアンドドロップしてアサインしてください。

インスペクター画像

　各数値やオーディオファイルは任意ですが、No の値だけは異なる番号で設定してください。できれば 0 から連番が理想です。
この番号はオーディオファイル用の番号として利用する可能性がありますので、同じ番号を重複して設定してしまうと、同じ番号のオーディオファイルが複数存在することになり、
番号によってオーディオファイルを特定することが出来なくなります。

　BGM の再生中に SE が一緒に鳴るようになりますので、あまりに BGM が大きいと SE の音が聴こえないことがあります。
まずは Volume の値も大きめ値にしておいて、BGM と一緒に SE を鳴らしてから調整を行うようにします。
またファイルによっては音量の大小がありますので、実際にファイルを再生して調整を行うことも大切です。

　以上でこの手順は完了です。

８２．SoundManager スクリプトを修正し、SE 用の再生・停止処理を追加する

１．設計

　SoundManager スクリプトも、SoundDataSO スクリプトと同じように、SE の情報を追加して、
再生用のメソッドと停止用のメソッドを用意します。

　SoundManager はシングルトンパターンですので、SE の再生についてもメソッドを呼び出す命令を実行すれば
いずれのスクリプトからでも参照なしで SE を再生することが出来ます。

　BGM の実装を振り返りながら実装を行ってください。
BGM と異なり、SE は重複して鳴るようにすることを前提にしています。

２．SoundManager スクリプトを修正する

　必要な情報を宣言し、メソッドを考えてみてください。
BGM と異なり、SE は重複して鳴るようにすることを前提にしていますので、
それを考えた設計ロジックを考えていくことになります。

SoundManager.cs

using System.Collections;
using UnityEngine;
using DG.Tweening;
using System.Collections.Generic;
using System.Linq;

/// <summary>
/// 音源管理クラス
/// </summary>
public class SoundManager : MonoBehaviour {

    public static SoundManager instance;

    public SoundDataSO soundDataSO;
    
    public const float CROSS_FADE_TIME = 1.0f;  // クロスフェード時間

    // ボリューム関連
    public float bgmVolume = 0.1f;
    public float seVolume = 0.2f;
    public float voiceVolume = 0.2f;
    public bool isMute = false;

    // 各オーディオファイル再生用の AudioSource
    private AudioSource[] bgmSources = new AudioSource[2];


////*  ここから追加  *////


　　// SE 用の AudioSource コンポーネントを代入するための変数の宣言。複数用意しているのは、重複して鳴ることを想定
    private AudioSource[] seSources = new AudioSource[10];


////*  ここまで  *////


    private bool isCrossFading;　　　　　　　// クロスフェード処理中かどうか判定用


    void Awake() {
        // シングルトンかつ、シーン遷移しても破棄されないようにする
        if (instance == null) {
            instance = this;
            DontDestroyOnLoad(gameObject);
        } else {
            Destroy(gameObject);
        }

        // BGM用 AudioSource追加
        bgmSources[0] = gameObject.AddComponent<AudioSource>();
        bgmSources[1] = gameObject.AddComponent<AudioSource>();
        bgmSources[1].volume = 0;


////*  ここから追加  *////


        // SE用の AudioSource追加
        for (int i = 0; i < seSources.Length; i++) {
            seSources[i] = gameObject.AddComponent<AudioSource>();
        }


////*  ここまで  *////


    }

    /// <summary>
    /// BGM再生
    /// </summary>
    /// <param name="bgmType"></param>
    /// <param name="loopFlg"></param>
    public void PlayBGM(SoundDataSO.BgmType newBgmType, bool loopFlg = true) {

        // BGMを Silence の状態にする場合            
        if ((int)newBgmType == 999) {
            StopBGM();
            return;
        }

　　　　// 再生する BGM 用の BgmData を取得
        SoundDataSO.BgmData newBgmData = null;
        foreach (SoundDataSO.BgmData bgmData in soundDataSO.bgmDataList.Where(x => x.bgmType == newBgmType)) {
            newBgmData = bgmData;
            break;
        }

　　　　// 対象となるデータがなければ処理しない
        if (newBgmData == null) {
            return;
        }

        // 同じBGMの場合は何もしない
        if (bgmSources[0].clip != null && bgmSources[0].clip == newBgmData.bgmAudioClip) {
            return;
        } else if (bgmSources[1].clip != null && bgmSources[1].clip == newBgmData.bgmAudioClip) {
            return;
        }

        // フェードでBGM開始
        if (bgmSources[0].clip == null && bgmSources[1].clip == null) {
            bgmSources[0].loop = loopFlg;
            bgmSources[0].clip = newBgmData.bgmAudioClip;
            bgmSources[0].volume = newBgmData.volume;
            bgmSources[0].Play();
        } else {
            // クロスフェード処理を利用して BGM を切り替え
            StartCoroutine(CrossFadeChangeBMG(newBgmData, loopFlg));
        }
    }

    /// <summary>
    /// BGMのクロスフェード処理
    /// </summary>
    /// <param name="bgmData"></param>
    /// <param name="loopFlg">ループ設定。ループしない場合だけfalse指定</param>
    /// <returns></returns>
    private IEnumerator CrossFadeChangeBMG(SoundDataSO.BgmData bgmData, bool loopFlg) {
        isCrossFading = true;

        if (bgmSources[0].clip != null) {
            // [0]が再生されている場合、[0]の音量を徐々に下げて、[1]を新しい曲として再生
            bgmSources[1].DOFade(bgmData.volume, CROSS_FADE_TIME).SetEase(Ease.Linear);
            bgmSources[1].clip = bgmData.bgmAudioClip;
            bgmSources[1].loop = loopFlg;
            bgmSources[1].Play();
            bgmSources[0].DOFade(0, CROSS_FADE_TIME).SetEase(Ease.Linear);

            yield return new WaitForSeconds(CROSS_FADE_TIME);
            bgmSources[0].Stop();
            bgmSources[0].clip = null;
        } else {
            // [1]が再生されている場合、[1]の音量を徐々に下げて、[0]を新しい曲として再生
            bgmSources[0].DOFade(bgmData.volume, CROSS_FADE_TIME).SetEase(Ease.Linear);
            bgmSources[0].clip = bgmData.bgmAudioClip;
            bgmSources[0].loop = loopFlg;
            bgmSources[0].Play();
            bgmSources[1].DOFade(0, CROSS_FADE_TIME).SetEase(Ease.Linear);

            yield return new WaitForSeconds(CROSS_FADE_TIME);
            bgmSources[1].Stop();
            bgmSources[1].clip = null;
        }
        isCrossFading = false;
    }

    /// <summary>
    /// BGM完全停止
    /// </summary>
    public void StopBGM() {
        bgmSources[0].Stop();
        bgmSources[1].Stop();
        bgmSources[0].clip = null;
        bgmSources[1].clip = null;
    }

    /// <summary>
    /// BGM一時停止
    /// </summary>
    public void MuteBGM() {
        bgmSources[0].Stop();
        bgmSources[1].Stop();
    }

    /// <summary>
    /// 一時停止した同じBGMを再生(再開)
    /// </summary>
    public void ResumeBGM() {
        bgmSources[0].Play();
        bgmSources[1].Play();
    }


////*  ここから追加  *////


    /// <summary>
    /// SE再生
    /// </summary>
    /// <param name="seType"></param>
    public void PlaySE(SoundDataSO.SeType newSeType) {

　　　　// 再生する SE 用の SeData を取得
        SoundDataSO.SeData newSeData = null;
        foreach (SoundDataSO.SeData seData in soundDataSO.seDataList.Where(x => x.seType == newSeType)) {
            newSeData = seData;
            break;
        }

        // 再生中ではないAudioSouceをつかってSEを鳴らす
        foreach (AudioSource source in seSources) {
            if (source.isPlaying == false) {
                source.clip = newSeData.seAudioClip;
                source.volume = newSeData.volume;
                source.Play();
                return;
            }
        }
    }

    /// <summary>
    /// SE停止
    /// </summary>
    public void StopSE() {
        // 全てのSE用のAudioSouceを停止する
        foreach (AudioSource source in seSources) {
            source.Stop();
            source.clip = null;
        }
    }


////*  ここまで  *////


}

　スクリプトを修正したらセーブします。

３．＜オーディオファイルの容量圧縮やメモリ使用の設定＞

　多くの BGM や SE を Unity にインポートして、それらをゲーム内で利用する場合、
オーディオファイルの数が増える程、アプリの容量は増え、メモリも圧迫していきます。

　インポートしたオーディオファイルには、これらの部分を設定できる項目があります。
モノラルに切り替えたり、ゲーム実行時ではなく、再生するタイミングでファイルを読み込むようしたりなど、
現在制作しているゲームに沿った設定変更が可能です。

　ゲーム製作に慣れてきたら、こういったメモリの負荷の部分などにもフォーカスしていきましょう。
他の処理にも言えることですが、Unity の公式マニュアルや公式スクリプトリファレンスには一度目を通して学習しておきましょう。

参考サイト

Unity公式マニュアル
オーディオクリップ
https://docs.unity3d.com/ja/2018.4/Manual/class-Au...

すくまりのメモ帳様
【Unity】重複ありのBGMの鳴らし方「Play()」「PlayOneShot()」
https://squmarigames.com/2018/12/19/unity-beginner...

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

　ゲームを実行してみてください。Awake メソッドの処理が実行されて、SE 用の AudioSource コンポーネントが新しく10個追加されます。(合計12個)

SoundManager ゲームオブジェクト　インスペクター画像

　それでは最後に SE を鳴らす処理を実装していきます。

８３．適宜なタイミングに合わせて SE を再生する処理を実装する

１．設計

　今回追加した SE の再生処理を適宜なタイミングで鳴るように、自分のスクリプトに処理を追加してみましょう。

　メソッドの呼び出し命令は BGM の再生の場合と同じです。引数の型の指定が SeType になっています。

  // ゲームオーバーのSE
  SoundManager.instance.PlaySE(SoundDataSO.SeType.GameOver);

　どの場面で SE を鳴らすか、SE の種類に合わせて処理を追加してください。
また、ゲームオーバーの場合などは、SE を再生する直前に BGM を無音（Silence）や停止しておくことで BGM がなくなり、
SE のみを再生するという演出を行うことが出来ます。

　色々な処理の記述をして、どのような挙動になるかを体験してください。

　
　以上でこの手順は終了です。

　次は　発展４１　－ボイスの再生－　です。