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 | Static Public Member Functions | Public Attributes | List of all members
LmbrCentral::SpawnerComponent Class Reference

#include <SpawnerComponent.h>

Inherits AZ::Component, SpawnerComponentRequestBus::Handler, AzFramework::SliceInstantiationResultBus::MultiHandler, AZ::EntityBus::MultiHandler, and AZ::Data::AssetBus::Handler.

Public Member Functions

 AZ_COMPONENT (SpawnerComponent, SpawnerComponentTypeId)
 
 SpawnerComponent (const AZ::Data::Asset< AZ::DynamicSliceAsset > &sliceAsset, bool spawnOnActivate)
 
void Activate () override
 
void Deactivate () override
 
bool ReadInConfig (const AZ::ComponentConfig *spawnerConfig) override
 
bool WriteOutConfig (AZ::ComponentConfig *outSpawnerConfig) const override
 
void SetDynamicSlice (const AZ::Data::Asset< AZ::DynamicSliceAsset > &dynamicSliceAsset) override
 
void SetDynamicSliceByAssetId (AZ::Data::AssetId &assetId) override
 
void SetSpawnOnActivate (bool spawnOnActivate) override
 
bool GetSpawnOnActivate () override
 
AzFramework::SliceInstantiationTicket Spawn () override
 
AzFramework::SliceInstantiationTicket SpawnRelative (const AZ::Transform &relative) override
 
AzFramework::SliceInstantiationTicket SpawnAbsolute (const AZ::Transform &world) override
 
AzFramework::SliceInstantiationTicket SpawnSlice (const AZ::Data::Asset< AZ::Data::AssetData > &slice) override
 
AzFramework::SliceInstantiationTicket SpawnSliceRelative (const AZ::Data::Asset< AZ::Data::AssetData > &slice, const AZ::Transform &relative) override
 
AzFramework::SliceInstantiationTicket SpawnSliceAbsolute (const AZ::Data::Asset< AZ::Data::AssetData > &slice, const AZ::Transform &world) override
 
void DestroySpawnedSlice (const AzFramework::SliceInstantiationTicket &ticket) override
 
void DestroyAllSpawnedSlices () override
 
AZStd::vector< AzFramework::SliceInstantiationTicket > GetCurrentlySpawnedSlices () override
 
bool HasAnyCurrentlySpawnedSlices () override
 
AZStd::vector< AZ::EntityId > GetCurrentEntitiesFromSpawnedSlice (const AzFramework::SliceInstantiationTicket &ticket) override
 
AZStd::vector< AZ::EntityId > GetAllCurrentlySpawnedEntities () override
 
bool IsReadyToSpawn () override
 
void OnSlicePreInstantiate (const AZ::Data::AssetId &sliceAssetId, const AZ::SliceComponent::SliceInstanceAddress &sliceAddress) override
 
void OnSliceInstantiated (const AZ::Data::AssetId &sliceAssetId, const AZ::SliceComponent::SliceInstanceAddress &sliceAddress) override
 
void OnSliceInstantiationFailedOrCanceled (const AZ::Data::AssetId &sliceAssetId, bool canceled) override
 
void OnEntityDestruction (const AZ::EntityId &entityId) override
 
void OnAssetReady (AZ::Data::Asset< AZ::Data::AssetData > asset) override
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 
static void GetRequiredServices (AZ::ComponentDescriptor::DependencyArrayType &required)
 
static void GetDependentServices (AZ::ComponentDescriptor::DependencyArrayType &dependent)
 
static void GetProvidedServices (AZ::ComponentDescriptor::DependencyArrayType &provided)
 

Public Attributes

AZ::Data::Asset< AZ::DynamicSliceAsset > m_sliceAsset
 
bool m_spawnOnActivate = false
 
bool m_destroyOnDeactivate = false
 

Detailed Description

SpawnerComponent

SpawnerComponent facilitates spawning of a design-time selected or run-time provided "*.dynamicslice" at an entity's location with an optional offset.

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