unreal.PCGVisualizeAttributeSettings

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

Bases: PCGSettings

Visualizes a selected attribute on screen at each point’s transform.

C++ Source:

  • Plugin: PCG

  • Module: PCG

  • File: PCGVisualizeAttribute.h

Editor Properties: (see get_editor_property/set_editor_property)

  • attribute_source (PCGAttributePropertyInputSelector): [Read-Write] This attribute will be have it’s value printed in proximity to each input point’s transform.

  • break_debugger (bool): [Read-Write] If a debugger is attached, triggers a breakpoint inside IPCGElement::Execute(). Editor only. Transient.

  • category (Text): [Read-Write]

  • color (Color): [Read-Write] The color of the on displayed value.

  • custom_prefix_string (str): [Read-Write] A custom added prefix to which the attribute value 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]

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

  • duration (double): [Read-Write] The duration (in seconds) of the displayed value.

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

  • local_offset (Vector): [Read-Write] A local offset from the point’s location to draw the text.

  • point_limit (int32): [Read-Write] The limit of points to draw debug messages.

  • prefix_with_attribute_name (bool): [Read-Write] Prefix the printed value with the attribute’s name.

  • prefix_with_index (bool): [Read-Write] Prefix the printed value with the point’s index.

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

  • visualize_enabled (bool): [Read-Write] The visualizer is enabled. Useful for dynamically overriding.

property attribute_source: PCGAttributePropertyInputSelector

[Read-Write] This attribute will be have it’s value printed in proximity to each input point’s transform.

Type:

(PCGAttributePropertyInputSelector)

property color: Color

[Read-Write] The color of the on displayed value.

Type:

(Color)

property custom_prefix_string: str

[Read-Write] A custom added prefix to which the attribute value will be appended.

Type:

(str)

property duration: float

[Read-Write] The duration (in seconds) of the displayed value.

Type:

(double)

property local_offset: Vector

[Read-Write] A local offset from the point’s location to draw the text.

Type:

(Vector)

property point_limit: int

[Read-Write] The limit of points to draw debug messages.

Type:

(int32)

property prefix_with_attribute_name: bool

[Read-Write] Prefix the printed value with the attribute’s name.

Type:

(bool)

property prefix_with_index: bool

[Read-Write] Prefix the printed value with the point’s index.

Type:

(bool)

property visualize_enabled: bool

[Read-Write] The visualizer is enabled. Useful for dynamically overriding.

Type:

(bool)