Class UnityMessageListener
Inheritance
UnityMessageListener
Implements
IPointerEnterHandler
IPointerExitHandler
IPointerDownHandler
IPointerUpHandler
IPointerClickHandler
IBeginDragHandler
IDragHandler
IEndDragHandler
IDropHandler
IScrollHandler
ISelectHandler
IDeselectHandler
ISubmitHandler
ICancelHandler
IMoveHandler
IEventSystemHandler
Inherited Members
Object.FindObjectsByType<T>(FindObjectsSortMode)
Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
Object.FindFirstObjectByType<T>()
Object.FindAnyObjectByType<T>()
Object.FindFirstObjectByType<T>(FindObjectsInactive)
Object.FindAnyObjectByType<T>(FindObjectsInactive)
Assembly: Unity.VisualScripting.Core.dll
Syntax
[AddComponentMenu("")]
[Obsolete("UnityMessageListener is deprecated and has been replaced by separate message listeners for each event, eg. UnityOnCollisionEnterMessageListener or UnityOnButtonClickMessageListener.")]
public sealed class UnityMessageListener : MessageListener, IPointerEnterHandler, IPointerExitHandler, IPointerDownHandler, IPointerUpHandler, IPointerClickHandler, IBeginDragHandler, IDragHandler, IEndDragHandler, IDropHandler, IScrollHandler, ISelectHandler, IDeselectHandler, ISubmitHandler, ICancelHandler, IMoveHandler, IEventSystemHandler
Methods
AddGUIListeners()
Declaration
public void AddGUIListeners()
OnBeginDrag(PointerEventData)
Called by a BaseInputModule before a drag is started.
Declaration
public void OnBeginDrag(PointerEventData eventData)
Parameters
Type |
Name |
Description |
PointerEventData |
eventData |
|
OnCancel(BaseEventData)
Declaration
public void OnCancel(BaseEventData eventData)
Parameters
Type |
Name |
Description |
BaseEventData |
eventData |
|
OnDeselect(BaseEventData)
Called by the EventSystem when a new object is being selected.
Declaration
public void OnDeselect(BaseEventData eventData)
Parameters
Type |
Name |
Description |
BaseEventData |
eventData |
|
OnDrag(PointerEventData)
When dragging is occurring this will be called every time the cursor is moved.
Declaration
public void OnDrag(PointerEventData eventData)
Parameters
Type |
Name |
Description |
PointerEventData |
eventData |
|
OnDrop(PointerEventData)
Called by a BaseInputModule on a target that can accept a drop.
Declaration
public void OnDrop(PointerEventData eventData)
Parameters
Type |
Name |
Description |
PointerEventData |
eventData |
|
OnEndDrag(PointerEventData)
Called by a BaseInputModule when a drag is ended.
Declaration
public void OnEndDrag(PointerEventData eventData)
Parameters
Type |
Name |
Description |
PointerEventData |
eventData |
|
OnMove(AxisEventData)
Called by a BaseInputModule when a move event occurs.
Declaration
public void OnMove(AxisEventData eventData)
Parameters
Type |
Name |
Description |
AxisEventData |
eventData |
|
OnPointerClick(PointerEventData)
Use this callback to detect clicks.
Declaration
public void OnPointerClick(PointerEventData eventData)
Parameters
Type |
Name |
Description |
PointerEventData |
eventData |
|
OnPointerDown(PointerEventData)
Use this callback to detect pointer down events.
Declaration
public void OnPointerDown(PointerEventData eventData)
Parameters
Type |
Name |
Description |
PointerEventData |
eventData |
|
OnPointerEnter(PointerEventData)
Use this callback to detect pointer enter events
Declaration
public void OnPointerEnter(PointerEventData eventData)
Parameters
Type |
Name |
Description |
PointerEventData |
eventData |
|
OnPointerExit(PointerEventData)
Use this callback to detect pointer exit events
Declaration
public void OnPointerExit(PointerEventData eventData)
Parameters
Type |
Name |
Description |
PointerEventData |
eventData |
|
OnPointerUp(PointerEventData)
Use this callback to detect pointer up events.
Declaration
public void OnPointerUp(PointerEventData eventData)
Parameters
Type |
Name |
Description |
PointerEventData |
eventData |
|
Use this callback to detect scroll events.
Declaration
public void OnScroll(PointerEventData eventData)
Parameters
Type |
Name |
Description |
PointerEventData |
eventData |
|
OnSelect(BaseEventData)
Declaration
public void OnSelect(BaseEventData eventData)
Parameters
Type |
Name |
Description |
BaseEventData |
eventData |
|
OnSubmit(BaseEventData)
Declaration
public void OnSubmit(BaseEventData eventData)
Parameters
Type |
Name |
Description |
BaseEventData |
eventData |
|
Implements
UnityEngine.EventSystems.IPointerEnterHandler
UnityEngine.EventSystems.IPointerExitHandler
UnityEngine.EventSystems.IPointerDownHandler
UnityEngine.EventSystems.IPointerUpHandler
UnityEngine.EventSystems.IPointerClickHandler
UnityEngine.EventSystems.IBeginDragHandler
UnityEngine.EventSystems.IDragHandler
UnityEngine.EventSystems.IEndDragHandler
UnityEngine.EventSystems.IDropHandler
UnityEngine.EventSystems.IScrollHandler
UnityEngine.EventSystems.ISelectHandler
UnityEngine.EventSystems.IDeselectHandler
UnityEngine.EventSystems.ISubmitHandler
UnityEngine.EventSystems.ICancelHandler
UnityEngine.EventSystems.IMoveHandler
UnityEngine.EventSystems.IEventSystemHandler
Extension Methods
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.