Unity:クリッカーゲームを作ってみたい/06-リファクタリング（ソースコードとオブジェクト関係の整理） - 節電鯖民の遊び場

目次

前提

• Unity:クリッカーゲームを作ってみたい/05-マウスオーバーで表示されるメニューとSave＆Load機能をつけるの続き

概要

• 今後の拡張を見据えて、少し雑になっていたオブジェクト関係を見直し
• それに伴いスクリプトの内容も見直し
  • 茜ちゃん関連の操作は、トップレベルにいる AkaneController オブジェクトに実行させる
  • 葵ちゃん関連の操作は、トップレベルにいる AoiController オブジェクトに実行させる
  • AkaneController/AoiController は GameController からのカウント変更通知を受けて動作させる

スクリプトを見直す

ICounterReceiver

• 変更無し

詳細を開く

public interface ICounterReceiver
{
    public void UpdateCounter(int count);
}
 

Click

• クリックしたら GameController にインクリメントを依頼するだけの処理に変更
• 茜ちゃんの Click スクリプトコンポーネントは削除し、GameController オブジェクトに Click スクリプトを付け替え。

詳細を開く

using UnityEngine;
 
public class Click : MonoBehaviour
{
    GameController gameCtrl;
 
    void Start() {
        gameCtrl = GameObject.FindObjectOfType<GameController>();
    }
    void Update() {
        if (!gameCtrl.clickable) {
            return;
        }
        if (Input.GetMouseButtonDown(0)) {
            // クリック数をインクリメントし、ゲームコントローラー経由で全体に通知する
            gameCtrl.IncrementCount();
        }
    }
}
 

GameController

• 本クラスで実施していた葵ちゃん制御関連の関数は、AoiController に移動
• AoiController/AkaneController は本オブジェクトの counterReceivers にインスペクターから登録するよう変更

詳細を開く

using System.Collections.Generic;
using UnityEngine;
 
public class GameController : MonoBehaviour
{
    public static GameController instance;
 
    // カウンタの通知を受けるオブジェクトのリスト(インスペクターより登録)
    public List<GameObject> counterReceivers;
    public bool clickable;
    int clickCount;
    Click click;
 
    void Awake() {
        // シーンを跨いでGameControllerがいた場合用にシングルトン実装
        if (instance == null) { instance = this; }
        else { Destroy(gameObject); }
    }
    void Start() {
        // オブジェクトを永続化
        DontDestroyOnLoad(gameObject);
        clickable = true;
        click = GameObject.FindObjectOfType<Click>();
    }
    void notifyCount(int count) {
        // 指定されたカウント値を、登録オブジェクト全てに通知
        foreach (GameObject obj in counterReceivers) {
            ICounterReceiver receiver = obj.GetComponent<ICounterReceiver>();
            if (receiver != null) {
                receiver.UpdateCounter(count);
            }
        }
    }
    public void IncrementCount() {
        // カウンタをインクリメントして、登録オブジェクト全てに通知
        clickCount++;
        notifyCount(clickCount);
    }
    public void SetCount(int count) {
        // 設定されたカウンタ値を、登録オブジェクト全てに通知
        clickCount = count;
        notifyCount(clickCount);
    }
    public int GetCount() {
        // カウンタ値を返却
        return clickCount;
    }
}
 

AkaneController

• 茜ちゃん制御用のクラスを新規作成
• Clickで実施していたアニメーションの制御を本クラスに移動し、UpdateCounter(カウンタ変更通知)で実施するよう変更

詳細を開く

using UnityEngine;
 
public class AkaneController : MonoBehaviour, ICounterReceiver
{
    public GameObject akane;
    Animator anime;
 
    void Start()
    {
        anime = akane.GetComponent<Animator>();
    }
    public void UpdateCounter(int count) {
        // 数値変動に応じてアニメーションする
        anime.SetTrigger("click_cancel");
        anime.SetTrigger("click");
    }
}
 

AoiController

• 葵ちゃんを生成する処理及び数の調整用関数を本クラスに移動
• それに伴い葵ちゃんを生成する位置は、外部から GameObject を登録する事で同座標に出現させるよう変更
• 葵ちゃんは AoiController 配下に生成されるよう変更し、検索も AoiController 配下のオブジェクトをカウントするよう変更

詳細を開く

using UnityEngine;
 
public class AoiController : MonoBehaviour, ICounterReceiver
{
    public GameObject prefab;       // 生成するprefab を簡単に差し替えできるよう public で外部から変更できるようにしておく
    public GameObject posTarget;    // 葵ちゃんを出現させる地点をオブジェクトで指定する
 
    // 速度は適切な速度を探れるように、publicで外部から変更できるようにしておく
    public float prefabSpeed = 1000;
    public float prefabTorque = 300;
 
    public void UpdateCounter(int count) {
        // 数値変動に応じて葵ちゃんの数を増減させる
        AdjustAoiChan(count);
    }
    public void spawnAoi() {
        // prefab からインスタンスを生成
        GameObject aoi = Instantiate(prefab, posTarget.transform.position, Quaternion.identity);
        Rigidbody2D aoiBody = aoi.GetComponent<Rigidbody2D>();
 
        // 葵ちゃんの親を AoiController に設定する
        aoi.transform.SetParent(gameObject.transform);
 
        // 上方向のランダムな方向を決定
        Vector2 direction = Random.insideUnitCircle.normalized;
        direction.y = Mathf.Abs(direction.y);
 
        // ランダムな回転速度を決定、整数にしたとき2で割り切れない場合は逆回転にする
        float torque = Random.value;
        if ((int)(torque*100) % 2 == 1) {
            torque *= -1;
        }
 
        // 生み出した葵ちゃんに力を与える
        aoiBody.AddForce(direction * prefabSpeed, ForceMode2D.Force);
        aoiBody.AddTorque(torque * prefabTorque, ForceMode2D.Force);
    }
    void AdjustAoiChan(int target) {
        // 今いる葵ちゃんの数をカウント
        int now = transform.childCount;
 
        //  今いる人数の方が多い場合は葵ちゃんには消えてもらう
        foreach (Transform aoi in transform) {
            if (now <= target) {
                break;
            }
            Destroy(aoi.gameObject);
            now--;
        }
        // 今いる人数の方が少ない場合は葵ちゃんを生み出す
        while (now < target) {
            spawnAoi();
            now++;
        }
    }
}
 

CounterTextController

• 変更無し

詳細を開く

using UnityEngine;
using TMPro;
 
public class CounterTextController : MonoBehaviour, ICounterReceiver
{
    TextMeshProUGUI tmp;
 
    void Start()
    {
        tmp = gameObject.GetComponent<TextMeshProUGUI>();
    }
    public void UpdateCounter(int count) {
        tmp.text = count + " あおい～";
    }
}
 

MenuMouseOver

• 変更無し

詳細を開く

using UnityEngine;
 
public class MenuMouseOver : MonoBehaviour
{
    Animator anime;
    GameController gameCtrl;
    private void Start() {
        gameCtrl = GameObject.FindObjectOfType<GameController>();
        anime = gameObject.GetComponent<Animator>();
    }
    void OnMouseEnter()
    {
        anime.SetTrigger("open");
        gameCtrl.clickable = false;
    }
    void OnMouseExit()
    {
        anime.SetTrigger("close");
        gameCtrl.clickable = true;
    }
}
 

TriggerDestroy

• 葵ちゃん削除用の壁の名前を "Dead" で始まるように変更し、削除用の壁に触れたときのみ削除するよう判定を修正
  • これによりメニューパネルの　Collider で IsTrigger 設定を有効(接触判定を無効)にしても誤削除がされなくなる

詳細を開く

using UnityEngine;
 
public class TriggerDestroy : MonoBehaviour
{
    void OnTriggerEnter2D(Collider2D other) {
        if (other.name.StartsWith("Dead")) {
            Destroy(gameObject);
        }
    }
}
 

