Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > CoreUObject > AssetRegistry > FARFilter

Light Theme

Dark Theme

FARFilter

A struct to serve as a filter for Asset Registry queries.

Windows

MacOS

Linux

References

Module	CoreUObject
Header	/Engine/Source/Runtime/CoreUObject/Public/AssetRegistry/ARFilter.h
Include	#include "AssetRegistry/ARFilter.h"

Syntax

struct FARFilter

Remarks

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.

Variables

	Name	Description
bool	bIncludeOnlyOnDiskAssets	If true, only on-disk assets will be returned.
bool	bRecursiveClasses	If true, subclasses of ClassNames will also be included and RecursiveClassesExclusionSet will be excluded.
bool	bRecursivePaths	If true, PackagePath components will be recursive
TArray< FName >	ClassNames	The filter component for class names.
TArray< FName >	ObjectPaths	The filter component containing specific object paths
TArray< FName >	PackageNames	The filter component for package names
TArray< FName >	PackagePaths	The filter component for package paths
TSet< FName >	RecursiveClassesExclusionSet	Only if bRecursiveClasses is true, the results will exclude classes (and subclasses) in this list
TMultiMap< FNam...	TagsAndValues	The filter component for properties marked with the AssetRegistrySearchable flag
uint32	WithoutPackageFlags	The exclusive filter component for package flags.
uint32	WithPackageFlags	The inclusive filter component for package flags.

Functions

	Name	Description
void	Append ( const FARFilter& Other )	Appends the other filter to this one
void	Clear()	Clears this filter of all entries
bool	IsEmpty()	Returns true if this filter has no entries
bool	IsRecursive()	Returns true if this filter is recursive

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss