unreal.TypedElementSelectionInterface

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

Bases: Interface

Typed Element Selection Interface

C++ Source:

  • Module: TypedElementRuntime

  • File: TypedElementSelectionInterface.h

allow_selection_modifiers(element_handle, selection_set) → bool

Test to see whether selection modifiers (Ctrl or Shift) are allowed while selecting this element.

Parameters:
Return type:

bool

can_deselect_element(element_handle, selection_options) → bool

Test to see whether the given element can be deselected.

Parameters:
Return type:

bool

can_select_element(element_handle, selection_options) → bool

Test to see whether the given element can be selected.

Parameters:
Return type:

bool

deselect_element(element_handle, selection_set, selection_options) → bool

Attempt to deselect the given element.

Parameters:
Returns:

True if the selection was changed, false otherwise.

Return type:

bool

get_selection_element(element_handle, current_selection, selection_method) → ScriptTypedElementHandle

Given an element, return the element that should actually perform a selection operation.

Parameters:
Return type:

ScriptTypedElementHandle

is_element_selected(element_handle, selection_set, selection_options) → bool

Test to see whether the given element is currently considered selected.

Parameters:
Return type:

bool

select_element(element_handle, selection_set, selection_options) → bool

Attempt to select the given element.

Parameters:
Returns:

True if the selection was changed, false otherwise.

Return type:

bool