unreal.PCGGenericUserParameterGetSettings

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

Bases: PCGSettings

Generic getter for user parameter defined in the PCG Graph, by the user. Will pick up the value from the graph instance. This getter allows to set manually the user parameter they want to get, and add extractor, the same way than GetActorProperty or GetPropertyFromObjectPath

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]

  • 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] If the property is a struct/object supported by metadata, this option can be toggled to force extracting all (compatible) properties contained in this property. Automatically true if unsupported by metadata. For now, only supports direct child properties (and not deeper).

  • output_attribute_name (Name): [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.

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

  • property_path (str): [Read-Write]

  • quiet (bool): [Read-Write]

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

  • seed (int32): [Read-Write]

  • source (PCGUserParameterSource): [Read-Write]

  • 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 force_object_and_struct_extraction: bool

[Read-Write] If the property is a struct/object supported by metadata, this option can be toggled to force extracting all (compatible) properties contained in this property. Automatically true if unsupported by metadata. For now, only supports direct child properties (and not deeper).

Type:

(bool)

property output_attribute_name: Name

[Read-Write]

Type:

(Name)

property property_path: str

[Read-Write]

Type:

(str)

property quiet: bool

[Read-Write]

Type:

(bool)

property sanitize_output_attribute_name: bool

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

Type:

(bool)

property source: PCGUserParameterSource

[Read-Write]

Type:

(PCGUserParameterSource)