FARCompiledFilter Struct Reference

#include <ARFilter.h>

Public Member Functions
PRAGMA_DISABLE_DEPRECATION_WARNINGS	FARCompiledFilter ()=default
	FARCompiledFilter (FARCompiledFilter &&)=default
	FARCompiledFilter (const FARCompiledFilter &)=default
FARCompiledFilter &	operator= (FARCompiledFilter &&)=default
FARCompiledFilter &	operator= (const FARCompiledFilter &)=default
bool	IsEmpty () const
void	Clear ()

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

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 is a version of FARFilter optimized for querying, and can be generated from an FARFilter by calling IAssetRegistry::CompileFilter to resolve any recursion.

Constructor & Destructor Documentation

FARCompiledFilter() [1/3]

PRAGMA_DISABLE_DEPRECATION_WARNINGS FARCompiledFilter::FARCompiledFilter ( )

default

FARCompiledFilter() [2/3]

FARCompiledFilter::FARCompiledFilter ( FARCompiledFilter &&  )

default

FARCompiledFilter() [3/3]

FARCompiledFilter::FARCompiledFilter ( const FARCompiledFilter &  )

default

Member Function Documentation

Clear()

void FARCompiledFilter::Clear ( )

inline

Clears this filter of all entries

IsEmpty()

bool FARCompiledFilter::IsEmpty ( ) const

inline

Returns true if this filter has no entries

operator=() [1/2]

FARCompiledFilter & FARCompiledFilter::operator= ( const FARCompiledFilter &  )

default

operator=() [2/2]

FARCompiledFilter & FARCompiledFilter::operator= ( FARCompiledFilter &&  )

default

Member Data Documentation

bIncludeOnlyOnDiskAssets

bool FARCompiledFilter::bIncludeOnlyOnDiskAssets = false

If true, only on-disk assets will be returned. Be warned that this is rarely what you want and should only be used for performance reasons

ClassNames

TSet<FName> FARCompiledFilter::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

TSet<FTopLevelAssetPath> FARCompiledFilter::ClassPaths

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.

ObjectPaths

TSet<FName> FARCompiledFilter::ObjectPaths

The filter component containing specific object paths

PackageNames

PRAGMA_ENABLE_DEPRECATION_WARNINGS TSet<FName> FARCompiledFilter::PackageNames

The filter component for package names

PackagePaths

TSet<FName> FARCompiledFilter::PackagePaths

The filter component for package paths

SoftObjectPaths

TSet<FSoftObjectPath> FARCompiledFilter::SoftObjectPaths

The filter component containing specific object paths

TagsAndValues

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

The filter component for properties marked with the AssetRegistrySearchable flag

WithoutPackageFlags

uint32 FARCompiledFilter::WithoutPackageFlags = 0

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

WithPackageFlags

uint32 FARCompiledFilter::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 file:

• Engine/Source/Runtime/CoreUObject/Public/AssetRegistry/ARFilter.h