Triggers モジュール

ビルトインパーティクルシステムの Triggers モジュールでは、シーンの 1 つまたは複数のコライダーとの相互作用に基づいてパーティクルにアクセスし、修正することができます。このモジュールを有効にすると、パーティクルシステムはアタッチされたスクリプトで OnParticleTrigger() コールバックを呼び出します。このコールバックを使って、シーンのコライダーに対する位置に応じてパーティクルのリストにアクセスできます。

Triggers モジュールの使用

This module is part of the Particle System component. When you create a new Particle System GameObject, or add a Particle System component to an exiting GameObject, Unity adds the Triggers module to the Particle System. By default, Unity disables this module. To create a new Particle System and enable this module:

1. Click GameObject > Effects > Particle System.
2. In the Inspector, find the Particle System component.
3. In the Particle System component, find the Triggers module fold-out.
4. To the left of the fold-out header, enable the checkbox.

まず、パーティクルが相互作用できるシーンのコライダーを指定します。そのためには、 コライダー のリストプロパティに 1 つ以上のコライダーを割り当てます。リスト内のコライダー数を増やすには、コライダーのリストの下にある + ボタンをクリックします。リストからコライダーを削除するには、コライダーを選択して - ボタンをクリックします。リストのインデックスにまだコライダーを割り当てていない場合は、空のエントリーの右側にある小さい + ボタンを使って、新しいコライダーを作成して割り当てることができます。この例では、パーティクルシステムの子として新しいゲームオブジェクトを作成し、そこにスフィアコライダーをアタッチしてから、コライダーを空のエントリーに割り当てます。

コライダーを追加した後、特定のトリガーイベントタイプを渡す基準を満たすと、パーティクルの動作を指定することができます。以下のような 4 つのイベントタイプがあり、パーティクルがどのようにコライダーと相互作用するかを表します。

• Inside: パーティクルがコライダーの境界内にあります。
• Outside: パーティクルがコライダーの境界の外にあります。
• Enter: パーティクルはコライダーの境界に入ります。
• Exit: パーティクルはコライダーの境界を出ます。

Inspector では、これらのイベントタイプごとにドロップダウンがあり、トリガーイベントの条件を満たす場合にパーティクルに何が起こるかを選択することができます。選択肢は次のとおりです。

• Callback: OnParticleTrigger() コールバック関数でパーティクルにアクセスできるようになります。
• Kill: パーティクルを破壊します。OnParticleTrigger() コールバック関数でパーティクルにアクセスすることはできません。
• Ignore: パーティクルを無視します。OnParticleTrigger() コールバック関数でパーティクルにアクセスすることはできません。

API

Since this module is part of the Particle System component, you access it through the ParticleSystem class. For information on how to access it and change values at runtime, see the Triggers module API documentation.

OnParticleTrigger() 内でのパーティクルへのアクセス

トリガーイベントの 1 つに対するリアクションとして Callback を選択する場合、アタッチしたスクリプトからイベント条件を満たすパーティクルにアクセスできます。これを行うには、まず OnParticleTrigger() 関数をアタッチしたスクリプトに加える必要があります。この関数内で、ParticlePhysicsExtensions.GetTriggerParticles() 関数を呼び出して、トリガーイベントの条件を満たすパーティクルのリストを取得します。この関数は、パーティクルを取得したいトリガーイベントを指定するParticleSystemTriggerEventType (Inside、Outside、Enter、Exit) と、この関数が結果を表す Particles のリストを受け取ります。このリストから、任意のパーティクルにアクセスしたり、変更したり、破棄したりすることができます。また、この関数は任意のパラメーターをとり、各パーティクルがどのコライダーをトリガーしたかなどの衝突情報を出力することができます。Collider Query Mode プロパティは、このパラメーターを通して利用できる情報を制御します。

API の詳細や使用方法については、以下の例 を参照してください。

プロパティ

For some properties in this section, you can use different modes to set their value. For information on the modes you can use, see Varying properties over time.

例

コライダーとの相互作用

以下の例では、パーティクルがコライダーに侵入すると赤くなり、コライダーの境界から出ると緑に変わります。

using UnityEngine;
using System.Collections;
using System.Collections.Generic;

[ExecuteInEditMode]
public class TriggerScript : MonoBehaviour
{
    ParticleSystem ps;

    // これらのリストは、各フレームでトリガーの条件に
    // 一致するパーティクルを格納します
    List<ParticleSystem.Particle> enter = new List<ParticleSystem.Particle>();
    List<ParticleSystem.Particle> exit = new List<ParticleSystem.Particle>();

    void OnEnable()
    {
        ps = GetComponent<ParticleSystem>();
    }

    void OnParticleTrigger()
    {
        // このフレームのトリガーの条件に一致するパーティクルを取得します
        int numEnter = ps.GetTriggerParticles(ParticleSystemTriggerEventType.Enter, enter);
        int numExit = ps.GetTriggerParticles(ParticleSystemTriggerEventType.Exit, exit);

        // トリガーに侵入したパーティクルを走査し、赤にします
        for (int i = 0; i < numEnter; i++)
        {
            ParticleSystem.Particle p = enter[i];
            p.startColor = new Color32(255, 0, 0, 255);
            enter[i] = p;
        }

        // トリガーから出ていくパーティクルを走査し、緑にします
        for (int i = 0; i < numExit; i++)
        {
            ParticleSystem.Particle p = exit[i];
            p.startColor = new Color32(0, 255, 0, 255);
            exit[i] = p;
        }

        // 変更したパーティクルをパーティクルシステムに再割り当てします
        ps.SetTriggerParticles(ParticleSystemTriggerEventType.Enter, enter);
        ps.SetTriggerParticles(ParticleSystemTriggerEventType.Exit, exit);
    }
}

この例の結果は下の画像の通りです。

複数のコライダーとの相互作用

次の例では、GetTriggerParticles() 関数から抽出できる追加の衝突データを利用しています。1 つ目のコライダーの境界内にあるパーティクルは赤に、2 つ目のコライダーの境界内にあるパーティクルは青に、そして両方のコライダーの境界内にあるパーティクルは緑になります。また、パーティクルがコライダーの内側にない場合は白色になります。この例では、 Collider Query Mode を All に設定しています。

using UnityEngine;
using System.Collections;
using System.Collections.Generic;

[ExecuteInEditMode]
public class TriggerScript : MonoBehaviour
{
    void OnParticleTrigger()
    {
        ParticleSystem ps = GetComponent();
 
        // パーティクル
        List inside = new List();
        List exit = new List();
 
        // get
        int numInside = ps.GetTriggerParticles(ParticleSystemTriggerEventType.Inside, inside, out var insideData);
        int numExit = ps.GetTriggerParticles(ParticleSystemTriggerEventType.Exit, exit);
 
        // 繰り返し
        for (int i = 0; i < numInside; i++)
        {
            ParticleSystem.Particle p = inside[i];
            if (insideData.GetColliderCount(i) == 1)
            {
                if (insideData.GetCollider(i, 0) == ps.trigger.GetCollider(0))
                    p.startColor = new Color32(255, 0, 0, 255);
                else
                    p.startColor = new Color32(0, 0, 255, 255);
            }
            else if (insideData.GetColliderCount(i) == 2)
            {
                p.startColor = new Color32(0, 255, 0, 255);
            }
            inside[i] = p;
        }
        for (int i = 0; i < numExit; i++)
        {
            ParticleSystem.Particle p = exit[i];
            p.startColor = new Color32(1, 1, 1, 255);
            exit[i] = p;
        }
 
        // set
        ps.SetTriggerParticles(ParticleSystemTriggerEventType.Inside, inside);
        ps.SetTriggerParticles(ParticleSystemTriggerEventType.Exit, exit);
    }
}

この例の結果は下の画像の通りです。