unreal.GeometryScript_List

class unreal.GeometryScript_List(outer: Optional[Object] = None, name: Union[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

Clear Color List

Parameters:
Returns:

color_list (GeometryScriptColorList):

Return type:

GeometryScriptColorList

classmethod clear_index_list(index_list, clear_value=0) → GeometryScriptIndexList

Clear Index List

Parameters:
Returns:

index_list (GeometryScriptIndexList):

Return type:

GeometryScriptIndexList

classmethod clear_scalar_list(scalar_list, clear_value=0.000000) → GeometryScriptScalarList

Clear Scalar List

Parameters:
Returns:

scalar_list (GeometryScriptScalarList):

Return type:

GeometryScriptScalarList

classmethod clear_uv_list(uv_list, clear_uv) → GeometryScriptUVList

Clear UVList

Parameters:
Returns:

uv_list (GeometryScriptUVList):

Return type:

GeometryScriptUVList

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

Clear Vector List

Parameters:
Returns:

vector_list (GeometryScriptVectorList):

Return type:

GeometryScriptVectorList

classmethod convert_array_to_color_list(color_array) → GeometryScriptColorList

Convert Array to 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

Convert Array to Index List

Parameters:
Returns:

index_list (GeometryScriptIndexList):

Return type:

GeometryScriptIndexList

classmethod convert_array_to_scalar_list(vector_array) → GeometryScriptScalarList

Convert 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

Convert Array to Triangle List

Parameters:

triangle_array (Array[IntVector]) –

Returns:

triangle_list (GeometryScriptTriangleList):

Return type:

GeometryScriptTriangleList

classmethod convert_array_to_uv_list(uv_array) → GeometryScriptUVList

Convert Array to UVList

Parameters:

uv_array (Array[Vector2D]) –

Returns:

uv_list (GeometryScriptUVList):

Return type:

GeometryScriptUVList

classmethod convert_array_to_vector_list(vector_array) → GeometryScriptVectorList

Convert 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]

Convert Color List to Array

Parameters:

color_list (GeometryScriptColorList) –

Returns:

color_array (Array[LinearColor]):

Return type:

Array[LinearColor]

classmethod convert_index_list_to_array(index_list) → Array[int32]

Convert Index List to Array

Parameters:

index_list (GeometryScriptIndexList) –

Returns:

index_array (Array[int32]):

Return type:

Array[int32]

classmethod convert_scalar_list_to_array(scalar_list) → Array[double]

Convert Scalar List to Array

Parameters:

scalar_list (GeometryScriptScalarList) –

Returns:

scalar_array (Array[double]):

Return type:

Array[double]

classmethod convert_triangle_list_to_array(triangle_list) → Array[IntVector]

Convert Triangle List to Array

Parameters:

triangle_list (GeometryScriptTriangleList) –

Returns:

triangle_array (Array[IntVector]):

Return type:

Array[IntVector]

classmethod convert_uv_list_to_array(uv_list) → Array[Vector2D]

Convert UVList to Array

Parameters:

uv_list (GeometryScriptUVList) –

Returns:

uv_array (Array[Vector2D]):

Return type:

Array[Vector2D]

classmethod convert_vector_list_to_array(vector_list) → Array[Vector]

Convert Vector List to Array

Parameters:

vector_list (GeometryScriptVectorList) –

Returns:

vector_array (Array[Vector]):

Return type:

Array[Vector]

classmethod duplicate_color_list(color_list) → GeometryScriptColorList

Duplicate Color List

Parameters:

color_list (GeometryScriptColorList) –

Returns:

duplicate_list (GeometryScriptColorList):

Return type:

GeometryScriptColorList

classmethod duplicate_index_list(index_list) → GeometryScriptIndexList

Duplicate Index List

Parameters:

index_list (GeometryScriptIndexList) –

Returns:

duplicate_list (GeometryScriptIndexList):

Return type:

GeometryScriptIndexList

classmethod duplicate_scalar_list(scalar_list) → GeometryScriptScalarList

Duplicate Scalar List

Parameters:

scalar_list (GeometryScriptScalarList) –

Returns:

duplicate_list (GeometryScriptScalarList):

Return type:

GeometryScriptScalarList

classmethod duplicate_uv_list(uv_list) → GeometryScriptUVList

Duplicate UVList

Parameters:

uv_list (GeometryScriptUVList) –

Returns:

duplicate_list (GeometryScriptUVList):

Return type:

GeometryScriptUVList

classmethod duplicate_vector_list(vector_list) → GeometryScriptVectorList

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

Extract Color List Channel

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

Extract Color List Channels

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)

Get Color List Item

Parameters:
Returns:

is_valid_index (bool):

Return type:

bool

classmethod get_color_list_last_index(color_list) → int32

Get Color List Last Index

Parameters:

color_list (GeometryScriptColorList) –

Return type:

int32

classmethod get_color_list_length(color_list) → int32

Get Color List Length

Parameters:

color_list (GeometryScriptColorList) –

Return type:

int32

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

Get Index List Item

Parameters:
Returns:

is_valid_index (bool):

Return type:

bool

classmethod get_index_list_last_index(index_list) → int32

Get Index List Last Index

Parameters:

index_list (GeometryScriptIndexList) –

Return type:

int32

classmethod get_index_list_length(index_list) → int32

Get Index List Length

Parameters:

index_list (GeometryScriptIndexList) –

Return type:

int32

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

Get Scalar List Item

Parameters:
Returns:

is_valid_index (bool):

Return type:

bool

classmethod get_scalar_list_last_index(scalar_list) → int32

Get Scalar List Last Index

Parameters:

scalar_list (GeometryScriptScalarList) –

Return type:

int32

classmethod get_scalar_list_length(scalar_list) → int32

Get Scalar List Length

Parameters:

scalar_list (GeometryScriptScalarList) –

Return type:

int32

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

Get Triangle List Item

Parameters:
Returns:

is_valid_triangle (bool):

Return type:

bool

classmethod get_triangle_list_last_triangle(triangle_list) → int32

Get Triangle List Last Triangle

Parameters:

triangle_list (GeometryScriptTriangleList) –

Return type:

int32

classmethod get_triangle_list_length(triangle_list) → int32

Get Triangle List Length

Parameters:

triangle_list (GeometryScriptTriangleList) –

Return type:

int32

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

Get UVList Item

Parameters:
Returns:

is_valid_index (bool):

Return type:

bool

classmethod get_uv_list_last_index(uv_list) → int32

Get UVList Last Index

Parameters:

uv_list (GeometryScriptUVList) –

Return type:

int32

classmethod get_uv_list_length(uv_list) → int32

Get UVList Length

Parameters:

uv_list (GeometryScriptUVList) –

Return type:

int32

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

Get Vector List Item

Parameters:
Returns:

is_valid_index (bool):

Return type:

bool

classmethod get_vector_list_last_index(vector_list) → int32

Get Vector List Last Index

Parameters:

vector_list (GeometryScriptVectorList) –

Return type:

int32

classmethod get_vector_list_length(vector_list) → int32

Get Vector List Length

Parameters:

vector_list (GeometryScriptVectorList) –

Return type:

int32

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

Set Color List Item

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)

Set Index List Item

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)

Set Scalar List Item

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)

Set UVList Item

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)

Set Vector List Item

Parameters:
Returns:

vector_list (GeometryScriptVectorList):

is_valid_index (bool):

Return type:

tuple