RealDocs

UKismetArrayLibrary::FilterArray

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

Description

Returns a new array containing only the actors from TargetArray that are instances of FilterClass.

Caveats & Gotchas

  • Unlike most functions in this library, FilterArray is hard-typed to AActor* — it is not a CustomThunk wildcard, so it cannot filter arbitrary Blueprint array types, only actor arrays.
  • In Blueprint, FilteredArray's pin type follows FilterClass via DeterminesOutputType, so casting downstream nodes is unnecessary if FilterClass is a specific subclass.
  • FilteredArray is overwritten, not appended to — any prior contents are discarded.

Signature

static void FilterArray(const TArray<AActor*>& TargetArray, TSubclassOf<class AActor> FilterClass, TArray<AActor*>& FilteredArray);

Parameters

Name Type Description Default
TargetArray const TArray<AActor*>& The array of actors to filter.
FilterClass TSubclassOf<class AActor> Only actors derived from this class are kept.
FilteredArray TArray<AActor*>& Output parameter filled with the actors from TargetArray that match FilterClass.

Return Type

void

Example

Filter actors down to a specific class C++
TArray<AActor*> AllActors = /* ... */;
TArray<AActor*> OnlyPawns;
UKismetArrayLibrary::FilterArray(AllActors, APawn::StaticClass(), OnlyPawns);
// OnlyPawns contains only actors that are (or derive from) APawn

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.