unreal.PCGDataFunctionLibrary

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

Bases: BlueprintFunctionLibrary

PCGData Function Library

C++ Source:

  • Plugin: PCG

  • Module: PCG

  • File: PCGData.h

classmethod add_to_collection(collection, data, pin_label, tags) → PCGDataCollection

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

Parameters:
Returns:

collection (PCGDataCollection):

Return type:

PCGDataCollection

classmethod get_all_settings(collection) → Array[PCGTaggedData]

Get All Settings

Parameters:

collection (PCGDataCollection) –

Return type:

Array[PCGTaggedData]

classmethod get_inputs(collection) → Array[PCGTaggedData]

Blueprint methods to support interaction with FPCGDataCollection

Parameters:

collection (PCGDataCollection) –

Return type:

Array[PCGTaggedData]

classmethod get_inputs_by_pin(collection: PCGDataCollection, pin_label: Name) → None

deprecated: ‘get_inputs_by_pin’ was renamed to ‘get_inputs_by_pin_label’.

classmethod get_inputs_by_pin_label(collection, pin_label) → Array[PCGTaggedData]

Get Inputs by Pin Label

Parameters:
Return type:

Array[PCGTaggedData]

classmethod get_inputs_by_tag(collection, tag) → Array[PCGTaggedData]

Get Inputs by Tag

Parameters:
Return type:

Array[PCGTaggedData]

classmethod get_params(collection) → Array[PCGTaggedData]

Get Params

Parameters:

collection (PCGDataCollection) –

Return type:

Array[PCGTaggedData]

classmethod get_params_by_pin(collection: PCGDataCollection, pin_label: Name) → None

deprecated: ‘get_params_by_pin’ was renamed to ‘get_params_by_pin_label’.

classmethod get_params_by_pin_label(collection, pin_label) → Array[PCGTaggedData]

Get Params by Pin Label

Parameters:
Return type:

Array[PCGTaggedData]

classmethod get_params_by_tag(collection, tag) → Array[PCGTaggedData]

Get Params by Tag

Parameters:
Return type:

Array[PCGTaggedData]

classmethod get_tagged_inputs(collection: PCGDataCollection, tag: str) → None

deprecated: ‘get_tagged_inputs’ was renamed to ‘get_inputs_by_tag’.

classmethod get_tagged_params(collection: PCGDataCollection, tag: str) → None

deprecated: ‘get_tagged_params’ was renamed to ‘get_params_by_tag’.

classmethod get_typed_inputs(collection, 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:
Returns:

out_tagged_data (Array[PCGTaggedData]):

Return type:

Array[PCGTaggedData]

classmethod get_typed_inputs_by_pin(collection, 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]

classmethod get_typed_inputs_by_pin_label(collection, 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]

classmethod get_typed_inputs_by_tag(collection, 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]