UiDropTargetInterface Class Reference

Inherits AZ::ComponentBus.

Public Types
enum	{ DropStateNormal = 0 , DropStateValid , DropStateInvalid , NumDropStates }
using	DropState = int

Public Member Functions
virtual const LyShine::ActionName &	GetOnDropActionName ()=0
	Get the OnDrop action name.
virtual void	SetOnDropActionName (const LyShine::ActionName &actionName)=0
	Set the OnDrop action name.
virtual void	HandleDropHoverStart (AZ::EntityId draggable)=0
	Called when mouse/touch enters the bounds of this drop target while dragging a UiDraggableComponent.
virtual void	HandleDropHoverEnd (AZ::EntityId draggable)=0
	Called on the currently drop hovered drop target component when mouse/touch moves outside of bounds.
virtual void	HandleDrop (AZ::EntityId draggable)=0
	Called when a draggable is dropped on this drop target.
virtual DropState	GetDropState ()=0
	Get the state of the drop.
virtual void	SetDropState (DropState dropState)=0

Static Public Attributes
static const AZ::EBusHandlerPolicy	HandlerPolicy = AZ::EBusHandlerPolicy::Single
	Only one component on a entity can implement the events.

Member Function Documentation

SetDropState()

virtual void UiDropTargetInterface::SetDropState ( DropState  dropState )

pure virtual

Set the state of the drop target. The state affects the visual state of the drop target and can be used to indicate when it has a valid draggable hovering over it.

---

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

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