ゲーム終了処理を追加する

ゲーム終了処理を追加する方法

　特定のボタン(PCだとESCボタンなど)を押した際に、ゲームを終了させる方法を設計し、実装していきます。
ゲームを終了させる機能にはUnityの用意しているApplication.Quitメソッドを利用します。
このメソッドを呼び出す際には、基本的には２つの方法が考えられます。

１．ボタンを押したら、すぐにゲームを終了する方法(各シーンごとにスクリプトに用意する)
２．ボタンを押したら、ゲーム終了を確認するポップアップが開いて、その中でさらにボタンを押すことでゲームを終了する方法

　今回は１と２の両方の手順を順番に紹介します。

　Application.Quitメソッドについては公式情報もご確認ください。

Unity公式スクリプティング・マニュアル
Application.Quit
https://docs.unity3d.com/ScriptReference/Applicati...

１．ボタンを押したら、すぐにゲームを終了する方法(各シーンごとにスクリプトに用意する)

　ゲームを実行しているシーンに存在しているいずれかのスクリプトのUpdateメソッドに、以下の処理を追加します。
もしもスクリプト内にUpdateメソッドがない場合にはUpdateメソッド自体を追加しましょう。
Updateメソッドがある場合には、if以下の処理を追加します（間違えてUpdateメソッドを２つ作らないようにしてください。）

　どのスクリプトのUpdateメソッドに追加しても構いませんが、ゲーム管理に関わる処理ですので、GameMaster、GameManager、GameDirectorといった
ゲームの種類に応じた管理用などのスクリプトに追加しておくとよいと思います。

void Update()
{
    if (Input.GetKeyDown(KeyCode.Escape)) {
#if UNITY_EDITOR
        UnityEditor.EditorApplication.isPlaying = false;   // UnityEditorの実行を停止する処理
#else
        Application.Quit();                                // ゲームを終了する処理
#endif
    }
}

＜スクリプト補足＞

　#if,#else,#endif は、ゲームの実行環境(プラットフォーム)に応じて処理を分岐する処理です。
上記の場合であれば、UnityEditor（開発環境）と、それ以外（WebGL、スマホ端末、PC）の環境によって、ゲーム終了の処理が自動的に分岐されて終了するようになっています。

　if文の条件で使用している「KeyCode.Escape」ですが、キーボードの場合にはESCボタン、アンドロイド端末の場合にはバックキー（戻るボタン）がこちらの処理の対象となります。
そのため、この一文の条件で、スマホ端末にも対応することが出来ます。　

　この実装方法にも少々問題点があり、例えば、シーンが３つあるような場合には、それぞれのシーンの各スクリプトにこの処理を追加しないとなりません。
（Title,Game,Resultとシーンがあるのであれば、Titleシーンにある１つのスクリプトに処理を追加、Gameシーンにある１つのスクリプトに処理を追加、というように）

　ゲームシーンが１つしかないような場合や、デバッグ用にゲーム終了処理を試してみたい場合にはこの実装方法でもよいと思いますが、
複数のシーンでゲーム終了を対応したい場合には不便ですので、ゲーム製作に慣れてきましたら別の実装方法も検討してみましょう。

２．ボタンを押したら、ゲーム終了を確認するポップアップが開いて、その中でさらにボタンを押すことでゲームを終了する方法

　設計としましてはESCボタン（バックボタン）を押した際に、すぐにゲームを終了するのではなく
ポップアップを開いて、その中でゲームの終了か、ゲームに戻るかを選択できるようにボタンを用意します。

　ゲームの終了を選択することでゲームが終了となり、ゲームに戻るを選択した場合にはポップアップを閉じて（破壊して）ゲームを再開します。

　ポイントとしては、ポップアップが開く（生成される）と同時に、ゲームの進行が一時停止する処理を加えている点です。
この処理がないと、ポップアップが開いている裏側でゲームが進行してしまい、予期していない挙動になってしまいます。

