unreal.GeometryScript_List

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

Bases: BlueprintFunctionLibrary

Geometry Script Library List Utility Functions

C++ Source:

  • Plugin: GeometryScripting

  • Module: GeometryScriptingCore

  • File: ListUtilityFunctions.h

classmethod clear_color_list(color_list, clear_color) → GeometryScriptColorList

Resets all the items in the Color List to the specified Clear Color.

Parameters:
Returns:

color_list (GeometryScriptColorList):

Return type:

GeometryScriptColorList

classmethod clear_index_list(index_list, clear_value=0) → GeometryScriptIndexList

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

Parameters:
Returns:

index_list (GeometryScriptIndexList):

Return type:

GeometryScriptIndexList

classmethod clear_scalar_list(scalar_list, clear_value=0.000000) → GeometryScriptScalarList

Resets all the items in the Scalar List to the Clear Value.

Parameters:
Returns:

scalar_list (GeometryScriptScalarList):

Return type:

GeometryScriptScalarList

classmethod clear_uv_list(uv_list, clear_uv) → GeometryScriptUVList

Resets all the items in the Vector List to the given Clear UV value.

Parameters:
Returns:

uv_list (GeometryScriptUVList):

Return type:

GeometryScriptUVList

classmethod clear_vector_list(vector_list, clear_value=[0.000000, 0.000000, 0.000000]) → GeometryScriptVectorList

Resets all the items in the Vector List to the Clear Value.

Parameters:
Returns:

vector_list (GeometryScriptVectorList):

Return type:

GeometryScriptVectorList

classmethod convert_array_to_color_list(color_array) → GeometryScriptColorList

Converts an array of FLinearColor (Color Array) to a Color List.

Parameters:

color_array (Array[LinearColor]) –

Returns:

color_list (GeometryScriptColorList):

Return type:

GeometryScriptColorList

classmethod convert_array_to_index_list(index_array, index_type=GeometryScriptIndexType.ANY) → GeometryScriptIndexList

Populates Index List of the specified Index Type from the integer values stored in the Index Array.

Parameters:
Returns:

index_list (GeometryScriptIndexList):

Return type:

GeometryScriptIndexList

classmethod convert_array_to_scalar_list(vector_array) → GeometryScriptScalarList

Converts an array of doubles (Scalar Array) to Scalar List.

Parameters:

vector_array (Array[double]) –

Returns:

scalar_list (GeometryScriptScalarList):

Return type:

GeometryScriptScalarList

classmethod convert_array_to_triangle_list(triangle_array) → GeometryScriptTriangleList

Converts a Triangle Array of integer triplets to a Triangle List.

Parameters:

triangle_array (Array[IntVector]) –

Returns:

triangle_list (GeometryScriptTriangleList):

Return type:

GeometryScriptTriangleList

classmethod convert_array_to_uv_list(uv_array) → GeometryScriptUVList

Converts an array of FVector2D (UV Array) to UV List.

Parameters:

uv_array (Array[Vector2D]) –

Returns:

uv_list (GeometryScriptUVList):

Return type:

GeometryScriptUVList

classmethod convert_array_to_vector_list(vector_array) → GeometryScriptVectorList

Converts an Array of FVectors (Vector Array) to Vector List.

Parameters:

vector_array (Array[Vector]) –

Returns:

vector_list (GeometryScriptVectorList):

Return type:

GeometryScriptVectorList

classmethod convert_color_list_to_array(color_list) → Array[LinearColor]

Converts the Color List to an array of FLinearColor (Color Array).

Parameters:

color_list (GeometryScriptColorList) –

Returns:

color_array (Array[LinearColor]):

Return type:

Array[LinearColor]

classmethod convert_index_list_to_array(index_list) → Array[int32]

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

Parameters:

index_list (GeometryScriptIndexList) –

Returns:

index_array (Array[int32]):

Return type:

Array[int32]

classmethod convert_scalar_list_to_array(scalar_list) → Array[double]

Converts a Scalar List to an Scalar Array (an array of doubles).

Parameters:

scalar_list (GeometryScriptScalarList) –

Returns:

scalar_array (Array[double]):

Return type:

Array[double]

classmethod convert_triangle_list_to_array(triangle_list) → Array[IntVector]

Converts Triangle List to Triangle Array by populating with the appropriate integer triplets.

Parameters:

triangle_list (GeometryScriptTriangleList) –

Returns:

triangle_array (Array[IntVector]):

Return type:

