【Unity】ボタンを押したらシーン遷移する実装を簡単に作れるSceneControllerの紹介

概要

ボタンを押したらシーン遷移する実装で毎度使っている SceneController コンポーネントを紹介します。

説明

ボタンの UnityEvent などで LoadScene() 等の関数を追加して使用します。

項目	説明
ProcessOnAwake	このコンポーネントがはじめて有効になった時に実行する処理
SceneName	対象となるシーン名
Delay	実行までにかかる時間

Public関数	説明
LoadScene()	[Delay]秒後、[SceneName]に遷移
LoadScene(float)	[float]秒後、[SceneName]に遷移
LoadScene(string)	[Delay]秒後、[string]に遷移
LoadAddScene()	[Delay]秒後、[SceneName]を追加
LoadAddScene(float)	[float]秒後、[SceneName]を追加
LoadAddScene(string)	[Delay]秒後、[string]を追加
UnloadScene()	[Delay]秒後、[SceneName]を破棄
UnloadScene(float)	[float]秒後、[SceneName]を破棄
UnloadScene(string)	[Delay]秒後、[string]を破棄

コード

SceneController.cs

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

public class SceneController : MonoBehaviour
{
    enum ProcessOnAwake
    {
        None,
        LoadScene,
        AddScene,
        UnloadScene
    }

    [SerializeField] ProcessOnAwake processOnAwake;
    [SerializeField] string sceneName;
    [SerializeField] float delay;

    private void Start()
    {
        switch (processOnAwake)
        {
            case ProcessOnAwake.LoadScene: LoadScene(); break;
            case ProcessOnAwake.AddScene: LoadAddScene(); break;
            case ProcessOnAwake.UnloadScene: UnloadScene(); break;
        }
    }

    /// <summary>
    /// シーン移動
    /// </summary>
    /// <param name="sceneName">シーン名</param>
    /// <param name="delay">遅延時間</param>
    public void LoadScene(string sceneName, float delay)
    {
        AsyncOperation operation = SceneManager.LoadSceneAsync(sceneName);
        operation.allowSceneActivation = false;
        StartCoroutine(DelayedCall(delay, () => operation.allowSceneActivation = true));
    }
    public void LoadScene(string sceneName) => LoadScene(sceneName, delay);
    public void LoadScene(float delay) => LoadScene(sceneName, delay);
    public void LoadScene() => LoadScene(sceneName, delay);

    /// <summary>
    /// シーン追加
    /// </summary>
    /// <param name="sceneName">シーン名</param>
    /// <param name="delay">遅延時間</param>
    public void LoadAddScene(string sceneName, float delay)
    {
        AsyncOperation operation = SceneManager.LoadSceneAsync(sceneName, LoadSceneMode.Additive);
        operation.allowSceneActivation = false;
        StartCoroutine(DelayedCall(delay, () => operation.allowSceneActivation = true));
    }
    public void LoadAddScene(string sceneName) => LoadAddScene(sceneName, delay);
    public void LoadAddScene(float delay) => LoadAddScene(sceneName, delay);
    public void LoadAddScene() => LoadAddScene(sceneName, delay);

    /// <summary>
    /// シーン破棄
    /// </summary>
    /// <param name="sceneName">シーン名</param>
    /// <param name="delay">遅延時間</param>
    public void UnloadScene(string sceneName, float delay)
    {
        AsyncOperation operation = SceneManager.UnloadSceneAsync(sceneName);
        operation.allowSceneActivation = false;
        StartCoroutine(DelayedCall(delay, () => operation.allowSceneActivation = true));
    }
    public void UnloadScene(string sceneName) => UnloadScene(sceneName, delay);
    public void UnloadScene(float delay) => UnloadScene(sceneName, delay);
    public void UnloadScene() => UnloadScene(sceneName, delay);

    /// <summary>
    /// 遅延処理
    /// </summary>
    /// <param name="second">遅延時間</param>
    /// <param name="action">処理内容</param>
    /// <returns></returns>
    private IEnumerator DelayedCall(float second, Action action)
    {
        yield return new WaitForSeconds(second);
        action.Invoke();
    }
}