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.
Public Member Functions | List of all members
UiSpawnerNotifications Class Reference

#include <UiSpawnerBus.h>

Inherits AZ::ComponentBus.

Public Member Functions

virtual void OnSpawnBegin (const AzFramework::SliceInstantiationTicket &)
 
virtual void OnEntitySpawned (const AzFramework::SliceInstantiationTicket &, const AZ::EntityId &)
 Notify that an entity has spawned, will be called once for each entity spawned in a slice.
 
virtual void OnEntitiesSpawned (const AzFramework::SliceInstantiationTicket &, const AZStd::vector< AZ::EntityId > &)
 Single event notification for an entire slice spawn, providing a list of all resulting entity Ids.
 
virtual void OnTopLevelEntitiesSpawned (const AzFramework::SliceInstantiationTicket &, const AZStd::vector< AZ::EntityId > &)
 
virtual void OnSpawnEnd (const AzFramework::SliceInstantiationTicket &)
 Notify that a spawn has been completed. All spawn notifications for this ticket have been dispatched.
 
virtual void OnSpawnFailed (const AzFramework::SliceInstantiationTicket &)
 Notify that slice has failed to be spawned.
 

Detailed Description

Bus for notifications dispatched by the UiSpawnerComponent Whenever one of the "Spawn" calls in UiSpawnerInterface is called then a listener connected on this bus with the spawner entity ID will either get:

  1. This sequence of notifications: OnSpawnBegin N x OnEntitySpawned OnEntitiesSpawned OnTopLevelEntitiesSpawned OnSpawnEnd
  2. In the case of a spawn error just this notification: OnSpawnFailed

Member Function Documentation

◆ OnSpawnBegin()

virtual void UiSpawnerNotifications::OnSpawnBegin ( const AzFramework::SliceInstantiationTicket &  )
inlinevirtual

Notify that slice has been spawned, but entities have not yet been activated. OnEntitySpawned events are about to be dispatched.

◆ OnTopLevelEntitiesSpawned()

virtual void UiSpawnerNotifications::OnTopLevelEntitiesSpawned ( const AzFramework::SliceInstantiationTicket &  ,
const AZStd::vector< AZ::EntityId > &   
)
inlinevirtual

Single event notification for an entire slice spawn, providing a list of all resulting top-level entity Ids. Top-level entities are ones that are not the child of any other entity in the slice

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