Open 3D Engine AzFramework 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 Attributes | List of all members
AzFramework::SliceGameEntityOwnershipServiceRequests Class Referenceabstract

Inherits AZ::EBusTraits.

Public Member Functions

virtual SliceInstantiationTicket InstantiateDynamicSlice (const AZ::Data::Asset< AZ::Data::AssetData > &, const AZ::Transform &, const AZ::IdUtils::Remapper< AZ::EntityId >::IdMapper &)=0
 
virtual void CancelDynamicSliceInstantiation (const SliceInstantiationTicket &)=0
 
virtual bool DestroyDynamicSliceByEntity (const AZ::EntityId &)=0
 

Static Public Attributes

static const AZ::EBusHandlerPolicy HandlerPolicy = AZ::EBusHandlerPolicy::Single
 

Member Function Documentation

◆ CancelDynamicSliceInstantiation()

virtual void AzFramework::SliceGameEntityOwnershipServiceRequests::CancelDynamicSliceInstantiation ( const SliceInstantiationTicket &  )
pure virtual

Cancels the asynchronous instantiation of a dynamic slice. This call has no effect if the slice has already finished instantiation.

Parameters
ticketThe ticket that identifies the slice instantiation request.

◆ DestroyDynamicSliceByEntity()

virtual bool AzFramework::SliceGameEntityOwnershipServiceRequests::DestroyDynamicSliceByEntity ( const AZ::EntityId &  )
pure virtual

Destroys an entire dynamic slice instance given the ID of any entity within the slice.

Parameters
idThe ID of the entity whose dynamic slice instance you want to destroy.
Returns
True if the dynamic slice instance was successfully destroyed. Otherwise, false.

◆ InstantiateDynamicSlice()

virtual SliceInstantiationTicket AzFramework::SliceGameEntityOwnershipServiceRequests::InstantiateDynamicSlice ( const AZ::Data::Asset< AZ::Data::AssetData > &  ,
const AZ::Transform &  ,
const AZ::IdUtils::Remapper< AZ::EntityId >::IdMapper &   
)
pure virtual

Instantiates a dynamic slice asynchronously.

Parameters
sliceAssetA reference to the slice asset data.
worldTransformA reference to the world transform to apply to the slice.
customIdMapperAn ID mapping function that is used when instantiating the slice.
Returns
A ticket that identifies the slice instantiation request. Callers can immediately subscribe to the AzFramework::SliceInstantiationResultBus for this ticket to receive results for this request.
The documentation for this class was generated from the following file: