Version: 2017.3

説明

イベントシステムからイベントを受け取ったり、各イベントに登録された関数を呼び出します。

The EventTrigger can be used to specify functions you wish to be called for each EventSystem event. You can assign multiple functions to a single event and whenever the EventTrigger receives that event it will call those functions in the order they were provided.

注:ゲームオブジェクトにこのコンポーネントを添付すると、すべてのイベントを遮断し、イベントは親のオブジェクトにまったく伝わりません。

イベントを遮断するには 2つの方法があります。1つめは EventTrigger を継承して、遮断したいイベントのために関数をオーバーライドする方法です。

using UnityEngine;
using UnityEngine.EventSystems;

public class EventTriggerExample : EventTrigger { public override void OnBeginDrag(PointerEventData data) { Debug.Log("OnBeginDrag called."); }

public override void OnCancel(BaseEventData data) { Debug.Log("OnCancel called."); }

public override void OnDeselect(BaseEventData data) { Debug.Log("OnDeselect called."); }

public override void OnDrag(PointerEventData data) { Debug.Log("OnDrag called."); }

public override void OnDrop(PointerEventData data) { Debug.Log("OnDrop called."); }

public override void OnEndDrag(PointerEventData data) { Debug.Log("OnEndDrag called."); }

public override void OnInitializePotentialDrag(PointerEventData data) { Debug.Log("OnInitializePotentialDrag called."); }

public override void OnMove(AxisEventData data) { Debug.Log("OnMove called."); }

public override void OnPointerClick(PointerEventData data) { Debug.Log("OnPointerClick called."); }

public override void OnPointerDown(PointerEventData data) { Debug.Log("OnPointerDown called."); }

public override void OnPointerEnter(PointerEventData data) { Debug.Log("OnPointerEnter called."); }

public override void OnPointerExit(PointerEventData data) { Debug.Log("OnPointerExit called."); }

public override void OnPointerUp(PointerEventData data) { Debug.Log("OnPointerUp called."); }

public override void OnScroll(PointerEventData data) { Debug.Log("OnScroll called."); }

public override void OnSelect(BaseEventData data) { Debug.Log("OnSelect called."); }

public override void OnSubmit(BaseEventData data) { Debug.Log("OnSubmit called."); }

public override void OnUpdateSelected(BaseEventData data) { Debug.Log("OnUpdateSelected called."); } }

2 つめは、個々のデリゲートを指定する方法です。

using UnityEngine;
using UnityEngine.EventSystems;

public class EventTriggerDelegateExample : MonoBehaviour { void Start() { EventTrigger trigger = GetComponent<EventTrigger>(); EventTrigger.Entry entry = new EventTrigger.Entry(); entry.eventID = EventTriggerType.PointerDown; entry.callback.AddListener((data) => { OnPointerDownDelegate((PointerEventData)data); }); trigger.triggers.Add(entry); }

public void OnPointerDownDelegate(PointerEventData data) { Debug.Log("OnPointerDownDelegate called."); } }

変数

triggersこのイベントトリガーに登録されているすべての関数

Public 関数

OnBeginDragドラッグが始まる前に呼び出されます。
OnCancelCancel イベントが発生すると、EventSystem に呼び出されます。
OnDeselect新しオブジェクトが選択されると、EventSystem に呼び出されます。
OnDragドラッグする間にポインターが移動するたびに、EventSystem に呼び出されます。
OnDropオブジェクトがドロップを取得すると、EventSystem に呼び出されます。
OnEndDragドラッグが終了すると、EventSystem に呼び出されます。
OnInitializePotentialDragドラッグが感知された時ではなく、ドラッグ開始が有効になる前に BaseInputModule は呼び出されます。
OnMoveMove イベントが発生すると、EventSystem に呼び出されます。
OnPointerClickClick イベントが発生すると、EventSystem に呼び出されます。
OnPointerDownPointerDown イベントが発生すると、EventSystem に呼び出されます。
OnPointerEnterポインターがこの EventTrigger に関連したオブジェクトに入るとき、EventSystem に呼び出されます。
OnPointerExitポインターがこの EventTrigger に関連したオブジェクトを出るとき、EventSystem に呼び出されます。
OnPointerUpPointerUp イベントが発生すると、EventSystem に呼び出されます。
OnScrollScroll イベントが発生すると、EventSystem に呼び出されます。
OnSelectSelect イベントが発生すると、EventSystem に呼び出されます。
OnSubmitSubmit イベントが発生すると、EventSystem に呼び出されます。
OnUpdateSelectedこの EventTrigger に関連するオブジェクトが更新されると、EventSystem に呼び出されます。

