Open 3D Engine LmbrCentral Gem API Reference  24.09
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::SpawnerComponentRequests Class Referenceabstract

#include <SpawnerComponentBus.h>

Inherits AZ::ComponentBus.

Public Member Functions

virtual void SetDynamicSlice (const AZ::Data::Asset< AZ::DynamicSliceAsset > &dynamicSliceAsset)=0
 Set the dynamic slice.
 
virtual void SetDynamicSliceByAssetId (AZ::Data::AssetId &assetId)=0
 
virtual void SetSpawnOnActivate (bool spawnOnActivate)=0
 Sets the SpawnOnActivate parameter.
 
virtual bool GetSpawnOnActivate ()=0
 Gets the value of the SpawnOnActivate parameter.
 
virtual AzFramework::SliceInstantiationTicket Spawn ()=0
 Spawn the selected slice at the entity's location.
 
virtual AzFramework::SliceInstantiationTicket SpawnRelative (const AZ::Transform &relative)=0
 Spawn the selected slice at the entity's location with the provided relative offset.
 
virtual AzFramework::SliceInstantiationTicket SpawnAbsolute (const AZ::Transform &world)=0
 Spawn the selected slice at the specified world transform.
 
virtual AzFramework::SliceInstantiationTicket SpawnSlice (const AZ::Data::Asset< AZ::Data::AssetData > &slice)=0
 Spawn the provided slice at the entity's location.
 
virtual AzFramework::SliceInstantiationTicket SpawnSliceRelative (const AZ::Data::Asset< AZ::Data::AssetData > &slice, const AZ::Transform &relative)=0
 Spawn the provided slice at the entity's location with the provided relative offset.
 
virtual AzFramework::SliceInstantiationTicket SpawnSliceAbsolute (const AZ::Data::Asset< AZ::Data::AssetData > &slice, const AZ::Transform &world)=0
 Spawn the provided slice at the specified world transform.
 
virtual void DestroySpawnedSlice (const AzFramework::SliceInstantiationTicket &ticket)=0
 
virtual void DestroyAllSpawnedSlices ()=0
 
virtual AZStd::vector< AzFramework::SliceInstantiationTicket > GetCurrentlySpawnedSlices ()=0
 
virtual bool HasAnyCurrentlySpawnedSlices ()=0
 
virtual AZStd::vector< AZ::EntityId > GetCurrentEntitiesFromSpawnedSlice (const AzFramework::SliceInstantiationTicket &ticket)=0
 
virtual AZStd::vector< AZ::EntityId > GetAllCurrentlySpawnedEntities ()=0
 
virtual bool IsReadyToSpawn ()=0
 Returns whether or not the spawner is in a state that's ready to spawn.
 

Detailed Description

SpawnerComponentRequests Messages serviced by the SpawnerComponent.

Member Function Documentation

◆ DestroyAllSpawnedSlices()

virtual void LmbrCentral::SpawnerComponentRequests::DestroyAllSpawnedSlices ( )
pure virtual

Destroy all entities that have been spawned by this component Any slices that haven't finished spawning are cancelled.

◆ DestroySpawnedSlice()

virtual void LmbrCentral::SpawnerComponentRequests::DestroySpawnedSlice ( const AzFramework::SliceInstantiationTicket &  ticket)
pure virtual

Destroy all entities from a spawned slice. If the slice hasn't finished spawning, it is cancelled. This component can only destroy slices that it spawned.

◆ GetAllCurrentlySpawnedEntities()

virtual AZStd::vector<AZ::EntityId> LmbrCentral::SpawnerComponentRequests::GetAllCurrentlySpawnedEntities ( )
pure virtual

Returns the IDs of all existing entities spawned by this component. Note that spawning is not instant, if a slice hasn't finished spawning then none of its entities are returned. If an entity has been destroyed since it was spawned, its ID is not returned.

◆ GetCurrentEntitiesFromSpawnedSlice()

virtual AZStd::vector<AZ::EntityId> LmbrCentral::SpawnerComponentRequests::GetCurrentEntitiesFromSpawnedSlice ( const AzFramework::SliceInstantiationTicket &  ticket)
pure virtual

Returns the IDs of current entities from a spawned slice. Note that spawning is not instant, if the slice hasn't finished spawning then no entities are returned. If an entity has been destroyed since it was spawned, its ID is not returned. Only slices spawned by this component can be queried.

◆ GetCurrentlySpawnedSlices()

virtual AZStd::vector<AzFramework::SliceInstantiationTicket> LmbrCentral::SpawnerComponentRequests::GetCurrentlySpawnedSlices ( )
pure virtual

Returns tickets for spawned slices that haven't been destroyed yet. A slice is considered destroyed once all its entities are destroyed. Includes tickets for slices that haven't finished spawning yet. Only slices spawned by this component are returned.

◆ HasAnyCurrentlySpawnedSlices()

virtual bool LmbrCentral::SpawnerComponentRequests::HasAnyCurrentlySpawnedSlices ( )
pure virtual

Returns whether this component has spawned any slices that haven't been destroyed. A slice is considered destroyed once all its entities are destroyed. Returns true if any slices haven't finished spawning yet.

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