unreal.PCGBlueprintElement

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

Bases: Object

PCGBlueprint Element

C++ Source:

  • Plugin: PCG

  • Module: PCG

  • File: PCGExecuteBlueprint.h

Editor Properties: (see get_editor_property/set_editor_property)

  • cacheable (bool): [Read-Write] Not yet hooked up, currently work in progress. True if output data can be cached and reused if inputs do not change, false if blueprint should be executed every time.

  • can_be_multithreaded (bool): [Read-Write]

  • category (Text): [Read-Write]

  • creates_artifacts (bool): [Read-Write]

  • custom_input_pins (Array[PCGPinProperties]): [Read-Write]

  • custom_output_pins (Array[PCGPinProperties]): [Read-Write]

  • dependency_parsing_depth (int32): [Read-Write]

  • description (Text): [Read-Write]

  • expose_to_library (bool): [Read-Write]

  • has_default_in_pin (bool): [Read-Write]

  • has_default_out_pin (bool): [Read-Write]

  • input_pin_labels (Set[Name]): [Read-Write] deprecated: Property ‘InputPinLabels’ is deprecated.

  • output_pin_labels (Set[Name]): [Read-Write]

property cacheable: bool

[Read-Write] Not yet hooked up, currently work in progress. True if output data can be cached and reused if inputs do not change, false if blueprint should be executed every time.

Type:

(bool)

property can_be_multithreaded: bool

[Read-Write]

Type:

(bool)

property category: Text

[Read-Write]

Type:

(Text)

property creates_artifacts: bool

[Read-Write]

Type:

(bool)

property custom_input_pins: None

[Read-Write]

Type:

(Array[PCGPinProperties])

property custom_output_pins: None

[Read-Write]

Type:

(Array[PCGPinProperties])

property dependency_parsing_depth: int

[Read-Write]

Type:

(int32)

property description: Text

[Read-Write]

Type:

(Text)

execute(input) → PCGDataCollection

Execute

Parameters:

input (PCGDataCollection) –

Returns:

output (PCGDataCollection):

Return type:

PCGDataCollection

execute_with_context(context, input) -> (context=PCGContext, output=PCGDataCollection)

~End UObject interface

Parameters:
Returns:

context (PCGContext):

output (PCGDataCollection):

Return type:

tuple

property expose_to_library: bool

[Read-Write]

Type:

(bool)

get_random_stream(context) -> (RandomStream, context=PCGContext)

Creates a random stream from the settings & source component

Parameters:

context (PCGContext) –

Returns:

context (PCGContext):

Return type:

PCGContext

get_seed(context) -> (int32, context=PCGContext)

Gets the seed from the associated settings & source component

Parameters:

context (PCGContext) –

Returns:

context (PCGContext):

Return type:

PCGContext

property has_default_in_pin: bool

[Read-Write]

Type:

(bool)

property has_default_out_pin: bool

[Read-Write]

Type:

(bool)

input_labels() → Set[Name]

Input Labels

Return type:

Set[Name]

property input_pin_labels: None

[Read-Only] deprecated: Property ‘InputPinLabels’ is deprecated.

Type:

(Set[Name])

iteration_loop(context, num_iterations, optional_a=None, optional_b=None, optional_out_data=None) -> (context=PCGContext, out_data=PCGPointData)

Calls the IterationLoopBody a fixed number of times, optional parameters are used to potentially initialized the Out Data, but otherwise are used to remove the need to have variables

Parameters:
Returns:

context (PCGContext):

out_data (PCGPointData):

Return type:

tuple

iteration_loop_body(context, iteration, a, b, out_metadata) → PCGPoint or None

Iteration Loop Body

Parameters:
Returns:

out_point (PCGPoint):

Return type:

PCGPoint or None

loop_n_times(context: PCGContext, num_iterations: int, optional_a: PCGSpatialData = Ellipsis, optional_b: PCGSpatialData = Ellipsis, optional_out_data: PCGPointData = Ellipsis) → Tuple[PCGContext, PCGPointData]

deprecated: ‘loop_n_times’ was renamed to ‘iteration_loop’.

loop_on_point_pairs(context: PCGContext, outer_data: PCGPointData, inner_data: PCGPointData, optional_out_data: PCGPointData = Ellipsis) → Tuple[PCGContext, PCGPointData]

deprecated: ‘loop_on_point_pairs’ was renamed to ‘nested_loop’.

loop_on_points(context: PCGContext, data: PCGPointData, optional_out_data: PCGPointData = Ellipsis) → Tuple[PCGContext, PCGPointData]

deprecated: ‘loop_on_points’ was renamed to ‘point_loop’.

multi_loop_on_points(context: PCGContext, data: PCGPointData, optional_out_data: PCGPointData = Ellipsis) → Tuple[PCGContext, PCGPointData]

deprecated: ‘multi_loop_on_points’ was renamed to ‘variable_loop’.

multi_point_loop_body(context: PCGContext, data: PCGPointData, point: PCGPoint, out_metadata: PCGMetadata) → None

deprecated: ‘multi_point_loop_body’ was renamed to ‘variable_loop_body’.

nested_loop(context, outer_data, inner_data, optional_out_data=None) -> (context=PCGContext, out_data=PCGPointData)

Calls the NestedLoopBody function on all nested loop pairs (e.g. (o, i) for all o in Outer, i in Inner)

Parameters:
Returns:

context (PCGContext):

out_data (PCGPointData):

Return type:

tuple

nested_loop_body(context, outer_data, inner_data, outer_point, inner_point, out_metadata) → PCGPoint or None

Nested Loop Body

Parameters:
Returns:

out_point (PCGPoint):

Return type:

PCGPoint or None

node_color_override() → LinearColor

Node Color Override

Return type:

LinearColor

node_title_override() → Name

Override for the default node name

Return type:

Name

node_type_override() → PCGSettingsType

Node Type Override

Return type:

PCGSettingsType

output_labels() → Set[Name]

Output Labels

Return type:

Set[Name]

property output_pin_labels: None

[Read-Only]

Type:

(Set[Name])

point_loop(context, data, optional_out_data=None) -> (context=PCGContext, out_data=PCGPointData)

Calls the PointLoopBody function on all points

Parameters:
Returns:

context (PCGContext):

out_data (PCGPointData):

Return type:

tuple

point_loop_body(context, data, point, out_metadata) → PCGPoint or None

Point Loop Body

Parameters:
Returns:

out_point (PCGPoint):

Return type:

PCGPoint or None

point_pair_loop_body(context: PCGContext, outer_data: PCGPointData, inner_data: PCGPointData, outer_point: PCGPoint, inner_point: PCGPoint, out_metadata: PCGMetadata) → PCGPoint | None

deprecated: ‘point_pair_loop_body’ was renamed to ‘nested_loop_body’.

variable_loop(context, data, optional_out_data=None) -> (context=PCGContext, out_data=PCGPointData)

Calls the VariableLoopBody function on all points, each call can return a variable number of points

Parameters:
Returns:

context (PCGContext):

out_data (PCGPointData):

Return type:

tuple

variable_loop_body(context, data, point, out_metadata) → Array[PCGPoint]

Variable Loop Body

Parameters:
Return type:

Array[PCGPoint]