Class EventTrigger | Unity UI | 1.0.0
docs.unity3d.com
    Show / Hide Table of Contents

    Class EventTrigger

    Inheritance
    Object
    Object
    Component
    Behaviour
    MonoBehaviour
    EventTrigger
    Inherited Members
    MonoBehaviour.IsInvoking()
    MonoBehaviour.CancelInvoke()
    MonoBehaviour.Invoke(String, Single)
    MonoBehaviour.InvokeRepeating(String, Single, Single)
    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.useGUILayout
    MonoBehaviour.runInEditMode
    Behaviour.enabled
    Behaviour.isActiveAndEnabled
    Component.GetComponent(Type)
    Component.GetComponent<T>()
    Component.TryGetComponent(Type, Component)
    Component.TryGetComponent<T>(T)
    Component.GetComponent(String)
    Component.GetComponentInChildren(Type, Boolean)
    Component.GetComponentInChildren(Type)
    Component.GetComponentInChildren<T>(Boolean)
    Component.GetComponentInChildren<T>()
    Component.GetComponentsInChildren(Type, Boolean)
    Component.GetComponentsInChildren(Type)
    Component.GetComponentsInChildren<T>(Boolean)
    Component.GetComponentsInChildren<T>(Boolean, List<T>)
    Component.GetComponentsInChildren<T>()
    Component.GetComponentsInChildren<T>(List<T>)
    Component.GetComponentInParent(Type)
    Component.GetComponentInParent<T>()
    Component.GetComponentsInParent(Type, Boolean)
    Component.GetComponentsInParent(Type)
    Component.GetComponentsInParent<T>(Boolean)
    Component.GetComponentsInParent<T>(Boolean, List<T>)
    Component.GetComponentsInParent<T>()
    Component.GetComponents(Type)
    Component.GetComponents(Type, List<Component>)
    Component.GetComponents<T>(List<T>)
    Component.GetComponents<T>()
    Component.CompareTag(String)
    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.gameObject
    Component.tag
    Component.rigidbody
    Component.rigidbody2D
    Component.camera
    Component.light
    Component.animation
    Component.constantForce
    Component.renderer
    Component.audio
    Component.networkView
    Component.collider
    Component.collider2D
    Component.hingeJoint
    Component.particleSystem
    Object.GetInstanceID()
    Object.GetHashCode()
    Object.Equals(Object)
    Object.Instantiate(Object, Vector3, Quaternion)
    Object.Instantiate(Object, Vector3, Quaternion, Transform)
    Object.Instantiate(Object)
    Object.Instantiate(Object, Transform)
    Object.Instantiate(Object, Transform, Boolean)
    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, Boolean)
    Object.Destroy(Object, Single)
    Object.Destroy(Object)
    Object.DestroyImmediate(Object, Boolean)
    Object.DestroyImmediate(Object)
    Object.FindObjectsOfType(Type)
    Object.FindObjectsOfType(Type, Boolean)
    Object.DontDestroyOnLoad(Object)
    Object.DestroyObject(Object, Single)
    Object.DestroyObject(Object)
    Object.FindSceneObjectsOfType(Type)
    Object.FindObjectsOfTypeIncludingAssets(Type)
    Object.FindObjectsOfType<T>()
    UnityEngine.Object.FindObjectsOfType<T>(System.Boolean)
    Object.FindObjectOfType<T>()
    UnityEngine.Object.FindObjectOfType<T>(System.Boolean)
    Object.FindObjectsOfTypeAll(Type)
    Object.FindObjectOfType(Type)
    Object.FindObjectOfType(Type, Boolean)
    Object.ToString()
    Object.name
    Object.hideFlags
    Namespace: UnityEngine.EventSystems
    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

    Constructors

    EventTrigger()

    Declaration
    protected EventTrigger()

    Properties

    delegates

    Declaration
    [Obsolete("Please use triggers instead (UnityUpgradable) -> triggers", true)]
    public List<EventTrigger.Entry> delegates { get; set; }
    Property Value
    Type Description
    List<EventTrigger.Entry>

    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 before a drag is started.

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

    OnCancel(BaseEventData)

    Called by the EventSystem when a Cancel event occurs.

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

    OnDeselect(BaseEventData)

    Called by the EventSystem when a new object is being selected.

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

    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
    Implements
    IDragHandler.OnDrag(PointerEventData)

    OnDrop(PointerEventData)

    Called by the EventSystem when an object accepts a drop.

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

    OnEndDrag(PointerEventData)

    Called by the EventSystem once dragging ends.

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

    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
    Implements
    IInitializePotentialDragHandler.OnInitializePotentialDrag(PointerEventData)

    OnMove(AxisEventData)

    Called by the EventSystem when a Move event occurs.

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

    OnPointerClick(PointerEventData)

    Called by the EventSystem when a Click event occurs.

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

    OnPointerDown(PointerEventData)

    Called by the EventSystem when a PointerDown event occurs.

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

    OnPointerEnter(PointerEventData)

    Called by the EventSystem when the pointer enters the object associated with this EventTrigger.

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

    OnPointerExit(PointerEventData)

    Called by the EventSystem when the pointer exits the object associated with this EventTrigger.

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

    OnPointerUp(PointerEventData)

    Called by the EventSystem when a PointerUp event occurs.

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

    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
    Implements
    IScrollHandler.OnScroll(PointerEventData)

    OnSelect(BaseEventData)

    Called by the EventSystem when a Select event occurs.

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

    OnSubmit(BaseEventData)

    Called by the EventSystem when a Submit event occurs.

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

    OnUpdateSelected(BaseEventData)

    Called by the EventSystem when the object associated with this EventTrigger is updated.

    Declaration
    public virtual void OnUpdateSelected(BaseEventData eventData)
    Parameters
    Type Name Description
    BaseEventData eventData
    Implements
    IUpdateSelectedHandler.OnUpdateSelected(BaseEventData)
    Back to top Copyright © 2020 Unity Technologies
    Generated by DocFX
    on October 6, 2020