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 Member Functions | Static Public Attributes | List of all members
UiSystemInterface Class Referenceabstract

Inherits AZ::EBusTraits.

Public Member Functions

virtual void RegisterComponentTypeForMenuOrdering ([[maybe_unused]] const AZ::Uuid &typeUuid)
 
virtual const AZStd::vector< AZ::Uuid > * GetComponentTypesForMenuOrdering ()=0
 
virtual const AZStd::list< AZ::ComponentDescriptor * > * GetLyShineComponentDescriptors ()=0
 We use this for metrics to find out which components are part of the LyShine Gem.
 

Static Public Attributes

static const AZ::EBusHandlerPolicy HandlerPolicy = AZ::EBusHandlerPolicy::Single
 
static const AZ::EBusAddressPolicy AddressPolicy = AZ::EBusAddressPolicy::Single
 

Member Function Documentation

◆ GetComponentTypesForMenuOrdering()

virtual const AZStd::vector<AZ::Uuid>* UiSystemInterface::GetComponentTypesForMenuOrdering ( )
pure virtual

Get the UI component types registered with the UI system This is a short-term solution until there is a way to get the registered components from the framework in an order that we want for the menus and the properties pane

◆ RegisterComponentTypeForMenuOrdering()

virtual void UiSystemInterface::RegisterComponentTypeForMenuOrdering ( [[maybe_unused] ] const AZ::Uuid &  typeUuid)
inlinevirtual

Register a component type with the UI system. The order in which component types are registered is the order that they show up in the add component and in the properties pane. This will go away once there is a system that orders things the way we want based on the existing component registration.

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