　そのため、ポップアップが開いている間はゲームの進行がストップし、ゲームを再開する場合には、再度ゲームの進行を再開するように処理を行います。

　実装の手順です。

１．ゲーム終了確認用ポップアップを作成する
２．ゲーム終了確認用ポップアップにアタッチするスクリプトを作成する
３．２のスクリプトを１のゲームオブジェクトにアタッチし、情報をアサインしてからプレファブにする
４．管理用スクリプトにゲーム終了確認用ポップアップを生成する処理を追加する
５．４のスクリプトがアタッチされているゲームオブジェクトにゲーム終了確認用ポップアップのプレファブをアサインして登録する

１．ゲーム終了確認用ポップアップを作成する

　色々なコンポーネントを持つゲームオブジェクトを組み合わせて、ゲーム終了確認用のポップアップ・ゲームオブジェクト（以下、ポップアップ）を作成します。

　このポップアップはCanvasの中に生成されるようにしますので、まずはヒエラルキーにCanvasを作成します。すでにある場合にはそれを利用します。

　Canvas上でメニューを表示して Create Empty を選択し、名前を QuitCheckPopUp に変更します。これはフォルダ代わりに利用します。

　その後、QuitCheckPopUpの子オブジェクトとして、Image（UI => Image）、Text(UI => Text)、Create Empty の３つのゲームオブジェクトを作成します。

　Imageの名前は imgBackGround に変更します。これはポップアップの背景画像の設定用に利用します。自由なイメージを設定してください。(例ではUnityのBackGroundイメージを設定)

　Textの名前は、txtMessage に変更します。Textコンポーネント内のTextプロパティ欄に「ゲームを終了しますか？」と入力し、画面に確認用メッセージを表示させます。

　
　Create Emptyの名前は Buttons に変更します。これはボタンを入れるためのフォルダ代わりに利用します。

　Buttonsの子オブジェクトとして、Button(UI => Button)のゲームオブジェクトを２つ作成します。名前はそれぞれ btnQuitGame 、btnClosePopUp に変更します。

　btnQuitGameゲームオブジェクトの子であるTextのTextプロパティ欄には「終了する」と入力します。

　btnClosePopUpゲームオブジェクトの子であるTextのTextプロパティ欄には「ゲームに戻る」と入力します。
どちらも文字の大きさ、フォント、位置などは適宜設定します。

　以下に、ヒエラルキーでの状態と、各ゲームオブジェクトのインスペクターの画像を添付しますので、参考にしてください。
　

ヒエラルキー

QuitCheckPopUp

btnQuitGameと、子のText

btnClosePopUpと、子のText

２．ゲーム終了確認用ポップアップにアタッチするスクリプトを作成する

　１で作成したポップアップにアタッチするためのスクリプトを作成します。名前もポップアップと同じにしておきます。

QuitCheckPouUp.cs

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

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

public class QuitCheckPouUp : MonoBehaviour
{
    public Button btnQuitGame;        // ゲーム終了ボタン
    public Button btnClosePopup;      // ポップアップを閉じてゲームに戻るボタン

    void Start()
    {
        // 各ボタンに処理を登録
        //①btnQuitGame.onClick.AddListener(GameDirector.QuitGame);　　<=　次の手順でメソッドを作成するので、一旦コメントアウト。
        //②btnQuitGame.onClick.AddListener(GameManager.QuitGame);     <=  ①か②のいずれかを利用します。引数内のスクリプト名の指定は自分で利用している管理用のスクリプト名にしてください。

        btnClosePopup.onClick.AddListener(OnClickClosePopUp);

        // ゲーム内時間の流れを停止
        Time.timeScale = 0;
    }

    /// <summary>
    /// ポップアップを閉じてゲームに戻る
    /// </summary>
    private void OnClickClosePopUp() {
        // ゲーム内時間の流れを再開する
        Time.timeScale = 1.0f;
        Destroy(gameObject);
    }
}

３．２のスクリプトを１のゲームオブジェクトにアタッチし、情報をアサインしてからプレファブにする

　１のポップアップに、２のスクリプトをアタッチしましょう。インスペクターを確認し、必要な情報をアサインします。
Buttonコンポーネントを２つ登録できますので、それらを同じ名前の場所にドラッグアンドドロップしてアサインします。

参考動画
https://gyazo.com/bf5113a2d52b12bdd04b19490133f422

　無事にアサインできたら、このポップアップをプレファブにします。
(Canvasごとプレファブにするのではなくて、Canvasの子であるQuitCheckPopUpゲームオブジェクトをプレファブにします。)
プレファブ化したら、ヒエラルキーからは削除しておきます。

４．管理用スクリプトにゲーム終了確認用ポップアップを生成する処理を追加する

　すでにある管理用スクリプトで対応してください。どちらでも問題ありません。そういった管理用のスクリプトがない場合にはGameDirectorスクリプトを作成して、処理を書いてください。

GameDirector(あるいは、GameMasterがあるのであれば、そちらに記述してください)

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

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

public class GameDirector : MonoBehaviour
{
    public QuitCheckPouUp quitCheckPouUpPrefab;
    public Transform canvasTran;

    void Update()
    {
        if (Input.GetKeyDown(KeyCode.Escape)) {
            // 終了確認用のポップアップを生成する。そのポップアップの中で終了確認を行う
            Instantiate(quitCheckPouUpPrefab, canvasTran, false);
        }
    }

    /// <summary>
    /// ゲームの終了処理(staticメソッドにしておくことで、終了確認用ポップアップからも呼び出せる)
    /// </summary>
    public static void QuitGame() {
#if UNITY_EDITOR
        UnityEditor.EditorApplication.isPlaying = false;
#else
    Application.Quit();
#endif
    }
}

５．４のスクリプトがアタッチされているゲームオブジェクトにゲーム終了確認用ポップアップのプレファブをアサインして登録する

　管理用のスクリプトがアタッチされているゲームオブジェクトのインスペクターを確認してください。
先ほど４で処理を追加したため、アサイン情報が２つ追加されています。

　１つは、Project内のプレファブにしたポップアップをドラッグアンドドロップしてアサインします。
　もう一つはこのポップアップを生成する位置を登録します。ヒエラルキーにあるCanvasゲームオブジェクトをドラッグアンドドロップしてアサインします。

　以上で完成です。

　まずは、２の手順で QuitCheckPopUp スクリプト内のコメントアウトしてある処理のコメントアウトを解除してください。

　ゲームを実行して、ESCボタンを押してみてください。ポップアップが生成されれば成功です。
このとき、ゲーム内の処理が一時ストップ状態になっているかも確認してください。

　それぞれのボタンを押して、ゲーム終了が正常に終了するか、ちゃんとポップアップが破壊されてゲームが再開されるかどうか、を確認します。

<実装動画（画面に表示されている時間の経過が一時ストップし、再開するのがわかると思います。）>
https://gyazo.com/56a637b9354fe701922120a4836ad847

【修正してみましょう】

　この状態のままですと、ポップアップを開いている際に再度ESCボタンを押すと、さらに追加のポップアップが開いてしまいます。
常に１つしかポップアップを生成しないようにするにはどうすればいいか、考えて実装をしてみましょう。

　実装例を提示しておきます。他にも方法はありますので、ご自分の考えで実装をしてから確認してみてください。

GameDirector(あるいは、GameMasterがあるのであれば、そちらに記述してください)

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

public class GameDirector : MonoBehaviour
{
    public QuitCheckPouUp quitCheckPouUpPrefab;    // プレファブ
    public Transform canvasTran;                   // プレファブを生成する地点

    private QuitCheckPouUp quitCheckPouUp = null;      // プレファブから生成したポップアップを代入する変数を宣言フィールドに追加

void Update()
{
    if (Input.GetKeyDown(KeyCode.Escape)) {
        if (quitCheckPouUp == null) {    // if文を追加。ポップアップが生成されていない(変数が空)なら
            // （ポップアップが生成されていない場合だけ）終了確認用のポップアップを生成して変数にいれる
            quitCheckPouUp = Instantiate(quitCheckPouUpPrefab, canvasTran, false);             // 変数に代入する処理を追加。生成＝値が入る。空ではなくなる
        }
    }
}

　このquitCheckPouUp変数は、ポップアップが破棄されると同時に自動的に空になります。
そのため再度、if文の条件を満たすようになってポップアップが生成可能になります。

＜応用＞シーン遷移しても破棄されないゲームオブジェクトを作成し、ゲームを終了する処理を用意する方法

　１と２の処理の両方を自動で分岐する処理を持ったスクリプトを作成し、そのスクリプトに、シーン遷移しても破棄されないゲームオブジェクトを作成する処理を記述します。
こうすることで、いずれのゲームシーンにもゲーム終了の命令を呼び出せるゲームオブジェクトを常に配置して、そのスクリプトがゲーム終了処理を専用で受け持つようにする設計です。

QuitGameManager.cs

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

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

public class QuitGameManager : MonoBehaviour
{
    public QuitCheckPouUp quitCheckPouUpPrefab;
    public Transform canvasTran;

    private QuitCheckPouUp quitCheckPouUp

    void Awake(){
　　　　// このスクリプトをアタッチしているゲームオブジェクトがシーン遷移しても破棄されないようにする
        DontDestroyOnLoad(gameObject);
    }

    void Update()
    {
        if (Input.GetKeyDown(KeyCode.Escape)) {
            if (quitCheckPouUp == null) {
                // 終了確認用のポップアップを生成する。そのポップアップの中で終了確認を行う
                Instantiate(quitCheckPouUpPrefab, canvasTran, false);
            } 
        }
    }

    /// <summary>
    /// ゲームの終了処理
    /// </summary>
    public static void QuitGame() {
#if UNITY_EDITOR
        UnityEditor.EditorApplication.isPlaying = false;
#else
    Application.Quit();
#endif
    }
}

　スクリプトを作成したら、次に、ゲームを開始するシーン（Titleなど）のヒエラルキー上に UI => Canvas でCanvas ゲームオブジェクトを作成し、名前をQuitGameManagerに変更します。
QuitGameManagerゲームオブジェクトに、いま作成したQuitGameManagerスクリプトをアタッチします。
これでこのゲームオブジェクトは、シーン遷移をしても破棄されずに、ゲームシーンに残るゲームオブジェクトになります。

　QuitGameManager ゲームオブジェクトのインスペクターにおいて、QuitCheckPopUp スクリプトを確認してください。
アサイン情報が２つ表示されていますので、順番にアサインします。
　
　quitCheckPopUp 変数には、Prefabs フォルダにある QuitCheckPopUp ゲームオブジェクトをドラッグアンドドロップしてアサインしてください。
　canvasTran 変数に、QuitGameManager ゲームオブジェクトの Canvas コンポーネントをドラッグアンドドロップしてアサインしてください。

　ゲームを起動し、Titleシーンが始まると、シーンと同じマークのDontDestroyOnLoadがヒエラルキーに追加され、そのシーンを開くと
このゲームオブジェクトがそちらに含まれていることが分かります。この状態になっていれば成功です。Titleから次のシーンへ遷移しても
このDontDestroyOnLoad内にあるゲームは破棄されずに残ります。

　そのため、いずれのシーンにもQuitGameManagerゲームオブジェクトが存在するようになり、そのゲームオブジェクトに
ゲーム終了処理が記述されていますので、どのシーンからでもEscキー(スマホの戻るボタン)を押すことでゲームを終了（あるいは終了確認のポップアップが開く）する処理が実装できます。

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

印刷する

コメント（0）

ゲーム終了処理を追加する - i-school 先頭へ

コメントをかく

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

i-school