Save

• 変更無し

詳細を開く

using UnityEngine;
using TMPro;
 
public class Save : MonoBehaviour
{
    GameController gameCtrl;
    TextMeshProUGUI tmp;
 
    void Start()
    {
        gameCtrl = GameObject.FindObjectOfType<GameController>();
        tmp = GameObject.FindObjectOfType<CounterTextController>().gameObject.GetComponent<TextMeshProUGUI>();
    }
    public void OnClick() {
        PlayerPrefs.SetInt("Count", gameCtrl.GetCount());
        PlayerPrefs.Save();
        tmp.text += "(せーぶしました)";
    }
}
 

Load

• GameController に最新の数値を通知するのみの処理に変更 (GameController による全体へのカウンタ更新通知で反映される)

詳細を開く

using UnityEngine;
using TMPro;
 
public class Load : MonoBehaviour
{
    GameController gameCtrl;
    TextMeshProUGUI tmp;
    void Start()
    {
        gameCtrl = GameObject.FindObjectOfType<GameController>();
        tmp = GameObject.FindObjectOfType<CounterTextController>().gameObject.GetComponent<TextMeshProUGUI>();
    }
    public void OnClick() {
        // 葵ちゃんの数を調整する
        int target = PlayerPrefs.GetInt("Count");
        gameCtrl.SetCount(target);
        tmp.text += "(ろーどしました)";
    }
}
 

Reset

• GameController にカウンタ 0 を通知するのみの処理に変更 (GameController による全体へのカウンタ更新通知で反映される)

詳細を開く

using UnityEngine;
using TMPro;
 
public class Reset : MonoBehaviour
{
    GameController gameCtrl;
    TextMeshProUGUI tmp;
    void Start()
    {
        gameCtrl = GameObject.FindObjectOfType<GameController>();
        tmp = GameObject.FindObjectOfType<CounterTextController>().gameObject.GetComponent<TextMeshProUGUI>();
    }
    public void OnClick() {
        // 葵ちゃんの数をリセットする
        gameCtrl.SetCount(0);
        tmp.text += "(りせっとしました)";
    }
}
 

Clear

• 変更無し

詳細を開く

using UnityEngine;
using TMPro;
 
public class Clear : MonoBehaviour
{
    TextMeshProUGUI tmp;
 
    void Start()
    {
        tmp = GameObject.FindObjectOfType<CounterTextController>().gameObject.GetComponent<TextMeshProUGUI>();
    }
    public void OnClick() {
        PlayerPrefs.DeleteKey("Count");
        tmp.text += "(せーぶをクリアしました)";
    }
}
 

オブジェクトの関連付け等を見直す

オブジェクト名の変更と位置変更

• 葵ちゃんを削除する機能を持った壁類はDeadで始まるように変更
  • それ以外は任意
• AkaneController/AoiController を追加
• 茜オブジェクトは AkaneController 配下に変更 ※葵ちゃんもAoiController配下に作成される

詳細を開く

各種設定変更

パネルと葵ちゃんの接触判定を削除 + メニューマウスオーバーが葵ちゃんを誤検出しないよう修正

• IsTriggerの有効化
  • これによりメニューと葵ちゃんが接触しなくなるよう変更
• 葵ちゃんのPrefabを Ignore Raycast レイヤーに変更
  • これによりメニューと重なってもマウスオーバーを誤検出しなくなる

詳細を開く

GameController のスクリプト設定

• リストに AkaneController と AoiController のオブジェクトを追加
  • これにより茜ちゃん葵ちゃん関連の処理は、カウンタ値の更新通知で駆動するように変更
• 茜ちゃんに付けていた Click スクリプトを剥がして本オブジェクトに付け替え(茜ちゃんと言うより画面のクリックなので)

詳細を開く

AoiController にクリック時に出現させる葵ちゃんのPrefabと出現位置を登録

詳細を開く

AkaneController に茜ちゃんのオブジェクトを登録

• 配下にいるので検索できなくも無いが処理削減

詳細を開く