Class EventTrigger
Receives events from the EventSystem and calls registered functions for each event.
Implements
Inherited Members
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.");
}
}