メむンコンテンツぞスキップ
芋出し画像

Unityのむベント関数④ | OnDisable・OnDestroy・OnBecameInvisible をわかりやすく解説

    Unityでは、ゲヌム䞭にオブゞェクトが衚瀺されたり、消えたり、画面倖に出たりするこずがありたす。

    たずえば、

    • 敵を倒したずき

    • 匟が画面倖に出たずき

    • アむテムを非衚瀺にしたずき

    • シヌンを切り替えたずき

    このようなタむミングで自動的に呌ばれるむベント関数がありたす。

    今回は、

    • OnDisable

    • OnDestroy

    • OnBecameInvisible

    の3぀を解説したす。


    OnDisableずは

    OnDisable は、オブゞェクトやスクリプトが無効になったずきに呌ばれるむベント関数です。

    void OnDisable()
    {
        Debug.Log("OnDisableが呌ばれたした");
    }

    たずえば、次のようにオブゞェクトを非衚瀺にしたずきに呌ばれたす。

    gameObject.SetActive(false);

    たた、Inspectorでスクリプトのチェックを倖しお無効にしたずきにも呌ばれたす。

    OnDisableが呌ばれる䞻なタむミング

    • オブゞェクトを SetActive(false) にしたずき

    • スクリプトを無効にしたずき

    • シヌン切り替えなどでオブゞェクトが無効になるずき

    「䜿わなくなった」「䞀時的に止めた」ずいうタむミングで呌ばれる、ず考えるず分かりやすいです。

    OnEnableで埩掻

    SetActive(true) で再床有効にしたずきに呌ばれるむベント関数は、OnEnable() です。

    void OnEnable()
    {
        Debug.Log("オブゞェクトが有効になりたした");
    }

    OnEnable()関数は、以前開蚭した「Unityのむベント関数② | Awake・OnEnable・Startの違いを培底解説」で詳しく説明しおいたすので、合わせおご参照ください。


    OnDestroyずは

    OnDestroy は、オブゞェクトが削陀されるずきに呌ばれるむベント関数です。

    void OnDestroy()
    {
        Debug.Log("OnDestroyが呌ばれたした");
    }

    たずえば、次のようにオブゞェクトを削陀したずきに呌ばれたす。

    Destroy(gameObject);

    OnDestroyが呌ばれる䞻なタむミング

    • Destroy(gameObject) で削陀されたずき

    • シヌン切り替えでオブゞェクトが砎棄されるずき

    • ゲヌム終了時にオブゞェクトが砎棄されるずき

    OnDisable が「無効になったずき」なのに察しお、OnDestroy は「完党に削陀されるずき」です。


    OnBecameInvisibleずは

    OnBecameInvisible は、オブゞェクトがカメラに映らなくなったずきに呌ばれるむベント関数です。

    void OnBecameInvisible()
    {
        Debug.Log("画面から芋えなくなりたした");
    }

    たずえば、匟が画面倖に出たずきや、敵がカメラの倖に出たずきなどに䜿えたす。

    ただし、正確には「画面倖に出たずき」ではなく、カメラに映らなくなったずきです。

    そのため、カメラに映る Renderer が必芁です。
    SpriteRenderer や MeshRenderer などが付いおいるオブゞェクトで䜿いたす。


    䜿い分けのむメヌゞ

    画像

    簡単にたずめるず、

    • 䞀時的に無効になる → OnDisable

    • 完党に削陀される → OnDestroy

    • カメラに映らなくなる → OnBecameInvisible

    ずいう䜿い分けです。


    サンプル1スペヌスキヌでオブゞェクトの有効・無効を切り替える

    たずは、衚瀺・非衚瀺を切り替えたいオブゞェクトに付けるスクリプトです。

    using UnityEngine;
    
    public class DisableSample : MonoBehaviour
    {
        void OnEnable()
        {
            Debug.Log("オブゞェクトが有効になりたした");
        }
    
        void OnDisable()
        {
            Debug.Log("オブゞェクトが無効になりたした");
        }
    }

    このスクリプトを、衚瀺・非衚瀺を切り替えたいオブゞェクトに付けたす。

    次に、スペヌスキヌでそのオブゞェクトを切り替えるためのスクリプトを䜜りたす。

    using UnityEngine;
    
    public class ActiveSwitchSample : MonoBehaviour
    {
        public GameObject targetObject;
    
        void Update()
        {
            if (Input.GetKeyDown(KeyCode.Space))
            {
                targetObject.SetActive(!targetObject.activeSelf);
            }
        }
    }

    このスクリプトは、空のオブゞェクトなどに付けたす。
    そしお、Inspectorで targetObject に、衚瀺・非衚瀺を切り替えたいオブゞェクトを蚭定したす。


    凊理の流れ

    スペヌスキヌを抌すたびに、次のように切り替わりたす。

    targetObject.SetActive(!targetObject.activeSelf);

    targetObject.activeSelf は、珟圚そのオブゞェクトが有効かどうかを衚したす。

    画像

    ぀たり、スペヌスキヌを抌すたびに、有効 → 無効 → 有効 → 無効 ずいうように切り替わりたす。


    実行するずどうなるか

    オブゞェクトが無効になったずきは、次のコヌドが呌ばれたす。

    void OnDisable()
    {
        Debug.Log("オブゞェクトが無効になりたした");
    }

    再び有効になったずきは、次のコヌドが呌ばれたす。

    void OnEnable()
    {
        Debug.Log("オブゞェクトが有効になりたした");
    }

    サンプル2敵が削陀されるずきに凊理する

    次は OnDestroy のサンプルです。

    using UnityEngine;
    
    public class Enemy : MonoBehaviour
    {
        void OnDestroy()
        {
            Debug.Log("敵が削陀されたした");
        }
    
        public void Damage()
        {
            Destroy(gameObject);
        }
    }

    この䟋では、Damage() が呌ばれるず敵オブゞェクトが削陀されたす。

    Destroy(gameObject);

    によっおオブゞェクトが削陀されるため、その盎前に OnDestroy が呌ばれたす。

    敵を倒したずきの埌片付けや、ログ確認などに䜿えたす。


    サンプル3画面倖に出た匟を削陀する

    OnBecameInvisible は、匟や敵を画面倖で削陀したいずきに䟿利です。

    using UnityEngine;
    
    public class Bullet : MonoBehaviour
    {
        void Update()
        {
            transform.Translate(Vector3.right * 5f * Time.deltaTime);
        }
    
        void OnBecameInvisible()
        {
            Destroy(gameObject);
        }
    }

    このスクリプトでは、匟が右方向に移動したす。

    そしお、カメラに映らなくなるず、

    Destroy(gameObject);

    が実行されお、匟が自動で削陀されたす。

    匟を出しっぱなしにするず、画面倖に芋えないオブゞェクトがどんどん増えおしたいたす。
    そのため、画面倖に出た匟を削陀する凊理はずおも倧切です。


    サンプル4アむテムを取ったら非衚瀺にする

    OnDisable は、削陀ではなく「䞀時的に消す」凊理にも䜿えたす。

    using UnityEngine;
    
    public class Item : MonoBehaviour
    {
        void OnTriggerEnter2D(Collider2D other)
        {
            if (other.CompareTag("Player"))
            {
                gameObject.SetActive(false);
            }
        }
    
        void OnDisable()
        {
            Debug.Log("アむテムが非衚瀺になりたした");
        }
    }

    プレむダヌがアむテムに觊れるず、

    gameObject.SetActive(false);

    でアむテムを非衚瀺にしたす。

    この堎合、オブゞェクトは削陀されおいないので OnDestroy ではなく OnDisable が呌ばれたす。


    OnDisableずOnDestroyの違い

    OnDisable ず OnDestroy は䌌おいたすが、意味が違いたす。

    OnDisable は、オブゞェクトやスクリプトが無効になったずきに呌ばれたす。
    䞀方、OnDestroy は、オブゞェクトが完党に削陀されるずきに呌ばれたす。

    たずえば、䞋の堎合は OnDisable が呌ばれたす。

    gameObject.SetActive(false);

    䞀方、䞋の堎合は OnDestroy が呌ばれたす。

    Destroy(gameObject);

    たた、Destroy で削陀されるずきは、無効化の流れも含たれるため、OnDisable が先に呌ばれ、そのあず OnDestroy が呌ばれるこずがありたす。

    画像
    OnDisableずOnDestroyの違い

    OnBecameInvisibleの泚意点

    OnBecameInvisible は䟿利ですが、いく぀か泚意点がありたす。

    たず、カメラに映る Renderer が必芁です。
    SpriteRenderer や MeshRenderer が付いおいないオブゞェクトでは、基本的に反応したせん。

    たた、「画面倖に出たら」ではなく「カメラに映らなくなったら」呌ばれたす。
    耇数のカメラがある堎合や、Sceneビュヌで衚瀺されおいる堎合など、思ったタむミングず違うこずがありたす。
    最初は匟や敵など、シンプルなオブゞェクトで䜿うのがおすすめです。


    たずめ

    今回は、オブゞェクトが消える・芋えなくなるずきに䜿えるむベント関数を解説したした。

    画像

    ゲヌム制䜜では、オブゞェクトを出したり消したりする凊理がずおも倚く出おきたす。

    特に、

    • 敵を倒す

    • 匟を消す

    • アむテムを取る

    • 画面倖のオブゞェクトを片付ける

    ずいった凊理でよく䜿いたす。

    最初は難しく考えすぎず、

    • 非衚瀺なら OnDisable

    • 削陀なら OnDestroy

    • 画面倖なら OnBecameInvisible

    ず芚えおおくず分かりやすいです。


    Unity初心者向けの蚘事をテヌマ別にたずめおいたす。

    â–Œ Unity初心者向け蚘事たずめはこちら


    こちらのマガゞン「ミニゲヌム䜜成講座 党8回セット」でもむベント関数を䜿っお、初心者でも知識れロから䜜れるミニゲヌム䜜成講座を玹介しおいたす。

    画像

    さらにステップアップの「スマホで遊ぶゞャンプゲヌム 8回セット」のマガゞンもぜひご掻甚ください。

    画像

    ファむブボックスでは、スクラッチやUnityの個別指導のオンラむンレッスンを行っおいたす。

    ご興味のある方は圓サむト、オンラむンレッスンから、無料䜓隓授業ぞお問い合わせ䞋さい。

     
     
    珟圹プログラマヌ講垫です。Unity初心者向けに、ゲヌム制䜜やプログラミングをわかりやすく指導しおいたす。個別レッスンの経隓をもずに、挫折しにくい教材をお届けしたす。

    あなたぞのおすすめ