【Unity】RequireComponentとは？目的や使い方について解説

はじめに
RequireComponentの目的
使い方
まとめ

はじめに

Unityには、Componentを簡単に追加するための機能がいくつかあります。その中でも、RequireComponentと呼ばれる機能は、Componentを追加する時に付属的に必要なComponentを自動的に追加するための機能です。今回は、RequireComponentについて解説していきます。

RequireComponentの目的

RequireComponentの目的は、特定のComponentを使用する場合に、そのComponentに付属的に必要な別のComponentを忘れてしまうことを防止することです。例えば、キャラクターやアイテムなどのGameObjectにColliderが必要であったり、AudioSourceが必要であったりする場合があります。このような場合、RequireComponentを使用することで、このような付属的なComponentを追加することができます。

使い方

例えば、以下のようなスクリプトがあるとします。

using UnityEngine;

public class MyScript : MonoBehaviour
{
    private Rigidbody2D rb;
    void Start()
    {
        rb = GetComponent<Rigidbody2D>();
    }

    void Update()
    {
        //処理
    }
}

このスクリプトでは、Rigidbody2Dを使用するために、GetComponent()を使用していることが分かりますが、もしも誤ってスクリプトを使用するGameObjectにRigidbody2Dがアタッチされていなかった場合、エラーが出てしまいます。

この場合、RequireComponentを使用することで、Rigidbody2Dが自動的に追加されるようにすることができます。以下のように記述します。

[RequireComponent(typeof(Rigidbody2D))]
public class MyScript : MonoBehaviour
{
    private Rigidbody2D rb;
    void Start()
    {
        rb = GetComponent<Rigidbody2D>();
    }

    void Update()
    {
        //処理
    }
}

[RequireComponent(typeof(Rigidbody2D))]を記述することで、スクリプトをアタッチする際に、自動的にRigidbody2Dが追加されます。

また、複数のComponentをRequireComponentで追加することも可能です。

using UnityEngine;

[RequireComponent(typeof(Rigidbody2D), typeof(Collider2D), typeof(AudioSource))]
public class MyScript : MonoBehaviour
{
    private Rigidbody2D rb;
    private Collider2D cld;
    private AudioSource aud;

    void Start()
    {
        rb = GetComponent<Rigidbody2D>();
        cld = GetComponent<Collider2D>();
        aud = GetComponent<AudioSource>();
    }

    void Update()
    {
        //処理
    }
}