UiCanvasInputNotifications Class Reference

#include <UiCanvasBus.h>

Inherits AZ::ComponentBus.

Public Member Functions
virtual void	OnCanvasPrimaryPressed ([[maybe_unused]] AZ::EntityId entityId)
virtual void	OnCanvasPrimaryReleased ([[maybe_unused]] AZ::EntityId entityId)
virtual void	OnCanvasMultiTouchPressed ([[maybe_unused]] AZ::EntityId entityId, [[maybe_unused]] int multiTouchIndex)
virtual void	OnCanvasMultiTouchReleased ([[maybe_unused]] AZ::EntityId entityId, [[maybe_unused]] int multiTouchIndex)
virtual void	OnCanvasHoverStart ([[maybe_unused]] AZ::EntityId entityId)
	Called when an element starts being hovered.
virtual void	OnCanvasHoverEnd ([[maybe_unused]] AZ::EntityId entityId)
	Called when an element ends being hovered.
virtual void	OnCanvasEnterPressed ([[maybe_unused]] AZ::EntityId entityId)
	Called when the enter key is pressed.
virtual void	OnCanvasEnterReleased ([[maybe_unused]] AZ::EntityId entityId)
	Called when the enter key is released.

Detailed Description

Interface class that listeners need to implement to be notified of canvas input. Note that interactables already get methods called on them when they themselves are interacted with. This notification bus is intended for other entities or Lua to know when some other entities are interacted with.

Member Function Documentation

OnCanvasMultiTouchPressed()

virtual void UiCanvasInputNotifications::OnCanvasMultiTouchPressed ( [[maybe_unused] ] AZ::EntityId  entityId, [[maybe_unused] ] int  multiTouchIndex  )

inlinevirtual

Called when an element is pressed. Will be an invalid entity id if no interactable was pressed.

OnCanvasMultiTouchReleased()

virtual void UiCanvasInputNotifications::OnCanvasMultiTouchReleased ( [[maybe_unused] ] AZ::EntityId  entityId, [[maybe_unused] ] int  multiTouchIndex  )

inlinevirtual

Called when an element is released. The released entity that is sent is the entity that was active (if any).

OnCanvasPrimaryPressed()

virtual void UiCanvasInputNotifications::OnCanvasPrimaryPressed ( [[maybe_unused] ] AZ::EntityId  entityId )

inlinevirtual

Called when an element is pressed. Will return an invalid entity id if no interactable was pressed.

OnCanvasPrimaryReleased()

virtual void UiCanvasInputNotifications::OnCanvasPrimaryReleased ( [[maybe_unused] ] AZ::EntityId  entityId )

inlinevirtual

Called when an element is released. The released entity that is sent is the entity that was active (if any).

---

The documentation for this class was generated from the following file:

• Gems/LyShine/Code/Include/LyShine/Bus/UiCanvasBus.h