Array[IntVector]

classmethod convert_uv_list_to_array(uv_list) → Array[Vector2D]

Converts a UV List to an array of FVector2Ds (UV Array).

Parameters:

uv_list (GeometryScriptUVList) –

Returns:

uv_array (Array[Vector2D]):

Return type:

Array[Vector2D]

classmethod convert_vector_list_to_array(vector_list) → Array[Vector]

Converts Vector List to an array of FVectors (Vector Array).

Parameters:

vector_list (GeometryScriptVectorList) –

Returns:

vector_array (Array[Vector]):

Return type:

Array[Vector]

classmethod duplicate_color_list(color_list) → GeometryScriptColorList

Duplicates the contents of Color List into Duplicate List.

Parameters:

color_list (GeometryScriptColorList) –

Returns:

duplicate_list (GeometryScriptColorList):

Return type:

GeometryScriptColorList

classmethod duplicate_index_list(index_list) → GeometryScriptIndexList

Updates Duplicate List to be identical to Index List.

Parameters:

index_list (GeometryScriptIndexList) –

Returns:

duplicate_list (GeometryScriptIndexList):

Return type:

GeometryScriptIndexList

classmethod duplicate_scalar_list(scalar_list) → GeometryScriptScalarList

Copies the contents of Scalar List into Duplicate List.

Parameters:

scalar_list (GeometryScriptScalarList) –

Returns:

duplicate_list (GeometryScriptScalarList):

Return type:

GeometryScriptScalarList

classmethod duplicate_uv_list(uv_list) → GeometryScriptUVList

Duplicates the contents of UV List into Duplicate List.

Parameters:

uv_list (GeometryScriptUVList) –

Returns:

duplicate_list (GeometryScriptUVList):

Return type:

GeometryScriptUVList

classmethod duplicate_vector_list(vector_list) → GeometryScriptVectorList

Copies the contents of Vector List into Duplicate Vector List.

Parameters:

vector_list (GeometryScriptVectorList) –

Returns:

duplicate_list (GeometryScriptVectorList):

Return type:

GeometryScriptVectorList

classmethod extract_color_list_channel(color_list, channel_index=0) → GeometryScriptScalarList

Populates a Scalar List with values that corresponds to the 0, 1, 2, or 3 channel of a Color List.

Parameters:
Returns:

scalar_list (GeometryScriptScalarList):

Return type:

GeometryScriptScalarList

classmethod extract_color_list_channels(color_list, x_channel_index=0, y_channel_index=1, z_channel_index=2) → GeometryScriptVectorList

Populates a Vector List from a Color List. The channels in the Color List are mapped to vector components by means of X Channel Index, Y Channel Index, and Z Channel Index.

Parameters:

  • color_list (GeometryScriptColorList) –

  • x_channel_index (int32) –

  • y_channel_index (int32) –

  • z_channel_index (int32) –

Returns:

vector_list (GeometryScriptVectorList):

Return type:

GeometryScriptVectorList

classmethod get_color_list_item(color_list, index) -> (LinearColor, is_valid_index=bool)

Returns the FLinearColor stored in the Color List at the specified location. If the Index is not valid for this Color List, FLinearColor::White will be returned and bIsValidIndex set to false.

Parameters:
Returns:

is_valid_index (bool):

Return type:

bool

classmethod get_color_list_last_index(color_list) → int32

Returns the index of the last item in the Color List. If Color List is empty or invalid, the value -1 will be returned.

Parameters:

color_list (GeometryScriptColorList) –

Return type:

int32

classmethod get_color_list_length(color_list) → int32

Returns the number of items in the Color List.

Parameters:

color_list (GeometryScriptColorList) –

Return type:

int32

classmethod get_index_list_item(index_list, 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:
Returns:

is_valid_index (bool):

Return type:

bool

classmethod get_index_list_last_index(index_list) → 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.

Parameters:

index_list (GeometryScriptIndexList) –

Return type:

int32

classmethod get_index_list_length(index_list) → int32

Returns the number of Items in Index List.

Parameters:

index_list (GeometryScriptIndexList) –

Return type:

int32

classmethod get_scalar_list_item(scalar_list, index) -> (double, is_valid_index=bool)

Returns the Scalar value associated with Index in Scalar List. If the Index is not valid for this Scalar List, the value 0.0 will be returned and bIsValidIndex set to false.

Parameters:
Returns:

is_valid_index (bool):

Return type:

bool

classmethod get_scalar_list_last_index(scalar_list) → int32

Returns the index of the last Scalar in Scalar List. If Scalar List is empty or invalid, the value -1 will be returned

Parameters:

scalar_list (GeometryScriptScalarList) –

Return type:

int32

classmethod get_scalar_list_length(scalar_list) → int32

Returns the number of items in the Scalar List.

Parameters:

scalar_list (GeometryScriptScalarList) –

Return type:

int32

classmethod get_triangle_list_item(triangle_list, triangle) -> (IntVector, is_valid_triangle=bool)

Returns the integer triplet associated with the index Triangle in the Triangle List. If Triangle is not valid for this Triangle List, the triplet (-1, -1, -1) will be returned and bIsValidIndex set to false.

Parameters:
Returns:

is_valid_triangle (bool):

Return type:

bool

classmethod get_triangle_list_last_triangle(triangle_list) → int32

Returns the index of the last element in the Triangle List. If the Triangle List is empty or invalid, the value 0 will be returned.

Parameters:

triangle_list (GeometryScriptTriangleList) –

Return type:

int32

classmethod get_triangle_list_length(triangle_list) → int32

Returns the number of Triangles in the Triangle list.

Parameters:

triangle_list (GeometryScriptTriangleList) –

Return type:

int32

classmethod get_uv_list_item(uv_list, index) -> (Vector2D, is_valid_index=bool)

Returns the FVector2D stored in the UV List at the specified location. If the Index is not valid for this UV List, the Zero Vector will be returned and bIsValidIndex set to false.

Parameters:
Returns:

is_valid_index (bool):

Return type:

bool

classmethod get_uv_list_last_index(uv_list) → int32

Returns the index of the last item in the UV List. If UV List is empty or invalid, the value -1 will be returned.

Parameters:

uv_list (GeometryScriptUVList) –

Return type:

int32

classmethod get_uv_list_length(uv_list) → int32

Returns the number of items in the UV List.

Parameters:

uv_list (GeometryScriptUVList) –

Return type:

int32

classmethod get_vector_list_item(vector_list, index) -> (Vector, is_valid_index=bool)

Returns the FVector stored in the VectorList at the specified location. if the Index is not valid for this Vector List, the Zero Vector will be returned and bIsValidIndex set to false.

Parameters:
Returns:

is_valid_index (bool):

Return type:

bool

classmethod get_vector_list_last_index(vector_list) → int32

Returns the index of the last item in the Vector List. If Vector List is empty or invalid, the value -1 will be returned.

Parameters:

vector_list (GeometryScriptVectorList) –

Return type:

int32

classmethod get_vector_list_length(vector_list) → int32

Returns the number of items in the Vector List.

Parameters:

vector_list (GeometryScriptVectorList) –

Return type:

int32

classmethod set_color_list_item(color_list, index, new_color) -> (color_list=GeometryScriptColorList, is_valid_index=bool)

Updates the value of the FLinearColor stored in the Color List at the specified location. If the Index is invalid, the operation will fail and bValidIndex will be set to false.

Parameters:
Returns:

color_list (GeometryScriptColorList):

is_valid_index (bool):

Return type:

tuple

classmethod set_index_list_item(index_list, index, new_value) -> (index_list=GeometryScriptIndexList, is_valid_index=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:
Returns:

index_list (GeometryScriptIndexList):

is_valid_index (bool):

Return type:

tuple

classmethod set_scalar_list_item(scalar_list, index, new_value) -> (scalar_list=GeometryScriptScalarList, is_valid_index=bool)

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

Parameters:
Returns:

scalar_list (GeometryScriptScalarList):

is_valid_index (bool):

Return type:

tuple

classmethod set_uv_list_item(uv_list, index, new_uv) -> (uv_list=GeometryScriptUVList, is_valid_index=bool)

Updates the value of the FVector2D stored in the UV List at the specified location. If the Index is invalid, the operation will fail and bValidIndex will be set to false on return.

Parameters:
Returns:

uv_list (GeometryScriptUVList):

is_valid_index (bool):

Return type:

tuple

classmethod set_vector_list_item(vector_list, index, new_value) -> (vector_list=GeometryScriptVectorList, is_valid_index=bool)

Updates the value of the FVector stored in the Vector List at the specified location. If the Index is invalid, the operation will fail and bValidIndex will be set to false.

Parameters:
Returns:

vector_list (GeometryScriptVectorList):

is_valid_index (bool):

Return type:

tuple