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.
AzToolsFramework::AssetBundleSettings Class Reference

Public Member Functions

 AZ_TYPE_INFO (AssetBundleSettings, "{B9597C91-540E-41A9-9572-80A629061914}")
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 
static AZ::Outcome< AssetBundleSettings, AZStd::string > Load (const AZStd::string &filePath)
 Loads the AssetBundleSettings file from the file path.
 
static bool Save (const AssetBundleSettings &assetBundleFileInfo, const AZStd::string &destinationFilePath)
 
static bool IsBundleSettingsFile (const AZStd::string &filePath)
 
static const char * GetBundleSettingsFileExtension ()
 Returns the Bundle Settings file extension.
 
static AZ::Outcome< void, AZStd::string > ValidateBundleSettingsFileExtension (const AZStd::string &path)
 
static const char * GetBundleFileExtension ()
 Returns the Bundle file extension.
 
static AZ::Outcome< void, AZStd::string > ValidateBundleFileExtension (const AZStd::string &path)
 
static AZ::u64 GetMaxBundleSizeInMB ()
 
static AZStd::string GetPlatformFromAssetInfoFilePath (const AssetBundleSettings &assetBundleSettings)
 

Public Attributes

AZStd::string m_platform
 
AZStd::string m_assetFileInfoListPath
 
AZStd::string m_bundleFilePath
 
int m_bundleVersion = AzFramework::AssetBundleManifest::CurrentBundleVersion
 
AZ::u64 m_maxBundleSizeInMB = MaxBundleSizeInMB
 
AZStd::string m_comment
 

Member Function Documentation

◆ ValidateBundleFileExtension()

static AZ::Outcome< void, AZStd::string > AzToolsFramework::AssetBundleSettings::ValidateBundleFileExtension ( const AZStd::string &  path)
static

Validates that the input path has the proper file extension for a Bundle. Input path can be relative or absolute. Returns void on success, error message on failure.

◆ ValidateBundleSettingsFileExtension()

static AZ::Outcome< void, AZStd::string > AzToolsFramework::AssetBundleSettings::ValidateBundleSettingsFileExtension ( const AZStd::string &  path)
static

Validates that the input path has the proper file extension for a Bundle Settings file. Input path can be relative or absolute. Returns void on success, error message on failure.


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