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 > Plugins > EditorScriptingUtilities > UEditorFilterLibrary > UEditorFilterLibrary::ByIDName

Light Theme

Dark Theme

UEditorFilterLibrary::ByIDName

Filter the array based on the Object's ID name.

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 ID Name", DeterminesOutputType="TargetArray"))
static TArray< class UObject * > ByIDName
(
    const TArray< class UObject * > & TargetArray,
    const FString & NameSubString,
    EEditorScriptingStringMatchType StringMatch,
    EEditorScriptingFilterType FilterType
)

Remarks

Filter the array based on the Object's ID name.

Returns

The filtered list.

Parameters

Parameter	Description
TargetArray	Array of Object to filter. The array will not change.
NameSubString	The text the Object's ID name.
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.

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

Take our survey

Dismiss