unreal.TypedElementListLibrary

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

Bases: Object

Typed Element List Library

C++ Source:

  • Module: TypedElementFramework

  • File: TypedElementListLibrary.h

classmethod add(element_list, element_handle) → bool

Add the given element handle to this element list, if it isn’t already in the list.

Parameters:
Returns:

True if the element handle was added, false if it is already in the list.

Return type:

bool

classmethod append(element_list, element_handles) → None

Append the given element handles to this element list.

Parameters:
classmethod append_list(element_list, other_element_list) → None

Append the another element list to this element list.

Parameters:
classmethod clone(element_list) → TypedElementList

Clone this list instance. note: Only copies elements; does not copy any bindings!

Parameters:

element_list (TypedElementList)

Return type:

TypedElementList

classmethod contains(element_list, element_handle) → bool

Does this element list contain an entry for the given element handle?

Parameters:
Return type:

bool

classmethod count_elements(element_list, base_interface_type=None) → int32

Count the number of elements in this list, optionally filtering to elements that implement the given interface.

Parameters:
Return type:

int32

classmethod count_elements_of_type(element_list, element_type_name) → int32

Count the number of elements in this list of the given type.

Parameters:
Return type:

int32

classmethod create_element_list(registry) → TypedElementList

Create an empty list of elements associated with the given registry.

Parameters:

registry (TypedElementRegistry)

Return type:

TypedElementList

classmethod empty(element_list, slack=0) → None

Remove all entries from this element list, potentially leaving space allocated for the given number of entries.

Parameters:
classmethod get_element_handle_at(element_list, index) → ScriptTypedElementHandle

Get the element handle at the given index. note: Use IsValidIndex to test for validity.

Parameters:
Return type:

ScriptTypedElementHandle

classmethod get_element_handles(element_list, base_interface_type) → Array[ScriptTypedElementHandle]

Get the handle of every element in this list, optionally filtering to elements that implement the given interface.

Parameters:
Return type:

Array[ScriptTypedElementHandle]

classmethod get_element_interface(element_list, element_handle, base_interface_type) → Object

Get the element interface from the given handle.

Parameters:
Return type:

Object

classmethod has_elements(element_list, base_interface_type=None) → bool

Test whether there are elements in this list, optionally filtering to elements that implement the given interface.

Parameters:
Return type:

bool

classmethod has_elements_of_type(element_list, element_type_name) → bool

Test whether there are elements in this list of the given type.

Parameters:
Return type:

bool

classmethod is_valid_index(element_list, index) → bool

Is the given index a valid entry within this element list?

Parameters:
Return type:

bool

classmethod num(element_list) → int32

Get the number of entries within this element list.

Parameters:

element_list (TypedElementList)

Return type:

int32

classmethod remove(element_list, element_handle) → bool

Remove the given element handle from this element list, if it is in the list.

Parameters:
Returns:

True if the element handle was removed, false if it isn’t in the list.

Return type:

bool

classmethod reserve(element_list, size) → None

Pre-allocate enough memory in this element list to store the given number of entries.

Parameters:
classmethod reset(element_list) → None

Remove all entries from this element list, preserving existing allocations.

Parameters:

element_list (TypedElementList)

classmethod shrink(element_list) → None

Shrink this element list storage to avoid slack.

Parameters:

element_list (TypedElementList)