Menu
Lumberyard
C++ API Reference (Version 1.10)

AzFramework::SliceInstantiationResults Class Reference

Open 3D Engine (O3DE), the successor to Lumberyard, is now available in Developer Preview. Download O3DE or visit the AWS Game Tech blog to learn more.

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

Inherits AZ::EBusTraits .

Public Types

typedef BusIdType
Specifies that events are addressed by the request ID of the slice instantiation ticket. More...
- Public Types inherited from AZ::EBusTraits
using AllocatorType
Allocator used by the EBus . More...
using BusIdType
The type of ID that is used to address the EBus . More...
using BusIdOrderCompare
Sorting function for EBus address IDs. More...
using BusHandlerOrderCompare
Sorting function for EBus event handlers. More...
using MutexType
Locking primitive that is used when connecting handlers to the EBus or executing events. More...
using EventQueueMutexType
Locking primitive that is used when adding and removing events from the queue. More...
using ConnectionPolicy
Enables custom logic to run when a handler connects or disconnects from the EBus . More...
using StoragePolicy
Specifies where EBus data is stored. More...
using RouterPolicy
Controls the flow of EBus events. More...

Public Member Functions

virtual ~SliceInstantiationResults ()=default
Destroys the instance of the class. More...
virtual void OnSlicePreInstantiate (const AZ::Data::AssetId &, const AZ::SliceComponent::SliceInstanceAddress &)
Signals that a slice was successfully instantiated prior to entity registration. More...
virtual void OnSliceInstantiated (const AZ::Data::AssetId &, const AZ::SliceComponent::SliceInstanceAddress &)
Signals that a slice was successfully instantiated after entity registration. More...
virtual void OnSliceInstantiationFailed (const AZ::Data::AssetId &)
Signals that a slice could not be instantiated. More...

Static Public Attributes

static const AZ::EBusAddressPolicy AddressPolicy
Overrides the default AZ::EBusAddressPolicy to specify that the EBus has multiple addresses. More...
- Static Public Attributes inherited from AZ::EBusTraits
static const EBusHandlerPolicy HandlerPolicy
Defines how many handlers can connect to an address on the EBus and the order in which handlers at each address receive events. More...
static const EBusAddressPolicy AddressPolicy
Defines how many addresses exist on the EBus . More...
static const bool EnableEventQueue
Specifies whether the EBus supports an event queue. More...

Additional Inherited Members

- Protected Member Functions inherited from AZ::EBusTraits
~EBusTraits ()=default
A destructor. More...

Detailed Description

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

Member Typedef Documentation

BusIdType

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

Constructor & Destructor Documentation

~SliceInstantiationResults()

virtual AzFramework::SliceInstantiationResults::~SliceInstantiationResults ( )
virtual default

Destroys the instance of the class.

Member Function Documentation

OnSliceInstantiated()

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

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 & )
inline virtual

Signals that a slice could not be instantiated.

Parameters
sliceAssetId A reference to the slice asset ID.

OnSlicePreInstantiate()

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

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
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: