unreal.GeometryScriptColorList

class unreal.GeometryScriptColorList

Bases: StructBase

Geometry Script Color List

C++ Source:

  • Plugin: GeometryScripting

  • Module: GeometryScriptingCore

  • File: GeometryScriptTypes.h

clear_color_list(clear_color) → None

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

Parameters:

clear_color (LinearColor) –

convert_color_list_to_array() → Array[LinearColor]

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

Returns:

color_array (Array[LinearColor]):

Return type:

Array[LinearColor]

duplicate_color_list() → GeometryScriptColorList

Duplicates the contents of Color List into Duplicate List.

Returns:

duplicate_list (GeometryScriptColorList):

Return type:

GeometryScriptColorList

extract_color_list_channel(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:

channel_index (int32) –

Returns:

scalar_list (GeometryScriptScalarList):

Return type:

GeometryScriptScalarList

extract_color_list_channels(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:

  • x_channel_index (int32) –

  • y_channel_index (int32) –

  • z_channel_index (int32) –

Returns:

vector_list (GeometryScriptVectorList):

Return type:

GeometryScriptVectorList

get_color_list_item(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:

index (int32) –

Returns:

is_valid_index (bool):

Return type:

bool

get_color_list_last_index() → 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.

Return type:

int32

get_color_list_length() → int32

Returns the number of items in the Color List.

Return type:

int32

set_color_list_item(index, new_color) → 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:

is_valid_index (bool):

Return type:

bool