FARFilter Struct Reference

#include <ARFilter.h>

Public Member Functions
PRAGMA_DISABLE_DEPRECATION_WARNINGS	FARFilter ()=default
	FARFilter (FARFilter &&)=default
	FARFilter (const FARFilter &)=default
FARFilter &	operator= (FARFilter &&)=default
FARFilter &	operator= (const FARFilter &)=default
void	Append (const FARFilter &Other)
bool	IsEmpty () const
bool	IsRecursive () const
void	Clear ()
void	PostSerialize (const FArchive &Ar)
COREUOBJECT_API void	SortForSaving ()
COREUOBJECT_API bool	operator== (const FARFilter &Other) const
COREUOBJECT_API bool	operator< (const FARFilter &Other) const

Public Attributes
PRAGMA_ENABLE_DEPRECATION_WARNINGS TArray< FName >	PackageNames
TArray< FName >	PackagePaths
TArray< FSoftObjectPath >	SoftObjectPaths
TArray< FName >	ClassNames
TArray< FTopLevelAssetPath >	ClassPaths
TMultiMap< FName, TOptional< FString > >	TagsAndValues
TSet< FName >	RecursiveClassesExclusionSet
TSet< FTopLevelAssetPath >	RecursiveClassPathsExclusionSet
bool	bRecursivePaths = false
bool	bRecursiveClasses = false
bool	bIncludeOnlyOnDiskAssets = false
uint32	WithoutPackageFlags = 0
uint32	WithPackageFlags = 0

Friends
FCbWriter &	operator<< (FCbWriter &Writer, const FARFilter &Filter)
bool	LoadFromCompactBinary (const FCbFieldView &Field, FARFilter &Filter)

Detailed Description

A struct to serve as a filter for Asset Registry queries. Each component element is processed as an 'OR' operation while all the components are processed together as an 'AND' operation. This type is mirrored in NoExportTypes.h

Constructor & Destructor Documentation

FARFilter() [1/3]

PRAGMA_DISABLE_DEPRECATION_WARNINGS FARFilter::FARFilter ( )

default

FARFilter() [2/3]

FARFilter::FARFilter ( FARFilter &&  )

default

FARFilter() [3/3]

FARFilter::FARFilter ( const FARFilter &  )

default

Member Function Documentation

Append()

void FARFilter::Append ( const FARFilter &  Other )

inline

Appends the other filter to this one

Clear()

void FARFilter::Clear ( )

inline

Clears this filter of all entries

IsEmpty()

bool FARFilter::IsEmpty ( ) const

inline

Returns true if this filter has no entries

IsRecursive()

bool FARFilter::IsRecursive ( ) const

inline

Returns true if this filter is recursive

operator<()

bool FARFilter::operator<

(

const FARFilter &

Other

)

const

operator=() [1/2]

FARFilter & FARFilter::operator= ( const FARFilter &  )

default

operator=() [2/2]

FARFilter & FARFilter::operator= ( FARFilter &&  )

default

operator==()

bool FARFilter::operator==

(

const FARFilter &

Other

)

const

PostSerialize()

void FARFilter::PostSerialize

(

const FArchive &

Ar

)

SortForSaving()

void FARFilter::SortForSaving

(

)

Sort the structures (e.g. PackageNames) on this filter to be deterministic for saving the structure during cooking. This is also required for correctness of operator== when comparing the order-independent arrays.

Friends And Related Symbol Documentation

LoadFromCompactBinary

bool LoadFromCompactBinary ( const FCbFieldView &  Field, FARFilter &  Filter  )

friend

operator<<

FCbWriter & operator<< ( FCbWriter &  Writer, const FARFilter &  Filter  )

friend

Member Data Documentation

bIncludeOnlyOnDiskAssets

bool FARFilter::bIncludeOnlyOnDiskAssets = false

If true, use only DiskGatheredData, do not calculate from UObjects.

See also

IAssetRegistry class header for bIncludeOnlyOnDiskAssets.

bRecursiveClasses

bool FARFilter::bRecursiveClasses = false

If true, subclasses of ClassPaths will also be included and RecursiveClassPathsExclusionSet will be excluded.

bRecursivePaths

bool FARFilter::bRecursivePaths = false

If true, PackagePath components will be recursive

ClassNames

TArray<FName> FARFilter::ClassNames

Deprecated. The filter component for class names. Instances of the specified classes, but not subclasses (by default), will be included. Derived classes will be included only if bRecursiveClasses is true.

ClassPaths

TArray<FTopLevelAssetPath> FARFilter::ClassPaths

The filter component for class path names. Instances of the specified classes, but not subclasses (by default), will be included. Derived classes will be included only if bRecursiveClasses is true.

PackageNames

PRAGMA_ENABLE_DEPRECATION_WARNINGS TArray<FName> FARFilter::PackageNames

The filter component for package names

PackagePaths

TArray<FName> FARFilter::PackagePaths

The filter component for package paths

RecursiveClassesExclusionSet

TSet<FName> FARFilter::RecursiveClassesExclusionSet

Deprecated. Only if bRecursiveClasses is true, the results will exclude classes (and subclasses) in this list

RecursiveClassPathsExclusionSet

TSet<FTopLevelAssetPath> FARFilter::RecursiveClassPathsExclusionSet

Only if bRecursiveClasses is true, the results will exclude classes (and subclasses) in this list

SoftObjectPaths

TArray<FSoftObjectPath> FARFilter::SoftObjectPaths

The filter component containing the paths of specific assets to match. Matches against FAssetData::ToSoftObjectPath(). This is a top level asset path for most assets and a subobject path for assets such as world partition external actors.

TagsAndValues

TMultiMap<FName, TOptional<FString> > FARFilter::TagsAndValues

The filter component for properties marked with the AssetRegistrySearchable flag

WithoutPackageFlags

uint32 FARFilter::WithoutPackageFlags = 0

The exclusive filter component for package flags. Only assets without any of the specified flags will be returned.

WithPackageFlags

uint32 FARFilter::WithPackageFlags = 0

The inclusive filter component for package flags. Only assets with all of the specified flags will be returned.

---

The documentation for this struct was generated from the following files:

• Engine/Source/Runtime/CoreUObject/Public/AssetRegistry/ARFilter.h
• Engine/Source/Runtime/CoreUObject/Private/AssetRegistry/ARFilter.cpp
• Engine/Source/Runtime/CoreUObject/Private/AssetRegistry/AssetData.cpp