UEditorFilterLibrary::ByActorLabel

Filter the array based on the Actor's label (what we see in the editor)

Windows
MacOS
Linux

References

Module

EditorScriptingUtilities

Header

/Engine/Plugins/Editor/EditorScriptingUtilities/Source/EditorScriptingUtilities/Public/EditorFilterLibrary.h

Include

#include "EditorFilterLibrary.h"

Source

/Engine/Plugins/Editor/EditorScriptingUtilities/Source/EditorScriptingUtilities/Private/EditorFilterLibrary.cpp

Syntax

[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Editor Scripting | Utilities | Filter",
          Meta=(DisplayName="Filter by Actor Label", DeterminesOutputType="TargetArray"))
static TArray< class AActor * > ByActorLabel
(
    const TArray< class AActor * > & TargetArray,
    const FString & NameSubString,
    EEditorScriptingStringMatchType StringMatch,
    EEditorScriptingFilterType FilterType,
    bool bIgnoreCase
)

Remarks

Filter the array based on the Actor's label (what we see in the editor)

Returns

The filtered list.

Parameters

Parameter

Description

TargetArray

Array of Actor to filter. The array will not change.

NameSubString

The text the Actor's Label.

FilterType

Should include or not the array's item if it respects the condition.

StringMatch

Contains the NameSubString OR matches with the wildcard *? OR exactly the same value.

bIgnoreCase

Determines case sensitivity options for string comparisons.

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