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.
AzFramework::StreamingInstall::StreamingInstallRequests Class Referenceabstract

Inherits AZ::EBusTraits.

Public Member Functions

virtual void BroadcastOverallProgress ()=0
 Override will use platform API to request reports on package install progress changes.
 
virtual void BroadcastChunkProgress (const char *chunkId)=0
 
virtual void ChangeChunkPriority (const AZStd::vector< const char * > &chunkIds)=0
 
virtual void IsChunkInstalled (const char *chunkId)=0
 

Static Public Attributes

static const AZ::EBusHandlerPolicy HandlerPolicy = AZ::EBusHandlerPolicy::Single
 EBus Trait: requests can only be sent to and addressed by a single instance.
 
static const AZ::EBusAddressPolicy AddressPolicy = AZ::EBusAddressPolicy::Single
 

Member Function Documentation

◆ BroadcastChunkProgress()

virtual void AzFramework::StreamingInstall::StreamingInstallRequests::BroadcastChunkProgress ( const char *  chunkId)
pure virtual

Override will use platform API to request reports on chunk install progress changes.

Parameters
[in]thechunk ID to monitor

◆ ChangeChunkPriority()

virtual void AzFramework::StreamingInstall::StreamingInstallRequests::ChangeChunkPriority ( const AZStd::vector< const char * > &  chunkIds)
pure virtual

Override will use platform API to request a change to chunk install order. Chunks will install in the order they appear in the vector from front to back

Parameters
[in]avector of chunk IDs in the desired new install order.

◆ IsChunkInstalled()

virtual void AzFramework::StreamingInstall::StreamingInstallRequests::IsChunkInstalled ( const char *  chunkId)
pure virtual

Override will use platform API to query if a chunk is installed.

Parameters
[in]Idof the chunk to query.

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