AzFramework::SliceInstantiationResults Class Reference

#include <SliceInstantiationBus.h>

Inherits AZ::EBusTraits.

Public Types
using	BusIdType = SliceInstantiationTicket

Public Member Functions
virtual	~SliceInstantiationResults ()=default
virtual void	OnSlicePreInstantiate (const AZ::Data::AssetId &, const AZ::SliceComponent::SliceInstanceAddress &)
virtual void	OnSliceInstantiated (const AZ::Data::AssetId &, const AZ::SliceComponent::SliceInstanceAddress &)
virtual void	OnSliceInstantiationFailed (const AZ::Data::AssetId &)
virtual void	OnSliceInstantiationFailedOrCanceled (const AZ::Data::AssetId &, bool)

Static Public Attributes
static const AZ::EBusAddressPolicy	AddressPolicy = AZ::EBusAddressPolicy::ById

Detailed Description

Interface for AzFramework::SliceInstantiationResultBus, which enables you to receive results regarding your slice instantiation requests.

Member Typedef Documentation

BusIdType

using AzFramework::SliceInstantiationResults::BusIdType = SliceInstantiationTicket

Specifies that events are addressed by the request ID of the slice instantiation ticket.

Constructor & Destructor Documentation

~SliceInstantiationResults()

virtual AzFramework::SliceInstantiationResults::~SliceInstantiationResults ( )

virtualdefault

Destroys the instance of the class.

Member Function Documentation

OnSliceInstantiated()

virtual void AzFramework::SliceInstantiationResults::OnSliceInstantiated ( const AZ::Data::AssetId &  , const AZ::SliceComponent::SliceInstanceAddress &    )

inlinevirtual

Signals that a slice was successfully instantiated after entity registration.

Parameters

sliceAssetId	A reference to the slice asset ID.
sliceAddress	A reference to the slice instance address.

OnSliceInstantiationFailed()

virtual void AzFramework::SliceInstantiationResults::OnSliceInstantiationFailed ( const AZ::Data::AssetId &  )

inlinevirtual

Signals that a slice could not be instantiated.

Deprecated:

Please use OnSliceInstantiationFailedOrCanceled

Parameters

sliceAssetId

A reference to the slice asset ID.

OnSliceInstantiationFailedOrCanceled()

virtual void AzFramework::SliceInstantiationResults::OnSliceInstantiationFailedOrCanceled ( const AZ::Data::AssetId &  , bool    )

inlinevirtual

Signals that a slice could not be instantiated.

Parameters

sliceAssetId	A reference to the slice asset ID.
canceled	Set to true if the failure was due to cancellation.

OnSlicePreInstantiate()

virtual void AzFramework::SliceInstantiationResults::OnSlicePreInstantiate ( const AZ::Data::AssetId &  , const AZ::SliceComponent::SliceInstanceAddress &    )

inlinevirtual

Signals that a slice was successfully instantiated prior to entity registration.

Parameters

sliceAssetId	A reference to the slice asset ID.
sliceAddress	A reference to the slice instance address.

Member Data Documentation

AddressPolicy

const AZ::EBusAddressPolicy AzFramework::SliceInstantiationResults::AddressPolicy = AZ::EBusAddressPolicy::ById

static

Overrides the default AZ::EBusAddressPolicy to specify that the EBus has multiple addresses. Components that request slice instantiation receive the results of the request at the EBus address that is associated with the request ID of the slice instantiation ticket.

---

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

• Code/Framework/AzFramework/AzFramework/Slice/SliceInstantiationBus.h