unreal.PCGProjectionSpawnerSettings

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

Bases: PCGSettings

Class that defines a PCG node for adding mesh projection modifier instances to a megamesh.

C++ Source:

  • Plugin: PCGMeshPartitionInterop

  • Module: PCGMeshPartitionInterop

  • File: PCGMeshPartitionProjectionSpawner.h

Editor Properties: (see get_editor_property/set_editor_property)

  • affected_mega_mesh (MeshPartition): [Read-Write]

  • blend_mode (ProjectModifierBlendMode): [Read-Write]

  • 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_mesh_transforms_attribute (str): [Read-Write] By default, the mesh transforms are the same as the projection transform being used. However, the attribute with

    this name can be added to data in the InProjections pin to make meshes have a different transform from the projection. This allows for projecting in a direction that does not match the mesh Z axis, but could result in a projection missing the mesh entirely if the projection bounds don’t intersect the mesh at that location.

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

  • height_falloff (ProjectModifierFalloffSettings): [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.

  • priority (double): [Read-Write]

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

  • type (Name): [Read-Write]

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

  • weight_channels (Array[ProjectModifierWeightEntry]): [Read-Write]