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

Unityのむベント関数③ | OnCollisionç³»,OnTrigger系 衝突䟵入刀定を培底解説

    むベント関数の蚘事1回目で

    • Update

    • FixedUpdate

    • LateUpdate

    そしおむベント関数の蚘事2回目では以䞋のむベント関数に぀いお解説したした。

    • Awake

    • OnEnable

    • Start

    今回は、ゲヌム䜜りでよく䜿う圓たり刀定のむベント関数、
    OnCollision系ずOnTrigger系に぀いお解説したす。

    アむテムを取ったずき、敵にぶ぀かったずき、ゎヌルに入ったずきなど、ゲヌムでは「䜕かに觊れたずき」の凊理がたくさん出おきたす。

    そのようなずきに䜿うのが、今回のむベント関数です。


    OnCollisionずOnTriggerずは

    どちらも、オブゞェクト同士が觊れたずきに自動で呌ばれるむベント関数です。

    ただし、同じ「觊れる」でも圹割が少し違いたす。

    OnCollision

    → 物理的にぶ぀かる圓たり刀定

    OnTrigger

    → すり抜ける圓たり刀定

    たずえば、

    • 壁にぶ぀かる

    • 地面に着地する

    このような「実際にぶ぀かる」凊理は OnCollision

    • アむテムを取る

    • ゎヌルに入る

    • 敵の譊戒範囲に入る

    このような「重なったこずを刀定したいだけ」の凊理は OnTrigger ず考えるず分かりやすいです。


    たずは䞀芧

    OnCollisionç³»

    void OnCollisionEnter2D(Collision2D collision)
    {
    }
    
    void OnCollisionStay2D(Collision2D collision)
    {
    }
    
    void OnCollisionExit2D(Collision2D collision)
    {
    }

    OnTriggerç³»

    void OnTriggerEnter2D(Collider2D other)
    {
    }
    
    void OnTriggerStay2D(Collider2D other)
    {
    }
    
    void OnTriggerExit2D(Collider2D other)
    {
    }

    今回は、2Dゲヌムでよく䜿う 2D版 を䞭心に説明したす。

    画像

    OnCollision 系関数の意味

    OnCollisionEnter2D

    ぶ぀かった瞬間に1回だけ呌ばれたす。

    void OnCollisionEnter2D(Collision2D collision)
    {
        Debug.Log("䜕かにぶ぀かりたした");
    }

    たずえば、

    • 地面に着地した瞬間

    • 敵にぶ぀かった瞬間

    • 壁に圓たった瞬間

    などに䜿えたす。


    OnCollisionStay2D

    ぶ぀かっおいる間、呌ばれ続けたす。

    void OnCollisionStay2D(Collision2D collision)
    {
        Debug.Log("ぶ぀かっおいる最䞭です");
    }

    ずっず接觊しおいる間に䜕かをしたいずきに䜿いたす。

    ただし、物理挔算の曎新ごずに呌ばれ続けたす。重い凊理をたくさん曞かないように泚意したしょう。


    OnCollisionExit2D

    ぶ぀かっおいたものから離れた瞬間に呌ばれたす。

    void OnCollisionExit2D(Collision2D collision)
    {
        Debug.Log("ぶ぀かりが終わりたした");
    }

    たずえば、

    • 地面から離れおゞャンプした瞬間

    • 壁から離れた瞬間

    などの刀定に䜿えたす。


    OnTrigger系関数の意味

    OnTriggerEnter2D

    Triggerの範囲に入った瞬間に呌ばれたす。

    void OnTriggerEnter2D(Collider2D other)
    {
        Debug.Log("Triggerに入りたした");
    }

    たずえば、

    • コむンを取った

    • ゎヌルに入った

    • 回埩゚リアに入った

    などに向いおいたす。


    OnTriggerStay2D

    Triggerの䞭にいる間、呌ばれ続けたす。

    void OnTriggerStay2D(Collider2D other)
    {
        Debug.Log("Triggerの䞭にいたす");
    }

    たずえば、

    • ダメヌゞゟヌンにいる間、少しず぀HPを枛らす

    • 回埩ゟヌンにいる間、少しず぀回埩する

    などに䜿えたす。


    OnTriggerExit2D

    Triggerの範囲から出た瞬間に呌ばれたす。

    void OnTriggerExit2D(Collider2D other)
    {
        Debug.Log("Triggerから出たした");
    }

    たずえば、

    • セヌプリアから出た

    • 敵の芋぀ける範囲から出た

    などの刀定に䜿えたす。


    OnCollisionずOnTriggerの違い

    違いをシンプルにたずめるず、次のようになりたす。

    画像

    ぀たり、

    ぶ぀かっお止たるならCollision
    重なったこずだけ刀定したいならTrigger

    ず芚えるず分かりやすいです。


    Triggerを䜿うには Is Trigger をONにする

    OnTrigger を䜿いたい堎合は、Collider の Is Trigger にチェックを入れる必芁がありたす。

    画像

    逆に、OnCollision を䜿う堎合は、通垞は Is Trigger をOFF にしお䜿いたす。

    たずめるず

    • Is Trigger OFF → OnCollision

    • Is Trigger ON → OnTrigger

    です。


    実際の䜿甚䟋1 コむンを取る

    たずえば、プレむダヌがコむンに觊れたら、コむンを取ったこずにしお消す凊理を䜜っおみたす。

    このような凊理では、OnTriggerEnter2D をよく䜿いたす。

    using UnityEngine;
    
    public class Coin : MonoBehaviour
    {
        void OnTriggerEnter2D(Collider2D other)
        {
            if (other.CompareTag("Player"))
            {
                Debug.Log("コむンを取りたした");
                Destroy(gameObject);
            }
        }
    }

    このコヌドでは、プレむダヌがコむンに重なった瞬間に、

    • 「コむンを取りたした」ず衚瀺する

    • コむンを消す

    ずいう凊理をしおいたす。

    コむンは、プレむダヌず物理的にぶ぀かっお止たる必芁はありたせん。
    プレむダヌが重なったこずだけ分かればよいので、Trigger向きです。


    Collider2D other の other ずは

    ここで少し分かりにくいのが、この郚分です。

    void OnTriggerEnter2D(Collider2D other)

    other は、Trigger に入っおきた盞手の情報を受け取るための名前です。

    たずえば、プレむダヌがコむンに觊れた堎合、
    その「觊れおきた盞手」であるプレむダヌの Collider2D の情報が other に入りたす。

    そしお、次の行で䜿っおいる other も、䞊で受け取った同じものです。

    if (other.CompareTag("Player"))

    ぀たり、

    Collider2D other

    の other ず、

    other.CompareTag("Player")

    の other は、同じものです。

    「Triggerに入っおきた盞手を other ずいう名前で受け取っお、その盞手が Player かどうかを調べおいる」

    ず考えるず分かりやすいです。


    other ずいう名前は倉えおもいい

    実は、other ずいう名前は自分で付けおいる名前です。

    なので、次のように collision ずいう名前にしおも動きたす。

    void OnTriggerEnter2D(Collider2D collision)
    {
        if (collision.CompareTag("Player"))
        {
            Debug.Log("コむンを取りたした");
            Destroy(gameObject);
        }
    }

    この堎合も、

    Collider2D collision

    の collision ず、

    collision.CompareTag("Player")

    の collision は同じものです。

    ただし、OnTriggerEnter2D の匕数は Collision2D ではなく Collider2D です。

    そのため、初心者のうちは collision よりも、
    「盞手」ずいう意味の other を䜿った方が分かりやすいず思いたす。


    1行ず぀芋おみよう

    もう䞀床、コヌドを1行ず぀芋おみたす。

    using UnityEngine;

    Unityの機胜を䜿うために必芁な䞀文です。


    public class Coin : MonoBehaviour

    Coin ずいうスクリプトを䜜っおいたす。

    このスクリプトは、コむンのオブゞェクトに付ける想定です。


    void OnTriggerEnter2D(Collider2D other)

    䜕かがこのオブゞェクトの Trigger に入った瞬間に、自動で呌ばれるむベント関数です。

    other には、Trigger に入っおきた盞手の情報が入りたす。


    if (other.CompareTag("Player"))

    Trigger に入っおきた盞手のタグが Player かどうかを調べおいたす。

    ぀たり、

    「觊れおきた盞手はプレむダヌですか」

    ず確認しおいたす。


    Debug.Log("コむンを取りたした");

    Console に「コむンを取りたした」ず衚瀺したす。

    実際のゲヌムでは、ここにスコアを増やす凊理や効果音を鳎らす凊理を远加するこずもできたす。


    Destroy(gameObject);

    このスクリプトが付いおいるオブゞェクトを削陀したす。

    今回の堎合、Coin スクリプトをコむンに付けおいるので、
    gameObject はコむン自身を衚したす。

    ぀たり、この行でコむンが消えたす。


    実際の䜿甚䟋2 敵にぶ぀かったらダメヌゞ

    敵にぶ぀かったずきにダメヌゞを受ける凊理を䜜る堎合は、OnCollisionEnter2D を䜿うこずがありたす。

    using UnityEngine;
    
    public class PlayerDamage : MonoBehaviour
    {
        void OnCollisionEnter2D(Collision2D collision)
        {
            if (collision.gameObject.CompareTag("Enemy"))
            {
                Debug.Log("敵にぶ぀かっおダメヌゞ");
            }
        }
    }

    この䟋では、敵ず物理的にぶ぀かった瞬間に、ダメヌゞ凊理を行う想定です。


    Collision2D collision の collision ずは

    OnCollisionEnter2D では、匕数の型が Collision2D になりたす。

    void OnCollisionEnter2D(Collision2D collision)

    この collision には、ぶ぀かった盞手ずの接觊情報が入りたす。

    OnTriggerEnter2D のずきは、

    Collider2D other

    でした。

    䞀方、OnCollisionEnter2D では、

    Collision2D collision

    になりたす。

    Collision2D には、ぶ぀かった盞手の情報だけでなく、接觊した䜍眮など、衝突に関する情報も含たれたす。

    そのため、盞手の GameObject を調べるずきは、次のように曞きたす。

    collision.gameObject.CompareTag("Enemy")

    これは、

    「ぶ぀かった盞手の GameObject のタグは Enemy ですか」

    ずいう意味です。


    1行ず぀芋おみよう

    public class PlayerDamage : MonoBehaviour

    PlayerDamage ずいうスクリプトを䜜っおいたす。

    このスクリプトは、プレむダヌに付ける想定です。


    void OnCollisionEnter2D(Collision2D collision)

    䜕かず物理的にぶ぀かった瞬間に、自動で呌ばれるむベント関数です。

    collision には、ぶ぀かった盞手ずの接觊情報が入りたす。


    if (collision.gameObject.CompareTag("Enemy"))

    ぶ぀かった盞手のタグが Enemy かどうかを調べおいたす。

    ぀たり、

    「ぶ぀かった盞手は敵ですか」

    ず確認しおいたす。


    Debug.Log("敵にぶ぀かっおダメヌゞ");

    Console に「敵にぶ぀かっおダメヌゞ」ず衚瀺したす。

    実際のゲヌムでは、ここにHPを枛らす凊理などを远加したす。


    実際の䜿甚䟋3 ゎヌルに入ったらクリア

    ゎヌル刀定も、OnTriggerEnter2D を䜿うこずが倚いです。

    using UnityEngine;
    
    public class Goal : MonoBehaviour
    {
        void OnTriggerEnter2D(Collider2D other)
        {
            if (other.CompareTag("Player"))
            {
                Debug.Log("ゲヌムクリア");
            }
        }
    }

    ゎヌルは、プレむダヌが重なればOKです。
    壁のようにぶ぀かっお止たる必芁はありたせん。

    そのため、ゎヌル刀定も Trigger向き です。


    このコヌドの考え方

    void OnTriggerEnter2D(Collider2D other)

    ここで、ゎヌルの範囲に入っおきた盞手を other ずしお受け取りたす。

    そしお、

    if (other.CompareTag("Player"))

    で、その盞手がプレむダヌかどうかを調べおいたす。

    プレむダヌだった堎合だけ、

    Debug.Log("ゲヌムクリア");

    を実行したす。

    ぀たり、

    ゎヌルに入っおきた盞手がプレむダヌなら、ゲヌムクリアにする

    ずいう凊理です。


    other ず collision の違い

    ここたでで、

    Collider2D other

    ず

    Collision2D collision

    の2぀が出おきたした。

    少しややこしく芋えたすが、最初は次のように考えるず分かりやすいです。

    OnTriggerEnter2D では、

    Collider2D other

    を䜿いたす。 othre はただの匕数なので、名前を倉えおもいいですよ

    これは、Trigger に入っおきた盞手の Collider 情報です。

    䞀方、OnCollisionEnter2D では、

    Collision2D collision

    を䜿いたす。

    これは、実際にぶ぀かったずきの衝突情報です。

    簡単にたずめるず、

    Trigger は Collider2D
    Collision は Collision2D

    です。


    2Dず3Dの違いに泚意

    今回玹介したのは 2D甹 です。

    2Dず3Dでは、関数名や匕数が少し倉わりたす。

    2Dの堎合

    void OnCollisionEnter2D(Collision2D collision)
    {
    }
    
    void OnTriggerEnter2D(Collider2D other)
    {
    }

    3Dの堎合

    void OnCollisionEnter(Collision collision)
    {
    }
    
    void OnTriggerEnter(Collider other)
    {
    }

    2Dの堎合は、関数名や型の最埌に 2D が付きたす。

    3Dの堎合は、2D が付きたせん。


    たずめ

    今回は、圓たり刀定で䜿うむベント関数、

    • OnCollision

    • OnTrigger

    に぀いお解説したした。

    ポむントをたずめるず、次の通りです。

    • OnCollision は、物理的にぶ぀かる圓たり刀定

    • OnTrigger は、すり抜ける圓たり刀定

    • OnTriggerEnter2D では Collider2D other を䜿う

    • OnCollisionEnter2D では Collision2D collision を䜿う

    • other.CompareTag("Player") は、入っおきた盞手が Player かどうかを調べおいる

    • collision.gameObject.CompareTag("Enemy") は、ぶ぀かった盞手が Enemy かどうかを調べおいる

    • 2Dでは関数名や型の最埌に 2D が付く

    • OnTrigger を䜿うずきは、Collider2D の Is Trigger をONにする

    圓たり刀定は、ゲヌム䜜りでずおもよく䜿いたす。

    アむテム取埗、敵ずの接觊、ゎヌル刀定など、たくさんの堎面で出おくるので、実際にコヌドを曞きながら芚えおいきたしょう。


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

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


    こちらのマガゞン「ミニゲヌム䜜成講座 党8回セット」でもシヌンの切り替えなどを掻甚しお、初心者でも知識れロから䜜れるミニゲヌム䜜成講座を玹介しおいたす。

    画像

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

    画像

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

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

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

    あなたぞのおすすめ