Open 3D Engine AssetValidation Gem API Reference  24.09
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
AssetValidation::AssetValidationRequests Class Reference

Inherits AZ::EBusTraits.

Public Types

using AssetSourceList = AZStd::vector< AZStd::pair< AZ::Data::AssetId, AZ::u32 > >
 

Public Member Functions

virtual void SeedMode ()
 Request to toggle Seed Mode.
 
virtual bool IsKnownAsset (const char *)
 Given an asset fileName does it exist in our dependency graph beneath any of our declared seed assetIds.
 
virtual bool CheckKnownAsset (const char *)
 When Seed Mode is on, given an asset fileName does it exist in our dependency graph - if so emit missing seed notification.
 
virtual bool AddSeedAssetId (AZ::Data::AssetId, AZ::u32)
 
virtual bool RemoveSeedAssetId (AZ::Data::AssetId, AZ::u32)
 Could come from multiple sources so we need to be able to track multiple copies to avoid cleanup errors.
 
virtual bool RemoveSeedAssetIdList (AssetSourceList)
 Request to add a seed file to be tracked by file path.
 
virtual bool AddSeedPath ([[maybe_unused]] const char *fileName)
 Request to add a seed to tracking by a relative path under the /dev folder.
 
virtual bool RemoveSeedPath ([[maybe_unused]] const char *fileName)
 Request to Remove a Seed from tracking by relative path under the /dev folder.
 
virtual bool IsSeedMode ()
 Check current status of seed mode.
 
virtual void ListKnownAssets ()
 List all known current assetIds and paths.
 
virtual bool AddSeedList ([[maybe_unused]] const char *filePath)
 Add all seeds from a seed file at a specified path.
 
virtual bool RemoveSeedList ([[maybe_unused]] const char *filePath)
 Remove all seeds from a seed file at a specified path.
 
virtual void TogglePrintExcluded ()
 Toggle exclude printing.
 

Static Public Attributes

static const AZ::EBusHandlerPolicy HandlerPolicy = AZ::EBusHandlerPolicy::Single
 
static const AZ::EBusAddressPolicy AddressPolicy = AZ::EBusAddressPolicy::Single
 

Member Function Documentation

◆ AddSeedAssetId()

virtual bool AssetValidation::AssetValidationRequests::AddSeedAssetId ( AZ::Data::AssetId  ,
AZ::u32   
)
inlinevirtual

Add a new seed assetId to the graph. sourceID is used for deterministic add/removal - the same seed assetId Could come from multiple sources so we need to be able to track multiple copies to avoid cleanup errors


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