AzFramework::FileTag::QueryFileTagsEvent Class Reference

#include <FileTagBus.h>

Inherits AZ::EBusTraits.

Public Types
using	BusIdType = int
typedef AZStd::recursive_mutex	MutexType

Public Member Functions
virtual bool	Load (const AZStd::string &)=0
virtual bool	LoadEngineDependencies (const AZStd::string &filePath)=0
	! Load engine dependencies specified inside the *_dependencies.xml
virtual bool	Match (const AZStd::string &, AZStd::vector< AZStd::string >)=0
virtual AZStd::set< AZStd::string >	GetTags (const AZStd::string &)=0
	! Given a filepath, returns all of the tags that are on it.

Static Public Attributes
static const AZ::EBusAddressPolicy	AddressPolicy = AZ::EBusAddressPolicy::ById

Detailed Description

Event bus for querying file tags.

Member Function Documentation

Load()

virtual bool AzFramework::FileTag::QueryFileTagsEvent::Load ( const AZStd::string &  )

pure virtual

Loads the corresponding file for the tags type specified. filePath param is optional and if not specified than the app root path for the application will be searched for tags type file specified.

Match()

virtual bool AzFramework::FileTag::QueryFileTagsEvent::Match ( const AZStd::string &  , AZStd::vector< AZStd::string >    )

pure virtual

! Given a filepath and a list of file tags, return true if all of those tags are on it, otherwise return false. Please note that we will be doing a case insensitive match and therefore we are taking fileTags param by value.

---

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

• Code/Framework/AzFramework/AzFramework/FileTag/FileTagBus.h