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 Types | Public Member Functions | Static Public Attributes | List of all members
AzFramework::StreamingInstall::StreamingInstallChunkNotifications Class Referenceabstract

Inherits AZ::EBusTraits.

Public Types

typedef AZStd::string BusIdType
 

Public Member Functions

virtual void OnChunkDownloadComplete (const AZStd::string &chunkId)=0
 
virtual void OnChunkProgressChanged (const AZStd::string &chunkId, float progress)=0
 
virtual void OnQueryChunkInstalled (const AZStd::string &chunkId, bool installed)=0
 

Static Public Attributes

static const AZ::EBusHandlerPolicy HandlerPolicy = AZ::EBusHandlerPolicy::Multiple
 EBus Trait: StreaimingInstall chunk notifications can be handled by multiple listeners.
 
static const AZ::EBusAddressPolicy AddressPolicy = AZ::EBusAddressPolicy::ById
 

Member Typedef Documentation

◆ BusIdType

typedef AZStd::string AzFramework::StreamingInstall::StreamingInstallChunkNotifications::BusIdType

EBus Trait: StreamingInstall chunk notifications are addressed to multiple addresses Events that are addressed to an ID are received by handlers that are connected to that ID

Member Function Documentation

◆ OnChunkDownloadComplete()

virtual void AzFramework::StreamingInstall::StreamingInstallChunkNotifications::OnChunkDownloadComplete ( const AZStd::string &  chunkId)
pure virtual

Override to be notified when a chunk has completed downloading. This is a responce from the RegisterChunkInstalledCallbacks event emitted from the platform implementation

Parameters
[in]theID for the chunk that has downloaded

◆ OnChunkProgressChanged()

virtual void AzFramework::StreamingInstall::StreamingInstallChunkNotifications::OnChunkProgressChanged ( const AZStd::string &  chunkId,
float  progress 
)
pure virtual

Override to be notified when a chunk's download progress has changed. This is a responce from the StreamingInstallRequests::BroadcastChunkProgress event

Parameters
[in]theID for the monitored chunk, the current download progress as a 0.0 to 1.0 value

◆ OnQueryChunkInstalled()

virtual void AzFramework::StreamingInstall::StreamingInstallChunkNotifications::OnQueryChunkInstalled ( const AZStd::string &  chunkId,
bool  installed 
)
pure virtual

Override to be notified if a chunk has been installed. This is a responce from the StreamingInstallRequests::IsChunkInstalled event

Parameters
[in]theID of the chunk to query, installed flag for the chunk (true if installed and false otherwise).
The documentation for this class was generated from the following file: