unreal.PCGLoopSettings

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

Bases: PCGSubgraphSettings

PCGLoop Settings

C++ Source:

  • Plugin: PCG

  • Module: PCG

  • File: PCGLoopElement.h

Editor Properties: (see get_editor_property/set_editor_property)

  • break_debugger (bool): [Read-Write] If a debugger is attached, triggers a breakpoint inside IPCGElement::Execute(). Editor only. Transient.

  • category (Text): [Read-Write]

  • debug (bool): [Read-Write]

  • debug_settings (PCGDebugVisualizationSettings): [Read-Write]

  • description (Text): [Read-Write]

  • determinism_settings (PCGDeterminismSettings): [Read-Write]

  • enabled (bool): [Read-Write]

  • expose_to_library (bool): [Read-Write]

  • feedback_pins (str): [Read-Write] Comma-separated list of pin names that will act as feedback pins, namely that in a given iteration it will receive the data from the output pin of the same name of the previous loop iteration. These pins can have initial data, in which case only the first iteration will get this data.

  • loop_pins (str): [Read-Write] Comma-separated list of pin names on which we will loop by-element in a step-wise fashion; if more than one is provided, it is expected that they all have the same number of data. If none are provided, the first connected pin will taken as the pin to loop on.

  • seed (int32): [Read-Write]

  • subgraph_instance (PCGGraphInstance): [Read-Only]

  • subgraph_override (PCGGraphInterface): [Read-Write]

  • use_graph_default_pin_usage (bool): [Read-Write] Controls whether the pin usage (normal, loop, feedback) will be taken from the subgraph to execute or from the manually provided list.

  • use_seed (bool): [Read-Only] By default, settings won’t use a seed. Set this bool to true in the child ctor to allow edition and use it.

property feedback_pins: str

[Read-Write] Comma-separated list of pin names that will act as feedback pins, namely that in a given iteration it will receive the data from the output pin of the same name of the previous loop iteration. These pins can have initial data, in which case only the first iteration will get this data.

Type:

(str)

property loop_pins: str

[Read-Write] Comma-separated list of pin names on which we will loop by-element in a step-wise fashion; if more than one is provided, it is expected that they all have the same number of data. If none are provided, the first connected pin will taken as the pin to loop on.

Type:

(str)

property use_graph_default_pin_usage: bool

[Read-Write] Controls whether the pin usage (normal, loop, feedback) will be taken from the subgraph to execute or from the manually provided list.

Type:

(bool)