unreal.PCGSwitchSettings

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

Bases: PCGControlFlowSettings

Routes data from the input pin, to a specific output pin based on a selection criteria (Int/String/Enum)

C++ Source:

  • Plugin: PCG

  • Module: PCG

  • File: PCGSwitch.h

Editor Properties: (see get_editor_property/set_editor_property)

  • break_debugger (bool): [Read-Write] If a debugger is attached, a breakpoint will be triggered in the execution code to enable debugging. Only applies when inspecting a debug object. Transient and Editor-only.

  • category (Text): [Read-Write]

  • debug (bool): [Read-Write]

  • debug_buffer_size (int32): [Read-Write] Size (in number of floats) of the shader debug print buffer.

  • debug_settings (PCGDebugVisualizationSettings): [Read-Write]

  • description (Text): [Read-Write]

  • determinism_settings (PCGDeterminismSettings): [Read-Write]

  • dump_cooked_hlsl (bool): [Read-Write] Dump the cooked HLSL into the log after it is generated.

  • dump_data_descriptions (bool): [Read-Write] Dump the data descriptions of input/output pins to the log.

  • enabled (bool): [Read-Write]

  • enum_selection (EnumSelector): [Read-Write] Determines which output pin will be selected if the selection mode is Enum.

  • execute_on_gpu (bool): [Read-Write] Whether this node should be executed on the GPU.

  • execution_dependency_required (bool): [Read-Write] If enabled, the execution dependency pin will require to be connected for execution (as any other required pin) and will be used for culling.

  • expose_to_library (bool): [Read-Write]

  • int_options (Array[int32]): [Read-Write] Determines the available output pin selection options.

  • integer_selection (int32): [Read-Write] Determines which output will be selected if the selection mode is Integer.

  • print_shader_debug_values (bool): [Read-Write] Enable use of ‘WriteDebugValue(uint Index, float Value)’ function in your kernel. Allows you to write float values to a buffer for logging on the CPU.

  • profile_kernel_index (int32): [Read-Write] Index of kernel emitted by this node to repeatedly dispatch every frame to enable profiling. Set to -1 to disable profiling. PCG_GPU_KERNEL_PROFILING must be defined in PCG.Build.cs.

  • seed (int32): [Read-Write]

  • selection_mode (PCGControlFlowSelectionMode): [Read-Write] Determines the type of value to be used to select an output.

  • string_options (Array[str]): [Read-Write] Determines the available output pin selection options.

  • string_selection (str): [Read-Write] Determines which output will be selected if the selection mode is String.

  • trigger_render_capture (bool): [Read-Write] Will trigger a render capture when this node executes and a debug object is selected in the graph editor. Transient and Editor-only. Render captures must be enabled (e.g. -AttachRenderDoc or -AttachPIX).

  • use_seed (bool): [Read-Write] deprecated: Implement the PCGSettings virtual UseSeed() override.

property enum_selection: EnumSelector

[Read-Write] Determines which output pin will be selected if the selection mode is Enum.

Type:

(EnumSelector)

property int_options: None

[Read-Write] Determines the available output pin selection options.

Type:

(Array[int32])

property integer_selection: int

[Read-Write] Determines which output will be selected if the selection mode is Integer.

Type:

(int32)

property selection_mode: PCGControlFlowSelectionMode

[Read-Write] Determines the type of value to be used to select an output.

Type:

(PCGControlFlowSelectionMode)

property string_options: None

[Read-Write] Determines the available output pin selection options.

Type:

(Array[str])

property string_selection: str

[Read-Write] Determines which output will be selected if the selection mode is String.

Type:

(str)