RealDocs

UKismetSystemLibrary::BreakARFilter

function Engine Blueprint Since unknown
#include "Kismet/KismetSystemLibrary.h"
Access: public Specifiers: staticBlueprintPure

Description

Splits an FARFilter struct into its individual component fields, the Blueprint inverse of MakeARFilter. Used to inspect or modify an existing filter node-by-node in a Blueprint graph.

Caveats & Gotchas

  • • ClassNames and RecursiveClassesExclusionSet outputs are deprecated; you should read ClassPaths and RecursiveClassPathsExclusionSet instead, since class names are now represented as full path names.
  • • AdvancedDisplay hides the last several output pins (from index 6 onward) by default in the Blueprint node, so the deprecated outputs and bIncludeOnlyOnDiskAssets are collapsed unless expanded manually.
  • • This is a pure node with ten output pins — wiring all of them for a filter you don't need to fully inspect adds unnecessary graph clutter; only break out the fields you actually use.

Signature

static void BreakARFilter(FARFilter InARFilter, TArray<FName>& PackageNames, TArray<FName>& PackagePaths, TArray<FSoftObjectPath>& SoftObjectPaths, TArray<FTopLevelAssetPath>& ClassPaths, TSet<FTopLevelAssetPath>& RecursiveClassPathsExclusionSet, TArray<FName>& ClassNames, TSet<FName>& RecursiveClassesExclusionSet, bool& bRecursivePaths, bool& bRecursiveClasses, bool& bIncludeOnlyOnDiskAssets)

Parameters

Name Type Description Default
InARFilter FARFilter The filter struct to decompose. —
PackageNames TArray<FName>& Output: package names the filter matches. —
PackagePaths TArray<FName>& Output: package paths (folders) the filter matches. —
SoftObjectPaths TArray<FSoftObjectPath>& Output: exact soft object paths in the filter. —
ClassPaths TArray<FTopLevelAssetPath>& Output: class paths the filter matches. Prefer this over ClassNames. —
RecursiveClassPathsExclusionSet TSet<FTopLevelAssetPath>& Output: class paths excluded from recursive class expansion. —
ClassNames TArray<FName>& Output: deprecated short class names from the filter. —
RecursiveClassesExclusionSet TSet<FName>& Output: deprecated short-name class exclusion set. —
bRecursivePaths bool& Output: whether PackagePaths are searched recursively. —
bRecursiveClasses bool& Output: whether ClassPaths are expanded to derived classes. —
bIncludeOnlyOnDiskAssets bool& Output: whether only on-disk assets are considered. —

Return Type

void

Example

Decompose a filter's class paths C++
TArray<FName> PackageNames, PackagePaths, ClassNames;
TArray<FSoftObjectPath> SoftObjectPaths;
TArray<FTopLevelAssetPath> ClassPaths;
TSet<FTopLevelAssetPath> ClassPathExclusions;
TSet<FName> ClassNameExclusions;
bool bRecursivePaths = false, bRecursiveClasses = false, bOnDiskOnly = false;

UKismetSystemLibrary::BreakARFilter(
	ExistingFilter, PackageNames, PackagePaths, SoftObjectPaths, ClassPaths,
	ClassPathExclusions, ClassNames, ClassNameExclusions,
	bRecursivePaths, bRecursiveClasses, bOnDiskOnly);

Version History

Introduced in: unknown

Version Status Notes
5.6 stable —

Feedback

Was this helpful?

Suggest an edit

Select a field above to begin editing.