unreal.PCGDataCollection

class unreal.PCGDataCollection(tagged_data: None = [], cancel_execution_on_empty: bool = False)

Bases: StructBase

PCGData Collection

C++ Source:

  • Plugin: PCG

  • Module: PCG

  • File: PCGData.h

Editor Properties: (see get_editor_property/set_editor_property)

  • cancel_execution_on_empty (bool): [Read-Write] Deprecated - Will be removed in 5.4

  • tagged_data (Array[PCGTaggedData]): [Read-Write]

add_to_collection(data, pin_label, tags) None

Adds a data object to a given collection, simpler usage than making a PCGTaggedData object. InTags can be empty.

Parameters:
property cancel_execution_on_empty: bool

[Read-Write] Deprecated - Will be removed in 5.4

Type:

(bool)

get_typed_inputs(data_type_class=None) -> (Array[PCGData], out_tagged_data=Array[PCGTaggedData])

Gets all inputs of the given class type, returning matching tagged data in the OutTaggedData value too

Parameters:

data_type_class (type(Class)) –

Returns:

out_tagged_data (Array[PCGTaggedData]):

Return type:

Array[PCGTaggedData]

get_typed_inputs_by_pin(pin, data_type_class=None) -> (Array[PCGData], out_tagged_data=Array[PCGTaggedData])

Gets all inputs of the given class type and on the given pin, returning matching tagged data in the OutTaggedData value too

Parameters:
Returns:

out_tagged_data (Array[PCGTaggedData]):

Return type:

Array[PCGTaggedData]

get_typed_inputs_by_pin_label(pin_label, data_type_class=None) -> (Array[PCGData], out_tagged_data=Array[PCGTaggedData])

Gets all inputs of the given class type and on the given pin label, returning matching tagged data in the OutTaggedData value too

Parameters:
Returns:

out_tagged_data (Array[PCGTaggedData]):

Return type:

Array[PCGTaggedData]

get_typed_inputs_by_tag(tag, data_type_class=None) -> (Array[PCGData], out_tagged_data=Array[PCGTaggedData])

Gets all inputs of the given class type and having the provided tag, returning matching tagged data in the OutTaggedData value too

Parameters:
Returns:

out_tagged_data (Array[PCGTaggedData]):

Return type:

Array[PCGTaggedData]

property tagged_data: None

[Read-Write]

Type:

(Array[PCGTaggedData])