UEditorFilterLibrary

Utility class to filter a list of objects. Object should be in the World Editor.

API > API/Plugins > API/Plugins/EditorScriptingUtilities

Utility class to filter a list of objects. Object should be in the World Editor.

   
Name UEditorFilterLibrary
Type class
Header File /Engine/Plugins/Editor/EditorScriptingUtilities/Source/EditorScriptingUtilities/Public/EditorFilterLibrary.h
Include Path #include "EditorFilterLibrary.h"

Syntax

UCLASS (MinimalAPI)  
class UEditorFilterLibrary : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Functions

Static

Name Remarks Include Path Unreal Specifiers

static TArray< class AActor * > ByActorLabel ( const TArray< class AActor* >& TargetArray,
const FString& NameSubString,
EEditorScriptingStringMatchType StringMatch,
EEditorScriptingFilterType FilterType,
bool bIgnoreCase
)

 Filter the array based on the Actor's label (what we see in the editor) EditorFilterLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Utilities | Filter"
  • Meta=(DisplayName="Filter by Actor Label", DeterminesOutputType="TargetArray")

static TArray< class AActor * > ByActorTag ( const TArray< class AActor* >& TargetArray,
FName Tag,
EEditorScriptingFilterType FilterType
)

 Filter the array by Tag the Actor contains EditorFilterLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Utilities | Filter"
  • Meta=(DisplayName="Filter by Actor Tag", DeterminesOutputType="TargetArray")

static TArray< class UObject * > ByClass ( const TArray< class UObject* >& TargetArray,
TSubclassOf< class UObject > ObjectClass,
EEditorScriptingFilterType FilterType
)

 Filter the array based on the Object's class. EditorFilterLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Utilities | Filter"
  • Meta=(DisplayName="Filter by Class", DeterminesOutputType="ObjectClass")

static TArray< class UObject * > ByIDName ( const TArray< class UObject* >& TargetArray,
const FString& NameSubString,
EEditorScriptingStringMatchType StringMatch,
EEditorScriptingFilterType FilterType
)

 Filter the array based on the Object's ID name. EditorFilterLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Utilities | Filter"
  • Meta=(DisplayName="Filter by ID Name", DeterminesOutputType="TargetArray")

static TArray< class AActor * > ByLayer ( const TArray< class AActor* >& TargetArray,
FName LayerName,
EEditorScriptingFilterType FilterType
)

 Filter the array by Layer the Actor belongs to. EditorFilterLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Utilities | Filter"
  • Meta=(DisplayName="Filter by Layer", DeterminesOutputType="TargetArray")

static TArray< class AActor * > ByLevelName ( const TArray< class AActor* >& TargetArray,
FName LevelName,
EEditorScriptingFilterType FilterType
)

 Filter the array by Level the Actor belongs to. EditorFilterLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Utilities | Filter"
  • Meta=(DisplayName="Filter by Level Name", DeterminesOutputType="TargetArray")

static TArray< class AActor * > BySelection ( const TArray< class AActor* >& TargetArray,
EEditorScriptingFilterType FilterType
)

 Filter the array based on Object's selection. EditorFilterLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Utilities | Filter"
  • Meta=(DisplayName="Filter by Selection", DeterminesOutputType="TargetArray")

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page