継承メンバー

変数

enabled有効であれば更新され、無効であれば更新されません。
isActiveAndEnabledBehaviour が有効かどうか
gameObjectこのコンポーネントはゲームオブジェクトにアタッチされます。コンポーネントはいつもゲームオブジェクトにアタッチされています。
tagゲームオブジェクトのタグ
transformThe Transform attached to this GameObject.
runInEditModeAllow a specific instance of a MonoBehaviour to run in edit mode (only available in the editor).
useGUILayoutこれを無効にすると、GUI のレイアウトフェーズをスキップすることができます
hideFlagsオブジェクトは非表示、シーンに保存、ユーザーが編集可能、などを設定する。
nameオブジェクト名

Public 関数

BroadcastMessageゲームオブジェクトまたは子オブジェクトにあるすべての MonoBehaviour を継承したクラスにある methodName 名のメソッドを呼び出します。
CompareTagこのゲームオブジェクトは tag とタグ付けされているかどうか
GetComponentゲームオブジェクトに type がアタッチされている場合は type のタイプを使用してコンポーネントを返します。ない場合は null です
GetComponentInChildren GameObject や深さ優先探索を活用して、親子関係にある子オブジェクトから type のタイプのコンポーネントを取得します。
GetComponentInParent GameObject や深さ優先探索を活用して、親子関係にある親オブジェクトから type のタイプのコンポーネントを取得します。
GetComponents GameObject から type のタイプのコンポーネントを「すべて」取得します。
GetComponentsInChildren GameObject や深さ優先探索を活用して、親子関係にある子オブジェクトから type のタイプのコンポーネントを「すべて」取得します。
GetComponentsInParent GameObject や深さ優先探索を活用して、親子関係にある親オブジェクトから type のタイプのコンポーネントを「すべて」取得します。
SendMessageゲームオブジェクトにアタッチされているすべての MonoBehaviour にある methodName と名付けたメソッドを呼び出します
SendMessageUpwardsゲームオブジェクトと親(の親、さらに親 ... )にアタッチされているすべての MonoBehaviour にある methodName と名付けたメソッドを呼び出します
CancelInvokeすべての Invoke をキャンセルします
Invoke設定した時間(単位は秒)にメソッドを呼び出します
InvokeRepeating設定した時間(単位は秒)にメソッドを呼び出し、repeatRate 秒ごとにリピートします
IsInvokingメソッドの呼出が保留中かどうか
StartCoroutineコルーチンを開始します
StopAllCoroutinesBehaviour 上で実行されているコルーチンをすべて停止します
StopCoroutineこの Behaviour 上で実行されている methodName という名のコルーチン、または routine として保持されているコルーチンをすべて停止します
GetInstanceIDオブジェクトのインスタンス ID を返します
ToStringReturns the name of the GameObject.

Static 関数

printUnity コンソールにログを出力します (Debug.Log と同じです)
Destroyゲームオブジェクトやコンポーネント、アセットを削除します
DestroyImmediateDestroys the object obj immediately. You are strongly recommended to use Destroy instead.
DontDestroyOnLoad新しいシーンを読み込んでもオブジェクトが自動で破壊されないように設定します
FindObjectOfTypeタイプ type から最初に見つけたアクティブのオブジェクトを返します
FindObjectsOfTypeタイプから見つけたすべてのアクティブのオブジェクト配列を返します
Instantiateoriginal のオブジェクトをクローンします

