Open 3D Engine LyShine Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
UiNavigationInterface Class Referenceabstract

Inherits AZ::ComponentBus.

Public Types

enum class  NavigationMode { Automatic , Custom , None }
 

Public Member Functions

virtual NavigationMode GetNavigationMode ()=0
 Get the navigation mode.
 
virtual void SetNavigationMode (NavigationMode navigationMode)=0
 Set the navigation mode.
 
virtual AZ::EntityId GetOnUpEntity ()=0
 Get the entity to receive focus when up is pressed.
 
virtual void SetOnUpEntity (AZ::EntityId entityId)=0
 Set the entity to receive focus when up is pressed.
 
virtual AZ::EntityId GetOnDownEntity ()=0
 Get the entity to receive focus when down is pressed.
 
virtual void SetOnDownEntity (AZ::EntityId entityId)=0
 Set the entity to receive focus when down is pressed.
 
virtual AZ::EntityId GetOnLeftEntity ()=0
 Get the entity to receive focus when left is pressed.
 
virtual void SetOnLeftEntity (AZ::EntityId entityId)=0
 Set the entity to receive focus when left is pressed.
 
virtual AZ::EntityId GetOnRightEntity ()=0
 Get the entity to receive focus when right is pressed.
 
virtual void SetOnRightEntity (AZ::EntityId entityId)=0
 Set the entity to receive focus when right is pressed.
 

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: