unreal.TypedElementSelectionInterface
¶
- class unreal.TypedElementSelectionInterface(outer=None, name='None')¶
Bases:
unreal.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
element_handle (ScriptTypedElementHandle) –
selection_set (TypedElementList) –
- Return type
- can_deselect_element(element_handle, selection_options) bool ¶
Test to see whether the given element can be deselected.
- Parameters
element_handle (ScriptTypedElementHandle) –
selection_options (TypedElementSelectionOptions) –
- Return type
- can_select_element(element_handle, selection_options) bool ¶
Test to see whether the given element can be selected.
- Parameters
element_handle (ScriptTypedElementHandle) –
selection_options (TypedElementSelectionOptions) –
- Return type
- deselect_element(element_handle, selection_set, selection_options) bool ¶
Attempt to deselect the given element.
- Parameters
element_handle (ScriptTypedElementHandle) –
selection_set (TypedElementList) –
selection_options (TypedElementSelectionOptions) –
- Returns
True if the selection was changed, false otherwise.
- Return type
- get_selection_element(element_handle, current_selection, selection_method) ScriptTypedElementHandle ¶
Given an element, return the element that should actually perform a selection operation.
- Parameters
element_handle (ScriptTypedElementHandle) –
current_selection (TypedElementList) –
selection_method (TypedElementSelectionMethod) –
- Return type
- is_element_selected(element_handle, selection_set, selection_options) bool ¶
Test to see whether the given element is currently considered selected.
- Parameters
element_handle (ScriptTypedElementHandle) –
selection_set (TypedElementList) –
selection_options (TypedElementIsSelectedOptions) –
- Return type
- select_element(element_handle, selection_set, selection_options) bool ¶
Attempt to select the given element.
- Parameters
element_handle (ScriptTypedElementHandle) –
selection_set (TypedElementList) –
selection_options (TypedElementSelectionOptions) –
- Returns
True if the selection was changed, false otherwise.
- Return type