unreal.TypedElementCommonActions

class unreal.TypedElementCommonActions(outer: Object | None = None, name: Name | str = 'None')

Bases: Object

A utility to handle higher-level common actions, but default via UTypedElementWorldInterface, but asset editors can customize this behavior via FTypedElementCommonActionsCustomization.

C++ Source:

  • Module: Engine

  • File: TypedElementCommonActions.h

copy_normalized_elements(element_list) → bool

  • Copy any elements from the given selection set that can be copied into the clipboard.

note: This list should have been pre-normalized via UTypedElementSelectionSet::GetNormalizedSelection or UTypedElementSelectionSet::GetNormalizedElementList.

Parameters:

element_list (TypedElementList) –

Return type:

bool

copy_normalized_elements_to_string(element_list) → str or None

  • Copy any elements from the given selection set that can be copied into the clipboard.

note: This list should have been pre-normalized via UTypedElementSelectionSet::GetNormalizedSelection or UTypedElementSelectionSet::GetNormalizedElementList.

Parameters:

element_list (TypedElementList) –

Returns:

output_string (str):

Return type:

str or None

copy_selected_elements(selection_set) → bool

Copy any elements from the given selection set that can be copied into the clipboard note: Internally this just calls CopyNormalizedElements on the result of UTypedElementSelectionSet::GetNormalizedSelection.

Parameters:

selection_set (TypedElementSelectionSet) –

Return type:

bool

copy_selected_elements_to_string(selection_set) → str or None

Copy any elements from the given selection set that can be copied into the string note: Internally this just calls CopyNormalizedElements on the result of UTypedElementSelectionSet::GetNormalizedSelection.

Parameters:

selection_set (TypedElementSelectionSet) –

Returns:

output_string (str):

Return type:

str or None

delete_normalized_elements(element_list, world, selection_set, deletion_options) → bool

Delete any elements from the given list that can be deleted. note: This list should have been pre-normalized via UTypedElementSelectionSet::GetNormalizedSelection or UTypedElementSelectionSet::GetNormalizedElementList.

Parameters:
Return type:

bool

delete_selected_elements(selection_set, world, deletion_options) → bool

Delete any elements from the given selection set that can be deleted. note: Internally this just calls DeleteNormalizedElements on the result of UTypedElementSelectionSet::GetNormalizedSelection.

Parameters:
Return type:

bool

duplicate_normalized_elements(element_list, world, location_offset) → Array[ScriptTypedElementHandle]

Duplicate any elements from the given list that can be duplicated. note: This list should have been pre-normalized via UTypedElementSelectionSet::GetNormalizedSelection or UTypedElementSelectionSet::GetNormalizedElementList.

Parameters:
Return type:

Array[ScriptTypedElementHandle]

duplicate_selected_elements(selection_set, world, location_offset) → Array[ScriptTypedElementHandle]

Duplicate any elements from the given selection set that can be duplicated. note: Internally this just calls DuplicateNormalizedElements on the result of UTypedElementSelectionSet::GetNormalizedSelection.

Parameters:
Return type:

Array[ScriptTypedElementHandle]

paste_elements(selection_set, world, paste_option) → Array[ScriptTypedElementHandle]

Paste any elements from the clipboard note: Internally this just calls PasteNormalizedElements on the result of UTypedElementSelectionSet::GetNormalizedSelection.

Parameters:
Return type:

Array[ScriptTypedElementHandle]

paste_elements_from_string(selection_set, world, paste_option, input_string) → Array[ScriptTypedElementHandle]

Paste any elements from the given string note: Internally this just calls PasteNormalizedElements on the result of UTypedElementSelectionSet::GetNormalizedSelection.

Parameters:
Return type:

Array[ScriptTypedElementHandle]

paste_normalized_elements(element_list, world, paste_option) → Array[ScriptTypedElementHandle]

Paste any elements from the clipboard note: This list should have been pre-normalized via UTypedElementSelectionSet::GetNormalizedSelection or UTypedElementSelectionSet::GetNormalizedElementList.

Parameters:
Return type:

Array[ScriptTypedElementHandle]

paste_normalized_elements_from_string(element_list, world, paste_option, input_string) → Array[ScriptTypedElementHandle]

Paste any elements from the given string note: This list should have been pre-normalized via UTypedElementSelectionSet::GetNormalizedSelection or UTypedElementSelectionSet::GetNormalizedElementList.

Parameters:
Return type:

Array[ScriptTypedElementHandle]