Open 3D Engine AzToolsFramework 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.
AzToolsFramework::Layers::EditorLayerCreationNotification Class Referenceabstract

#include <EditorLayerComponentBus.h>

Inherits AZ::EBusTraits.

Public Member Functions

virtual void OnNewLayerEntity (const AZ::EntityId &entityId, AZStd::vector< AZ::Component * > &componentsToAdd)=0
 

Static Public Attributes

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

Detailed Description

This is a single bus with multiple listeners, for allowing systems to listen when specific layer events occur.

Member Function Documentation

◆ OnNewLayerEntity()

virtual void AzToolsFramework::Layers::EditorLayerCreationNotification::OnNewLayerEntity ( const AZ::EntityId &  entityId,
AZStd::vector< AZ::Component * > &  componentsToAdd 
)
pure virtual

Called when a new layer is created. Run custom logic you need for new layers on this bus, including adding components to the list of components to add to your layer, if you need custom layer components.

Parameters
entityIdThe EntityId of the new layer entity.
componentsToAddAn output list of components to add to the entity. Gathered this way to allow all components to be added at once, instead of deactivating and re-activating the layer for each listener on this bus adding components.

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