docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class EventTrigger

    Receives events from the EventSystem and calls registered functions for each event.

    Inheritance
    object
    Object
    Component
    Behaviour
    MonoBehaviour
    EventTrigger
    Implements
    IPointerEnterHandler
    IPointerExitHandler
    IPointerDownHandler
    IPointerUpHandler
    IPointerClickHandler
    IInitializePotentialDragHandler
    IBeginDragHandler
    IDragHandler
    IEndDragHandler
    IDropHandler
    IScrollHandler
    IUpdateSelectedHandler
    ISelectHandler
    IDeselectHandler
    IMoveHandler
    ISubmitHandler
    ICancelHandler
    IEventSystemHandler
    Inherited Members
    MonoBehaviour.IsInvoking()
    MonoBehaviour.CancelInvoke()
    MonoBehaviour.Invoke(string, float)
    MonoBehaviour.InvokeRepeating(string, float, float)
    MonoBehaviour.CancelInvoke(string)
    MonoBehaviour.IsInvoking(string)
    MonoBehaviour.StartCoroutine(string)
    MonoBehaviour.StartCoroutine(string, object)
    MonoBehaviour.StartCoroutine(IEnumerator)
    MonoBehaviour.StartCoroutine_Auto(IEnumerator)
    MonoBehaviour.StopCoroutine(IEnumerator)
    MonoBehaviour.StopCoroutine(Coroutine)
    MonoBehaviour.StopCoroutine(string)
    MonoBehaviour.StopAllCoroutines()
    MonoBehaviour.print(object)
    MonoBehaviour.destroyCancellationToken
    MonoBehaviour.useGUILayout
    MonoBehaviour.didStart
    MonoBehaviour.didAwake
    MonoBehaviour.runInEditMode
    Behaviour.enabled
    Behaviour.isActiveAndEnabled
    Component.GetComponent(Type)
    Component.GetComponent<T>()
    Component.TryGetComponent(Type, out Component)
    Component.TryGetComponent<T>(out T)
    Component.GetComponent(string)
    Component.GetComponentInChildren(Type, bool)
    Component.GetComponentInChildren(Type)
    Component.GetComponentInChildren<T>(bool)
    Component.GetComponentInChildren<T>()
    Component.GetComponentsInChildren(Type, bool)
    Component.GetComponentsInChildren(Type)
    Component.GetComponentsInChildren<T>(bool)
    Component.GetComponentsInChildren<T>(bool, List<T>)
    Component.GetComponentsInChildren<T>()
    Component.GetComponentsInChildren<T>(List<T>)
    Component.GetComponentInParent(Type, bool)
    Component.GetComponentInParent(Type)
    Component.GetComponentInParent<T>(bool)
    Component.GetComponentInParent<T>()
    Component.GetComponentsInParent(Type, bool)
    Component.GetComponentsInParent(Type)
    Component.GetComponentsInParent<T>(bool)
    Component.GetComponentsInParent<T>(bool, List<T>)
    Component.GetComponentsInParent<T>()
    Component.GetComponents(Type)
    Component.GetComponents(Type, List<Component>)
    Component.GetComponents<T>(List<T>)
    Component.GetComponents<T>()
    Component.GetComponentIndex()
    Component.CompareTag(string)
    Component.CompareTag(TagHandle)
    Component.SendMessageUpwards(string, object, SendMessageOptions)
    Component.SendMessageUpwards(string, object)
    Component.SendMessageUpwards(string)
    Component.SendMessageUpwards(string, SendMessageOptions)
    Component.SendMessage(string, object)
    Component.SendMessage(string)
    Component.SendMessage(string, object, SendMessageOptions)
    Component.SendMessage(string, SendMessageOptions)
    Component.BroadcastMessage(string, object, SendMessageOptions)
    Component.BroadcastMessage(string, object)
    Component.BroadcastMessage(string)
    Component.BroadcastMessage(string, SendMessageOptions)
    Component.transform
    Component.transformHandle
    Component.gameObject
    Component.tag
    Object.GetEntityId()
    Object.MemberwiseClone()
    Object.GetInstanceID()
    Object.GetHashCode()
    Object.Equals(object)
    Object.InstantiateAsync<T>(T)
    Object.InstantiateAsync<T>(T, Transform)
    Object.InstantiateAsync<T>(T, Vector3, Quaternion)
    Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)
    Object.InstantiateAsync<T>(T, int)
    Object.InstantiateAsync<T>(T, int, Transform)
    Object.InstantiateAsync<T>(T, int, Vector3, Quaternion)
    Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)
    Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion)
    Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion, CancellationToken)
    Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)
    Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, CancellationToken)
    Object.InstantiateAsync<T>(T, InstantiateParameters, CancellationToken)
    Object.InstantiateAsync<T>(T, int, InstantiateParameters, CancellationToken)
    Object.InstantiateAsync<T>(T, Vector3, Quaternion, InstantiateParameters, CancellationToken)
    Object.InstantiateAsync<T>(T, int, Vector3, Quaternion, InstantiateParameters, CancellationToken)
    Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, InstantiateParameters, CancellationToken)
    Object.Instantiate(Object, Vector3, Quaternion)
    Object.Instantiate(Object, Vector3, Quaternion, Transform)
    Object.Instantiate(Object)
    Object.Instantiate(Object, Scene)
    Object.Instantiate<T>(T, InstantiateParameters)
    Object.Instantiate<T>(T, Vector3, Quaternion, InstantiateParameters)
    Object.Instantiate(Object, Transform)
    Object.Instantiate(Object, Transform, bool)
    Object.Instantiate<T>(T)
    Object.Instantiate<T>(T, Vector3, Quaternion)
    Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
    Object.Instantiate<T>(T, Transform)
    Object.Instantiate<T>(T, Transform, bool)
    Object.Destroy(Object, float)
    Object.Destroy(Object)
    Object.DestroyImmediate(Object, bool)
    Object.DestroyImmediate(Object)
    Object.FindObjectsOfType(Type)
    Object.FindObjectsOfType(Type, bool)
    Object.FindObjectsByType(Type, FindObjectsSortMode)
    Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)
    Object.FindObjectsByType(Type)
    Object.FindObjectsByType(Type, FindObjectsInactive)
    Object.DontDestroyOnLoad(Object)
    Object.DestroyObject(Object, float)
    Object.DestroyObject(Object)
    Object.FindSceneObjectsOfType(Type)
    Object.FindObjectsOfTypeIncludingAssets(Type)
    Object.FindObjectsOfType<T>()
    Object.FindObjectsByType<T>(FindObjectsSortMode)
    Object.FindObjectsOfType<T>(bool)
    Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
    Object.FindObjectOfType<T>()
    Object.FindObjectOfType<T>(bool)
    Object.FindFirstObjectByType<T>()
    Object.FindAnyObjectByType<T>()
    Object.FindFirstObjectByType<T>(FindObjectsInactive)
    Object.FindAnyObjectByType<T>(FindObjectsInactive)
    Object.FindObjectsByType<T>()
    Object.FindObjectsByType<T>(FindObjectsInactive)
    Object.FindObjectsOfTypeAll(Type)
    Object.FindObjectOfType(Type)
    Object.FindFirstObjectByType(Type)
    Object.FindAnyObjectByType(Type)
    Object.FindObjectOfType(Type, bool)
    Object.FindFirstObjectByType(Type, FindObjectsInactive)
    Object.FindAnyObjectByType(Type, FindObjectsInactive)
    Object.ToString()
    Object.name
    Object.hideFlags
    object.Equals(object, object)
    object.GetType()
    object.ReferenceEquals(object, object)
    Namespace: UnityEngine.EventSystems
    Assembly: UnityEngine.UI.dll
    Syntax
    [AddComponentMenu("Event/Event Trigger")]
    public class EventTrigger : MonoBehaviour, IPointerEnterHandler, IPointerExitHandler, IPointerDownHandler, IPointerUpHandler, IPointerClickHandler, IInitializePotentialDragHandler, IBeginDragHandler, IDragHandler, IEndDragHandler, IDropHandler, IScrollHandler, IUpdateSelectedHandler, ISelectHandler, IDeselectHandler, IMoveHandler, ISubmitHandler, ICancelHandler, IEventSystemHandler
    Remarks

    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.

    NOTE: Attaching this component to a GameObject will make that object intercept ALL events, and no events will propagate to parent objects.

    Examples

    There are two ways to intercept events: You can extend EventTrigger, and override the functions for the events you want to intercept, as shown in the following example:

    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.");
    }
    

    }

    or you can specify individual delegates:

    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.");
    }
    

    }

    Constructors

    EventTrigger()

    Protected default constructor. Use UnityEngine.GameObject.AddComponent<T>() to add an EventTrigger to a GameObject.

    Declaration
    protected EventTrigger()

    Properties

    triggers

    All the functions registered in this EventTrigger

    Declaration
    public List<EventTrigger.Entry> triggers { get; set; }
    Property Value
    Type Description
    List<EventTrigger.Entry>

    Methods

    OnBeginDrag(PointerEventData)

    Called by the EventSystem before a drag is started.

    Declaration
    public virtual void OnBeginDrag(PointerEventData eventData)
    Parameters
    Type Name Description
    PointerEventData eventData

    The pointer event data for the drag.

    OnCancel(BaseEventData)

    Called by the EventSystem when a Cancel event occurs.

    Declaration
    public virtual void OnCancel(BaseEventData eventData)
    Parameters
    Type Name Description
    BaseEventData eventData

    The event data for the cancel.

    OnDeselect(BaseEventData)

    Called by the EventSystem when this object is being deselected.

    Declaration
    public virtual void OnDeselect(BaseEventData eventData)
    Parameters
    Type Name Description
    BaseEventData eventData

    The event data for the deselection.

    OnDrag(PointerEventData)

    Called by the EventSystem every time the pointer is moved during dragging.

    Declaration
    public virtual void OnDrag(PointerEventData eventData)
    Parameters
    Type Name Description
    PointerEventData eventData

    The pointer event data for the drag.

    OnDrop(PointerEventData)

    Called by the EventSystem when an object can accept a drop.

    Declaration
    public virtual void OnDrop(PointerEventData eventData)
    Parameters
    Type Name Description
    PointerEventData eventData

    The pointer event data for the drop.

    OnEndDrag(PointerEventData)

    Called by the EventSystem once dragging ends.

    Declaration
    public virtual void OnEndDrag(PointerEventData eventData)
    Parameters
    Type Name Description
    PointerEventData eventData

    The pointer event data for the drag.

    OnInitializePotentialDrag(PointerEventData)

    Called by the EventSystem when a drag has been found, but before it is valid to begin the drag.

    Declaration
    public virtual void OnInitializePotentialDrag(PointerEventData eventData)
    Parameters
    Type Name Description
    PointerEventData eventData

    The pointer event data for the drag.

    OnMove(AxisEventData)

    Called by the EventSystem when a move event occurs.

    Declaration
    public virtual void OnMove(AxisEventData eventData)
    Parameters
    Type Name Description
    AxisEventData eventData

    The axis event data for the move.

    OnPointerClick(PointerEventData)

    Called by the EventSystem when a Click event occurs.

    Declaration
    public virtual void OnPointerClick(PointerEventData eventData)
    Parameters
    Type Name Description
    PointerEventData eventData

    The pointer event data for the click.

    OnPointerDown(PointerEventData)

    Called by the EventSystem when a PointerDown event occurs.

    Declaration
    public virtual void OnPointerDown(PointerEventData eventData)
    Parameters
    Type Name Description
    PointerEventData eventData

    The pointer event data for the press.

    OnPointerEnter(PointerEventData)

    Called by the EventSystem when the pointer enters this object.

    Declaration
    public virtual void OnPointerEnter(PointerEventData eventData)
    Parameters
    Type Name Description
    PointerEventData eventData

    The pointer event data for the enter.

    OnPointerExit(PointerEventData)

    Called by the EventSystem when the pointer exits this object.

    Declaration
    public virtual void OnPointerExit(PointerEventData eventData)
    Parameters
    Type Name Description
    PointerEventData eventData

    The pointer event data for the exit.

    OnPointerUp(PointerEventData)

    Called by the EventSystem when a PointerUp event occurs.

    Declaration
    public virtual void OnPointerUp(PointerEventData eventData)
    Parameters
    Type Name Description
    PointerEventData eventData

    The pointer event data for the release.

    OnScroll(PointerEventData)

    Called by the EventSystem when a new Scroll event occurs.

    Declaration
    public virtual void OnScroll(PointerEventData eventData)
    Parameters
    Type Name Description
    PointerEventData eventData

    The pointer event data for the scroll.

    OnSelect(BaseEventData)

    Called by the EventSystem when this object becomes selected.

    Declaration
    public virtual void OnSelect(BaseEventData eventData)
    Parameters
    Type Name Description
    BaseEventData eventData

    The event data for the selection.

    OnSubmit(BaseEventData)

    Called by the EventSystem when a Submit event occurs.

    Declaration
    public virtual void OnSubmit(BaseEventData eventData)
    Parameters
    Type Name Description
    BaseEventData eventData

    The event data for the submit.

    OnUpdateSelected(BaseEventData)

    Called by the EventSystem to update the selected object.

    Declaration
    public virtual void OnUpdateSelected(BaseEventData eventData)
    Parameters
    Type Name Description
    BaseEventData eventData

    The event data for the update.

    Examples
      using UnityEngine;
                            using UnityEngine.EventSystems;
    
                            public class UpdateSelectedExample : MonoBehaviour, IUpdateSelectedHandler
                            {
                                public void OnUpdateSelected(BaseEventData data)
                                {
                                    Debug.Log("OnUpdateSelected called.");
                                }
                            }
    

    Implements

    IPointerEnterHandler
    IPointerExitHandler
    IPointerDownHandler
    IPointerUpHandler
    IPointerClickHandler
    IInitializePotentialDragHandler
    IBeginDragHandler
    IDragHandler
    IEndDragHandler
    IDropHandler
    IScrollHandler
    IUpdateSelectedHandler
    ISelectHandler
    IDeselectHandler
    IMoveHandler
    ISubmitHandler
    ICancelHandler
    IEventSystemHandler
    In This Article
    Back to top
    Copyright © 2026 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)