Open 3D Engine AzToolsFramework 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 | Static Public Attributes | List of all members
AzToolsFramework::AssetBundleComponent Class Reference

Inherits AZ::Component, and AssetBundleCommands::Bus::Handler.

Public Member Functions

void Activate () override
 
void Deactivate () override
 

Static Public Member Functions

static bool HasManifest (const AZStd::vector< AZStd::string > &fileEntries)
 Returns true if the given list of entries contains an Asset Bundle Manifest.
 
static AzFramework::AssetBundleManifest * GetManifestFromBundle (const AZStd::string &sourcePak)
 
static bool InjectFile (const AZStd::string &filePath, const AZStd::string &sourcePak)
 
static bool InjectFile (const AZStd::string &filePath, const AZStd::string &sourcePak, const char *workingDirectory)
 
static bool InjectFiles (const AZStd::vector< AZStd::string > &fileEntries, const AZStd::string &sourcePak, const char *workingDirectory)
 
static bool RemoveNonAssetFileEntries (AZStd::vector< AZStd::string > &fileEntries, const AZStd::string &normalizedSourcePakPath, const AzFramework::AssetBundleManifest *manifest)
 

Static Public Attributes

static const char DeltaCatalogName []
 

Member Function Documentation

◆ GetManifestFromBundle()

static AzFramework::AssetBundleManifest * AzToolsFramework::AssetBundleComponent::GetManifestFromBundle ( const AZStd::string &  sourcePak)
static

Extracts and deserializes an Asset Bundle manifest from the given bundle Returns the deserialized Asset Bundle Manifest

◆ InjectFile() [1/2]

static bool AzToolsFramework::AssetBundleComponent::InjectFile ( const AZStd::string &  filePath,
const AZStd::string &  sourcePak 
)
static

Inject the file at filePath into the bundle at sourcePak Returns true if the file at filePath was successfully injected into the bundle at sourcePak

◆ InjectFile() [2/2]

static bool AzToolsFramework::AssetBundleComponent::InjectFile ( const AZStd::string &  filePath,
const AZStd::string &  sourcePak,
const char *  workingDirectory 
)
static

Inject the file with relative filePath with respect to the working directory into the bundle at sourcePak Returns true if the file at filePath was successfully injected into the bundle at sourcePak

◆ InjectFiles()

static bool AzToolsFramework::AssetBundleComponent::InjectFiles ( const AZStd::vector< AZStd::string > &  fileEntries,
const AZStd::string &  sourcePak,
const char *  workingDirectory 
)
static

Inject the files with relative filePaths with respect to the working directory into the bundle at sourcePak Returns true if the file at filePath was successfully injected into the bundle at sourcePak

◆ RemoveNonAssetFileEntries()

static bool AzToolsFramework::AssetBundleComponent::RemoveNonAssetFileEntries ( AZStd::vector< AZStd::string > &  fileEntries,
const AZStd::string &  normalizedSourcePakPath,
const AzFramework::AssetBundleManifest *  manifest 
)
static

Removes any known non-asset entries from a list of files that exist in a bundle. Currently removes entries such as a Delta Asset Catalog if one exists, and the bundle itself. If a manifest exists within the bundle, we remove the manifest and the catalog it references. Returns whether all known non-asset entries were removed from the list

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