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 Attributes | List of all members
AzFramework::FileTag::FileTagsEvent Class Referenceabstract

#include <FileTagBus.h>

Inherits AZ::EBusTraits.

Public Member Functions

virtual bool Save (FileTagType, const AZStd::string &)=0
 
virtual AZ::Outcome< AZStd::string, AZStd::string > AddFileTags (const AZStd::string &, FileTagType, const AZStd::vector< AZStd::string > &)=0
 ! Add file tags based on a filepath.
 
virtual AZ::Outcome< AZStd::string, AZStd::string > RemoveFileTags (const AZStd::string &, FileTagType, const AZStd::vector< AZStd::string > &)=0
 ! Remove file tags based on a filepath.
 
virtual AZ::Outcome< AZStd::string, AZStd::string > AddFilePatternTags (const AZStd::string &, AzFramework::FileTag::FilePatternType, FileTagType, const AZStd::vector< AZStd::string > &)=0
 
virtual AZ::Outcome< AZStd::string, AZStd::string > RemoveFilePatternTags (const AZStd::string &, AzFramework::FileTag::FilePatternType, FileTagType, const AZStd::vector< AZStd::string > &)=0
 ! Remove tags based on filepattern.
 

Static Public Attributes

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

Detailed Description

Event bus for adding/removing file tags.

Member Function Documentation

◆ AddFilePatternTags()

virtual AZ::Outcome< AZStd::string, AZStd::string > AzFramework::FileTag::FileTagsEvent::AddFilePatternTags ( const AZStd::string &  ,
AzFramework::FileTag::FilePatternType  ,
FileTagType  ,
const AZStd::vector< AZStd::string > &   
)
pure virtual

! Add tags based on filepattern. Pattern can either be a wildcard or a regex.

◆ Save()

virtual bool AzFramework::FileTag::FileTagsEvent::Save ( FileTagType  ,
const AZStd::string &   
)
pure virtual

! Saves the corresponding fileTagType file to disk. destinationFilePath param is optional, the app root path for the application will be used as the destination directory, if it is not specified by the user.

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