unreal.EditorFilterLibrary

class unreal.EditorFilterLibrary(outer: Optional[Object] = None, name: Union[Name, str] = 'None')

Bases: BlueprintFunctionLibrary

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

C++ Source:

  • Plugin: EditorScriptingUtilities

  • Module: EditorScriptingUtilities

  • File: EditorFilterLibrary.h

classmethod by_actor_label(target_array, name_sub_string, string_match=EditorScriptingStringMatchType.CONTAINS, filter_type=EditorScriptingFilterType.INCLUDE, ignore_case=True) Array[Actor]

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

Parameters:
  • target_array (Array[Actor]) – Array of Actor to filter. The array will not change.

  • name_sub_string (str) – The text the Actor’s Label.

  • string_match (EditorScriptingStringMatchType) – Contains the NameSubString OR matches with the wildcard *? OR exactly the same value.

  • filter_type (EditorScriptingFilterType) – Should include or not the array’s item if it respects the condition.

  • ignore_case (bool) – Determines case sensitivity options for string comparisons.

Returns:

The filtered list.

Return type:

Array[Actor]

classmethod by_actor_tag(target_array, tag, filter_type=EditorScriptingFilterType.INCLUDE) Array[Actor]

Filter the array by Tag the Actor contains

Parameters:
  • target_array (Array[Actor]) – Array of Actor to filter. The array will not change.

  • tag (Name) – The exact name of the Tag the actor contains.

  • filter_type (EditorScriptingFilterType) – Should include or not the array’s item if it respects the condition.

Returns:

The filtered list.

Return type:

Array[Actor]

classmethod by_class(target_array, object_class, filter_type=EditorScriptingFilterType.INCLUDE) Array[Object]

Filter the array based on the Object’s class.

Parameters:
  • target_array (Array[Object]) – Array of Object to filter. The array will not change.

  • object_class (type(Class)) – The Class of the object.

  • filter_type (EditorScriptingFilterType) – Should include or not the array’s item if it respects the condition.

Returns:

The filtered list.

Return type:

Array[Object]

classmethod by_id_name(target_array, name_sub_string, string_match=EditorScriptingStringMatchType.CONTAINS, filter_type=EditorScriptingFilterType.INCLUDE) Array[Object]

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

Parameters:
  • target_array (Array[Object]) – Array of Object to filter. The array will not change.

  • name_sub_string (str) – The text the Object’s ID name.

  • string_match (EditorScriptingStringMatchType) – Contains the NameSubString OR matches with the wildcard *? OR exactly the same value.

  • filter_type (EditorScriptingFilterType) – Should include or not the array’s item if it respects the condition.

Returns:

The filtered list.

Return type:

Array[Object]

classmethod by_layer(target_array, layer_name, filter_type=EditorScriptingFilterType.INCLUDE) Array[Actor]

Filter the array by Layer the Actor belongs to.

Parameters:
  • target_array (Array[Actor]) – Array of Actor to filter. The array will not change.

  • layer_name (Name) – The exact name of the Layer the actor belongs to.

  • filter_type (EditorScriptingFilterType) – Should include or not the array’s item if it respects the condition.

Returns:

The filtered list.

Return type:

Array[Actor]

classmethod by_level_name(target_array, level_name, filter_type=EditorScriptingFilterType.INCLUDE) Array[Actor]

Filter the array by Level the Actor belongs to.

Parameters:
  • target_array (Array[Actor]) – Array of Actor to filter. The array will not change.

  • level_name (Name) – The name of the Level the actor belongs to (same name as in the ContentBrowser).

  • filter_type (EditorScriptingFilterType) – Should include or not the array’s item if it respects the condition.

Returns:

The filtered list.

Return type:

Array[Actor]

classmethod by_selection(target_array, filter_type=EditorScriptingFilterType.INCLUDE) Array[Actor]

Filter the array based on Object’s selection.

Parameters:
  • target_array (Array[Actor]) – Array of Object to filter. The array will not change.

  • filter_type (EditorScriptingFilterType) – Should include or not the array’s item if it respects the condition.

Returns:

The filtered list.

Return type:

Array[Actor]