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 Member Functions | List of all members
AzFramework::AssetSystem::AssetSystemComponent Class Reference

#include <AssetSystemComponent.h>

Inherits AZ::Component, AssetSystemRequestBus::Handler, and AZ::SystemTickBus::Handler.

Public Member Functions

void Init () override
 
void Activate () override
 
void Deactivate () override
 
void OnSystemTick () override
 
bool EstablishAssetProcessorConnection (const ConnectionSettings &connectionSettings) override
 
bool WaitUntilAssetProcessorConnected (AZStd::chrono::duration< float > timeout) override
 
bool WaitUntilAssetProcessorReady (AZStd::chrono::duration< float > timeout) override
 
bool AssetProcessorIsReady () override
 
bool ConnectedWithAssetProcessor () override
 
bool NegotiationWithAssetProcessorFailed () override
 
void StartDisconnectingAssetProcessor () override
 
bool DisconnectedWithAssetProcessor () override
 
bool WaitUntilAssetProcessorDisconnected (AZStd::chrono::duration< float > timeout) override
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 
static void GetProvidedServices (AZ::ComponentDescriptor::DependencyArrayType &provided)
 
static void GetIncompatibleServices (AZ::ComponentDescriptor::DependencyArrayType &incompatible)
 

Detailed Description

A game level component for interacting with the asset processor

Currently used to request synchronous asset compilation, provide notifications when assets are updated, and to query asset status

Member Function Documentation

◆ EstablishAssetProcessorConnection()

bool AzFramework::AssetSystem::AssetSystemComponent::EstablishAssetProcessorConnection ( const ConnectionSettings &  connectionSettings)
override

Uses the ConnectionsSettings ConnectionDirection field to determine whether to connect to an AssetProcessor instance or to listen for a connection

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