3分でわかる！UnityのEvent Trigger（イベントトリガー）の使い方

UnityのEvent Triggerの使い方をマスターした！

どうも、Linです。マスク、5枚仕入れました。

もはや趣味となりつつあるユニティの勉強。

Unityの書籍をこれまで数えきれないぐらい読んで来ましたが、つい先日、また新たに「Unityの寺子屋」を読み始めたのです。

Unityの寺子屋　定番スマホゲーム開発入門

内容はわかりやすく和尚のキャラクターが出てくるので最高。たぶん、毎日この書籍を読むのが楽しみです。

読んでいてものすごく参考になるのですが、中でも

UnityのEvent Triggerの使い方

を解説しているのが参考になりました。

このEvent Triggerとは何かというと、

何かアクションを起こしたら、ある関数を呼び出せる

というものです。

例えば、とあるゲームオブジェクトにカーソルで触ったら、音楽を鳴らすということができるわけですね。

Event Triggerの存在を知る前は、ボタンで関数を呼び出せていたのですが、buttonでは、

クリックのみでしかアクションを登録できない

という欠点があったのです。

しかし、このEvent Triggerを使えば、クリック以外のアクションに対しても関数を呼び出せるので、ゲーム作成の自由度が増しますね。

3分でわかる！ユニティのEvent Triggerの使い方

ってことで、UnityのEvent Triggerの使い方をマスターしたのでメモしておきますね。

サンプルとして、

トマトにカーソルを合わせたら消える

というゲームを作っていこうと思います。

https://gyazo.com/751c925ebbd79e424ac9ef8f3726777c

Step1. ゲームオブジェクトを配置する

まずはゲームオブジェクトを配置します。

UIのImageをヒエラルキーに配置し、

SourceImageにトマトの画像を設定します。

すると、こんな感じでゲームビューにトマトの画像が設置されることでしょう。

これで準備完了です。

Step2. 呼び出したい関数を書く

Event Triggerで呼び出したい関数をスクリプトに書きましょう。

今回は「トマトにカーソルを合わせると消す」という関数を書いていきますよ。

ってことで、スクリプト「Tomato.sc」を作成。

このTomato.scを次のように編集します。

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

public class Tomato : MonoBehaviour {

	// Use this for initialization
	void Start () {
		
	}
	
	// Update is called once per frame
	void Update () {
		
	}

	public void Touch(){

		Destroy (this.gameObject);

	}

}

using System.Collections;

using System.Collections.Generic;

using UnityEngine;

public class Tomato : MonoBehaviour {

// Use this for initialization

void Start () {

}

// Update is called once per frame

void Update () {

}

public void Touch(){

Destroy (this.gameObject);

}

Event Triggerで呼び出す関数「Touch」はパブリック (public) なものとして宣言します。

こうすると、スクリプトのクラス外からも呼び出せるわけですね。

public void Touch(){

		Destroy (this.gameObject);

	}

public void Touch(){

Destroy (this.gameObject);

}

この関数では何をやっているかというと、

スクリプトをアタッチしたゲームオブジェクトを削除する

という処理をしてます。

Destroyメソッドは引数に指定したオブジェクトを削除するので、this.gameObject（スクリプトをアタッチしたゲームオブジェクト）を取得して引数に設定しているわけです。

このスクリプト（Tomato.sc）をトマトの画像にアタッチします。

Step3. Event Triggerをコンポーネントに追加

次に、Event Triggerコンポーネントをトマトの画像に追加します。

Tomatoの画像の「Add Component」から「Event Trigger」を設定しましょう。

Step4. トリガーのタイプを選択

関数を呼び出すトリガーを選択します。

どんなアクションをしたら関数を呼び出すのかを決めるわけですね。

UnityのEvent Triggerでは次のトリガーが用意されています（Unity公式レファレンスより）。

OnBeginDrag	ドラッグが始まる前に呼び出されます。
OnCancel	Cancel イベントが発生すると、EventSystem に呼び出されます。
OnDeselect	新しオブジェクトが選択されると、EventSystem に呼び出されます。
OnDrag	ドラッグする間にポインターが移動するたびに、EventSystem に呼び出されます。
OnDrop	オブジェクトがドロップを取得すると、EventSystem に呼び出されます。
OnEndDrag	ドラッグが終了すると、EventSystem に呼び出されます。
OnInitializePotentialDrag	ドラッグが感知された時ではなく、ドラッグ開始が有効になる前に BaseInputModule は呼び出されます。
OnMove	Move イベントが発生すると、EventSystem に呼び出されます。
OnPointerClick	Click イベントが発生すると、EventSystem に呼び出されます。
OnPointerDown	PointerDown イベントが発生すると、EventSystem に呼び出されます。
OnPointerEnter	ポインターがこの EventTrigger に関連したオブジェクトに入るとき、EventSystem に呼び出されます。
OnPointerExit	ポインターがこの EventTrigger に関連したオブジェクトを出るとき、EventSystem に呼び出されます。
OnPointerUp	PointerUp イベントが発生すると、EventSystem に呼び出されます。
OnScroll	Scroll イベントが発生すると、EventSystem に呼び出されます。
OnSelect	Select イベントが発生すると、EventSystem に呼び出されます。
OnSubmit	Submit イベントが発生すると、EventSystem に呼び出されます。
OnUpdateSelected	この EventTrigger に関連するオブジェクトが更新されると、EventSystem に呼び出されます。