unreal.PCGUserParameterGetSettings

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

Bases: PCGSettings

Getter for user parameters defined in PCGGraph, by the user. Will pick up the value from the graph instance.

C++ Source:

  • Plugin: PCG

  • Module: PCG

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

  • container_extractor_behavior (PCGContainerExtractorBehavior): [Read-Write] How we should extract the containers. (cf. enum tooltips)

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

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

  • force_object_and_struct_extraction (bool): [Read-Write] deprecated: Use the different extractor behavior options

  • object_extractor_behavior (PCGObjectExtractorBehavior): [Read-Write] How we should extract the objects. (cf. enum tooltips)

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

  • sanitize_output_attribute_name (bool): [Read-Write] If the output attribute name has special characters, remove them.

  • seed (int32): [Read-Write]

  • struct_extractor_behavior (PCGStructExtractorBehavior): [Read-Write] How we should extract the structs. (cf. enum tooltips)

  • 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 container_extractor_behavior: PCGContainerExtractorBehavior

[Read-Write] How we should extract the containers. (cf. enum tooltips)

Type:

(PCGContainerExtractorBehavior)

property force_object_and_struct_extraction: bool

[Read-Write] deprecated: Use the different extractor behavior options

Type:

(bool)

property object_extractor_behavior: PCGObjectExtractorBehavior

[Read-Write] How we should extract the objects. (cf. enum tooltips)

Type:

(PCGObjectExtractorBehavior)

property sanitize_output_attribute_name: bool

[Read-Write] If the output attribute name has special characters, remove them.

Type:

(bool)

property struct_extractor_behavior: PCGStructExtractorBehavior

[Read-Write] How we should extract the structs. (cf. enum tooltips)

Type:

(PCGStructExtractorBehavior)