Operator

boolオブジェクトが存在するかどうか
operator !=二つのオブジェクトが異なるオブジェクトを参照しているか比較します
operator ==2つのオブジェクト参照が同じオブジェクトを参照しているか比較します。

メッセージ

Awakeスクリプトのインスタンスがロードされたときに呼び出されます
FixedUpdateMonoBehaviour が有効の場合、この関数は毎回、固定フレームレートで呼び出されます。
LateUpdate Behaviour が有効の場合、LateUpdate は毎フレーム呼びだされます
OnAnimatorIKアニメーション IK (インバースキネマティクス)をセットアップするときのコールバック
OnAnimatorMoveルートモーションを修正するアニメーション動作を処理するコールバック
OnApplicationFocusプレイヤーがフォーカスを取得、または、失ったときに、すべてのゲームオブジェクトに送信されます。
OnApplicationPauseプレイヤーが一時停止したときにすべてのゲームオブジェクトに送信されます
OnApplicationQuitアプリケーションが終了する前にすべてのゲームオブジェクトで呼び出されます
OnAudioFilterReadOnAudioFilterRead が実装されている場合、Unity は DSP チェーンにカスタムフィルターを挿入します。
OnBecameInvisibleOnBecameInvisible はレンダラーがカメラから見えなくなったときに呼び出されます
OnBecameVisibleOnBecameVisible はレンダラーが任意のカメラから見えるようになると呼び出されます
OnCollisionEnterこの collider/rigidbody は他の collider/rigidbody に触れたときに OnCollisionEnter は呼び出されます。
OnCollisionEnter2Dオブジェクトのコライダーが別のコライダーに衝突したときに呼び出されます(2D 物理挙動のみ)
OnCollisionExitこの collider/rigidbody が他の collider/rigidbody と触れ合うのをやめたときに OnCollisionExit は呼び出されます。
OnCollisionExit2Dオブジェクトのコライダーと別のオブジェクトコライダーが衝突から離れた瞬間に呼び出されます(2D 物理挙動のみ)
OnCollisionStayOnCollisionStay は rigidbody/collider が他の rigidbody/collider に触れている間毎フレーム 1 度だけ呼び出されます。
OnCollisionStay2Dオブジェクトのコライダーと別のオブジェクトのコライダーが衝突している間、毎フレーム呼び出され続けます(2D 物理挙動のみ)
OnConnectedToServerサーバーとの接続に成功したときにクライアント上で呼び出されます
OnControllerColliderHitOnControllerColliderHit はキャラクターコントローラーが移動中にコライダーに衝突した際に、呼び出されます。
OnDestroyこの関数は MonoBehaviour が破棄されるときに呼び出されます
OnDisableこの関数は Behaviour が無効/非アクティブになったときに呼び出されます
OnDisconnectedFromServerサーバーとの接続が失われたか切断されたときにクライアント上で呼び出されます
OnDrawGizmos選択可能にしたり、常に描画したいギズモを描画するには OnDrawGizmos を使用します
OnDrawGizmosSelectedオブジェクトが選択されている場合は、ギズモを描画するために OnDrawGizmosSelected を実装します。
OnEnableこの関数はオブジェクトが有効/アクティブになったときに呼び出されます
OnFailedToConnect接続試行がなんらかの理由で失敗したときにクライアント上で呼び出されます
OnFailedToConnectToMasterServerMasterServer への接続に問題がある場合に、クライアントまたはサーバーで呼び出されます
OnGUIOnGUI はレンダリングと GUI イベントのハンドリングのために呼び出されます
OnJointBreakゲームオブジェクトに対するジョイントが外れたとき呼び出されます
OnJointBreak2Dゲームオブジェクトにアタッチした Joint2D が壊れたときに呼び出されます。
OnMasterServerEventMasterServer からイベントを報告してくるときにクライアントやサーバー上で呼び出されます。
OnMouseDownOnMouseDown は GUIElement または Collider 上でユーザーがマウスボタンをクリックしたときに呼び出されます
OnMouseDragOnMouseDrag はユーザーが GUIElement または Collider をマウスでクリックし、ドラッグしている間呼び出されます。
OnMouseEnterOnMouseEnter は GUIElement または Collider 上にマウスが乗ったときに呼び出されます
OnMouseExitOnMouseExit は GUIElement または Collider 上からマウス離れたときに呼び出されます
OnMouseOverOnMouseOver は GUIElement または Collider 上にマウスがあり続ける限り毎フレーム呼び出され続けます
OnMouseUpOnMouseUp はユーザーがマウスボタンを離したときに呼び出されます
OnMouseUpAsButtonOnMouseUpAsButton はマウスを押した時と同じ GUIElement や Collider 上でマウスを離した時のみに呼び出されます。
OnNetworkInstantiateNetwork.Instantiate でインスタンス化されたオブジェクトに対して呼び出されます
OnParticleCollisionパーティクルがコライダーにヒットしたときに OnParticleCollision が呼び出されます
OnParticleTriggerOnParticleTrigger は、パーティクルシステムのパーティクルが Triggers モジュールの条件を満たすときに呼び出されます。
OnPlayerConnected新しいプレイヤーが接続に成功したときにサーバー上で呼び出されます
OnPlayerDisconnectedプレイヤーがサーバーから接続が切断されるたびにサーバー上で呼び出されます
OnPostRenderOnPostRender はカメラがシーンのレンダリングを完了した後に呼び出されます
OnPreCullOnPreCull はカメラがシーンのカリングを行う直前に呼び出されます。
OnPreRenderOnPreRender はカメラがシーンのレンダリングを開始する前に呼び出されます。
OnRenderImageOnRenderImage はすべてのレンダリングが RenderImage へと完了したときに呼び出されます。
OnRenderObjectOnRenderObject はカメラがシーンをレンダリングした後に呼び出されます。
OnSerializeNetworkViewネットワークビューによって監視されるスクリプトの変数の同期をカスタマイズするために使用します
OnServerInitializedNetwork.InitializeServer が実行され完了したときにサーバー上で呼び出されます
OnTransformChildrenChangedこの関数は GameObject の Transform のすべての子の中で変更があったときに呼び出されます
OnTransformParentChangedこの関数は GameObject の Transform の parent プロパティーに変更があったときに呼び出されます
OnTriggerEnter Collider が他のトリガーイベントに侵入したときに OnTriggerEnter が呼び出されます。
OnTriggerEnter2Dオブジェクトにアタッチしたトリガーの中に別のオブジェクトが入ったときに呼び出されます。(2D 物理挙動のみ)
OnTriggerExit Collider が other のトリガーに触れるのをやめたときに OnTriggerExit は呼び出されます。
OnTriggerExit2Dトリガー状態のオブジェクトのコライダーと別のオブジェクトのコライダーが衝突から離れた瞬間に、呼び出されます。(2D 物理挙動のみ)
OnTriggerStayOnTriggerStay は Collider が他のトリガーと当たり続けている毎フレーム呼び出されます
OnTriggerStay2Dトリガー状態のオブジェクトのコライダーと別のオブジェクトのコライダー衝突している間、毎フレーム呼び出され続けます。(2D 物理挙動のみ)
OnValidateこの関数はスクリプトがロードされた時やインスペクターの値が変更されたときに呼び出されます(この呼出はエディター上のみ)
OnWillRenderObjectOnWillRenderObject is called for each camera if the object is visible and not a UI element.
Resetデフォルト値にリセットします
StartStart はスクリプトが有効で、Update メソッドが最初に呼び出される前のフレームで呼び出されます
UpdateUpdate は MonoBehaviour が有効の場合に、毎フレーム呼び出されます