unreal.PCGRandomChoiceSettings¶
- class unreal.PCGRandomChoiceSettings(outer: Object | None = None, name: Name | str = 'None')¶
Bases:
PCGSettingsChooses 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, 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_seed_source(PCGAttributePropertyInputSelector): [Read-Write] Attribute to generate the selection seed from.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]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.has_custom_seed_source(bool): [Read-Write] Use an attribute as a source for generating the seed, i.e. similar to or replacing the $Seed property on points. Mostly useful for attribute sets as points have this unique seed by default.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.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.ratio(float): [Read-Write] Defines the ratio of entries to keep.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_first_attribute_only(bool): [Read-Write] Controls whether only the first element’s attribute will be used to generate the selection seed. Otherwise, all values will be used to compute it.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 custom_seed_source: PCGAttributePropertyInputSelector¶
[Read-Write] Attribute to generate the selection seed from.
- property fixed_mode: bool¶
[Read-Write] Either choose a fixed number of entries, or a ratio of entries.
- Type:
(bool)
- property has_custom_seed_source: bool¶
[Read-Write] Use an attribute as a source for generating the seed, i.e. similar to or replacing the $Seed property on points. Mostly useful for attribute sets as points have this unique seed by default.
- Type:
(bool)