Open 3D Engine LmbrCentral 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
LmbrCentral::SpawnerComponentNotifications Class Reference

#include <SpawnerComponentBus.h>

Inherits AZ::ComponentBus.

Public Member Functions

virtual void OnSpawnBegin (const AzFramework::SliceInstantiationTicket &)
 
virtual void OnSpawnEnd (const AzFramework::SliceInstantiationTicket &)
 Notify that a spawn has been completed. All OnEntitySpawned events have been dispatched.
 
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 OnSpawnedSliceDestroyed (const AzFramework::SliceInstantiationTicket &)
 

Detailed Description

SpawnerComponentNotificationBus Events dispatched by the SpawnerComponent

Member Function Documentation

◆ OnSpawnBegin()

virtual void LmbrCentral::SpawnerComponentNotifications::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.

◆ OnSpawnedSliceDestroyed()

virtual void LmbrCentral::SpawnerComponentNotifications::OnSpawnedSliceDestroyed ( const AzFramework::SliceInstantiationTicket &  )
inlinevirtual

Notify of a spawned slice's destruction. This occurs when all entities from a spawn are destroyed, or the slice fails to spawn.

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