unreal.GeometryScriptIndexList

class unreal.GeometryScriptIndexList(index_type: GeometryScriptIndexType = Ellipsis)

Bases: StructBase

Geometry Script Index List

C++ Source:

• Plugin: GeometryScripting

• Module: GeometryScriptingCore

• File: GeometryScriptTypes.h

Editor Properties: (see get_editor_property/set_editor_property)

• index_type (GeometryScriptIndexType): [Read-Write]

clear_index_list(clear_value=0) → None

Set each value in Index List to the given Clear Value.

Parameters:

clear_value (int32) –

convert_index_list_to_array() → Array[int32]

Populates Index Array with the integer values stored in the Index List.

Returns:

index_array (Array[int32]):

Return type:

Array[int32]

duplicate_index_list() → GeometryScriptIndexList

Updates Duplicate List to be identical to Index List.

Returns:

duplicate_list (GeometryScriptIndexList):

Return type:

GeometryScriptIndexList

get_index_list_item(index) -> (int32, is_valid_index=bool)

Returns the item associated with Index in the Index List. If Index is not valid for this Index List the value -1 will be returned and bIsValidIndex will be set to false.

Parameters:

index (int32) –

Returns:

is_valid_index (bool):

Return type:

bool

get_index_list_last_index() → int32

Returns the index of the last element in the Index List. Note, the value -1 will be returned if the list is empty or invalid.

Return type:

int32

get_index_list_length() → int32

Returns the number of Items in Index List.

Return type:

int32

property index_type: GeometryScriptIndexType

[Read-Write]

Type:

(GeometryScriptIndexType)

set_index_list_item(index, new_value) → bool

Updates the value associated with Index in the Index List. If the Index is invalid, the operation will fail and in this case bValidIndex will be set to false on return.

Parameters:

• index (int32) –

• new_value (int32) –

Returns:

is_valid_index (bool):

Return type:

bool