Open 3D Engine LyShine Gem API Reference  24.09
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Types | Public Member Functions | Static Public Attributes | List of all members
UiInteractableActionsInterface Class Referenceabstract

Inherits AZ::ComponentBus.

Public Types

typedef AZStd::function< void(AZ::EntityId)> OnActionCallback
 

Public Member Functions

virtual const LyShine::ActionName & GetHoverStartActionName ()=0
 Get the hover start action name.
 
virtual void SetHoverStartActionName (const LyShine::ActionName &actionName)=0
 Set the hover start action name.
 
virtual const LyShine::ActionName & GetHoverEndActionName ()=0
 Get the hover end action name.
 
virtual void SetHoverEndActionName (const LyShine::ActionName &actionName)=0
 Set the hover end action name.
 
virtual const LyShine::ActionName & GetPressedActionName ()=0
 Get the pressed action name.
 
virtual void SetPressedActionName (const LyShine::ActionName &actionName)=0
 Set the pressed action name.
 
virtual const LyShine::ActionName & GetReleasedActionName ()=0
 Get the released action name.
 
virtual void SetReleasedActionName (const LyShine::ActionName &actionName)=0
 Set the released action name.
 
virtual const LyShine::ActionName & GetOutsideReleasedActionName () const =0
 Get the release outside of the UI element action name.
 
virtual void SetOutsideReleasedActionName (const LyShine::ActionName &actionName)=0
 Set the release outside of the UI element action name.
 
virtual OnActionCallback GetHoverStartActionCallback ()=0
 Get the hover start callback.
 
virtual void SetHoverStartActionCallback (OnActionCallback onActionCallback)=0
 Set the hover start callback.
 
virtual OnActionCallback GetHoverEndActionCallback ()=0
 Get the hover end callback.
 
virtual void SetHoverEndActionCallback (OnActionCallback onActionCallback)=0
 Set the hover end callback.
 
virtual OnActionCallback GetPressedActionCallback ()=0
 Get the pressed callback.
 
virtual void SetPressedActionCallback (OnActionCallback onActionCallback)=0
 Set the pressed callback.
 
virtual OnActionCallback GetReleasedActionCallback ()=0
 Get the release callback.
 
virtual void SetReleasedActionCallback (OnActionCallback onActionCallback)=0
 Set the release callback.
 

Static Public Attributes

static const AZ::EBusHandlerPolicy HandlerPolicy = AZ::EBusHandlerPolicy::Single
 Only one component on a entity can implement the events.
 
The documentation for this class was generated from the following file: