Open 3D Engine AzFramework 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.
Public Types | Public Member Functions | Static Public Attributes | List of all members
UiFrameworkInterface Class Referenceabstract

Bus interface for other systems in game to access to the in-game UI system. More...

#include <UiFrameworkBus.h>

Inherits AZ::EBusTraits.

Public Types

using EntityList = AZStd::vector< AZ::Entity * >
 
using EntityIdSet = AZStd::unordered_set< AZ::EntityId >
 
using MutexType = AZStd::recursive_mutex
 

Public Member Functions

virtual bool HasUiElementComponent (AZ::Entity *entity)=0
 Returns true if the given entity has a UiElementComponent, false otherwise.
 
virtual void AddEditorOnlyEntity (AZ::Entity *editorOnlyEntity, EntityIdSet &editorOnlyEntities)=0
 
virtual void HandleEditorOnlyEntities (const EntityList &exportSliceEntities, const EntityIdSet &editorOnlyEntityIds)=0
 Removes all editor-only entities from the entity hierarchy.
 

Static Public Attributes

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

Detailed Description

Bus interface for other systems in game to access to the in-game UI system.

Member Function Documentation

◆ AddEditorOnlyEntity()

virtual void UiFrameworkInterface::AddEditorOnlyEntity ( AZ::Entity *  editorOnlyEntity,
EntityIdSet &  editorOnlyEntities 
)
pure virtual

Given an editor-only entity, add it to the given list of editor-only entity IDs.

The UI system will add all descendants of the editor-only entity to the list of editor-only entity IDs. Any entity that is editor-only will also have its child hiearchy treated as editor only.

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