unreal.PCGRandomChoiceSettings

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

Bases: PCGSettings

Chooses entries randomly through ratio or a fixed number of entries. Chosen/Discarded entries will be in the same order than they appear in the input data.

C++ Source:

  • Plugin: PCG

  • Module: PCG

  • File: PCGRandomChoice.h

Editor Properties: (see get_editor_property/set_editor_property)

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

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

  • expose_to_library (bool): [Read-Write]

  • fixed_mode (bool): [Read-Write] Either choose a fixed number of entries, or a ratio of entries.

  • fixed_number (int32): [Read-Write] Defines the number of entries to keep.

  • output_discarded_entries (bool): [Read-Write] By default, we output discarded entries. If you don’t need them, disable this option.

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

  • ratio (float): [Read-Write] Defines the ratio of entries to keep.

  • seed (int32): [Read-Write]

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

property b_output_discarded_points: bool

‘b_output_discarded_points’ was renamed to ‘output_discarded_entries’.

Type:

deprecated

property fixed_mode: bool

[Read-Write] Either choose a fixed number of entries, or a ratio of entries.

Type:

(bool)

property fixed_number: int

[Read-Write] Defines the number of entries to keep.

Type:

(int32)

property output_discarded_entries: bool

[Read-Write] By default, we output discarded entries. If you don’t need them, disable this option.

Type:

(bool)

property ratio: float

[Read-Write] Defines the ratio of entries to keep.

Type:

(float)