unreal.PCGPrintElementSettings

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

Bases: PCGSettings

Issues a specified message to the log, and optionally to the graph and/or screen. Note: This node will not function in shipping builds.

C++ Source:

  • Plugin: PCG

  • Module: PCG

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

  • custom_prefix (str): [Read-Write] A prefix to which the core message will be appended.

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

  • display_on_node (bool): [Read-Write] Display warnings or errors on this node.

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

  • enable_print (bool): [Read-Write] Enable the functionality of this node. Disable to bypass printing.

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

  • prefix_with_component (bool): [Read-Write] Prefix the message with the name of the component.

  • prefix_with_graph (bool): [Read-Write] Prefix the message with the name of the graph.

  • prefix_with_node (bool): [Read-Write] Prefix the message with the name of the node.

  • prefix_with_owner (bool): [Read-Write] Prefix the message with the name of the component’s owner.

  • print_per_component (bool): [Read-Write] Use the component as part of the key hash and print a message for each component with this node.

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

  • print_string (str): [Read-Write] The core message to print to the logger, graph, and/or screen.

  • print_to_screen (bool): [Read-Write] Print the message to the editor viewport.

  • print_to_screen_color (Color): [Read-Write] The color of the on screen message.

  • print_to_screen_duration (double): [Read-Write] The duration (in seconds) of the on screen message.

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

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

  • verbosity (PCGPrintVerbosity): [Read-Write] The verbosity level of the printed message.

property custom_prefix: str

[Read-Write] A prefix to which the core message will be appended.

Type:

(str)

property display_on_node: bool

[Read-Write] Display warnings or errors on this node.

Type:

(bool)

property enable_print: bool

[Read-Write] Enable the functionality of this node. Disable to bypass printing.

Type:

(bool)

property prefix_with_component: bool

[Read-Write] Prefix the message with the name of the component.

Type:

(bool)

property prefix_with_graph: bool

[Read-Write] Prefix the message with the name of the graph.

Type:

(bool)

property prefix_with_node: bool

[Read-Write] Prefix the message with the name of the node.

Type:

(bool)

property prefix_with_owner: bool

[Read-Write] Prefix the message with the name of the component’s owner.

Type:

(bool)

property print_per_component: bool

[Read-Write] Use the component as part of the key hash and print a message for each component with this node.

Type:

(bool)

property print_string: str

[Read-Write] The core message to print to the logger, graph, and/or screen.

Type:

(str)

property print_to_screen: bool

[Read-Write] Print the message to the editor viewport.

Type:

(bool)

property print_to_screen_color: Color

[Read-Write] The color of the on screen message.

Type:

(Color)

property print_to_screen_duration: float

[Read-Write] The duration (in seconds) of the on screen message.

Type:

(double)

property verbosity: PCGPrintVerbosity

[Read-Write] The verbosity level of the printed message.

Type:

(PCGPrintVerbosity)