unreal.PCGSettings

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

Bases: PCGSettingsInterface

Base class for settings-as-data in the PCG framework

C++ Source:

  • Plugin: PCG

  • Module: PCG

  • File: PCGSettings.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_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]

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

  • expose_to_library (bool): [Read-Write]

  • 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.

  • seed (int32): [Read-Write]

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

bp_get_type_union_of_incident_edges(pin_label) → int32

Bitwise union of the allowed types of each incident edge on pin. Returns None type if no common bits, or no edges. Use the BP function helpers to extract the types from the result.

Parameters:

pin_label (Name)

Return type:

int32

property category: Text

[Read-Write]

Type:

(Text)

property description: Text

[Read-Write]

Type:

(Text)

property determinism_settings: PCGDeterminismSettings

[Read-Write]

Type:

(PCGDeterminismSettings)

property expose_to_library: bool

[Read-Write]

Type:

(bool)

property seed: int

[Read-Write]

Type:

(int32)

property use_seed: bool

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

Type:

(bool)