`unreal.PCGSelectGrammarSettings`¶

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

Bases: PCGSettings

Select a grammar by comparing an input attribute against a provided set criteria one-by-one in a sequential order.

C++ Source:

Plugin: PCG
Module: PCG
File: PCGSelectGrammar.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]
compared_value_attribute (PCGAttributePropertyInputSelector): [Read-Write] The attribute on the input data to be compared against. Will be numerically evaluated.
copy_key_for_unselected_grammar (bool): [Read-Write] If no grammar is selected for a given point, pass through the key value.
criteria (Array[PCGSelectGrammarCriterion]): [Read-Write] Selection criteria that will be evaluated in order.
criteria_as_input (bool): [Read-Write] Toggle for an additional input “Selection Criteria Data” which accepts criteria info as an attribute set matching the structure type ‘FPCGSelectGrammarCriteria’.
criteria_attribute_names (PCGSelectGrammarCriteriaAttributeNames): [Read-Write] The attribute names expected for the comparison criteria.
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]
key (Name): [Read-Write] An attribute key that represents the desired set of grammars.
key_as_attribute (bool): [Read-Write] Select the key with an attribute.
key_attribute (PCGAttributePropertyInputSelector): [Read-Write] An attribute selector for a key that represents the desired set of grammars.
output_grammar_attribute (PCGAttributePropertyOutputSelector): [Read-Write] The attribute to output the selected grammar.
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.
remap_criteria_attribute_names (bool): [Read-Write] Remap expected attribute names for the comparison criteria.
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.

property compared_value_attribute: PCGAttributePropertyInputSelector¶

[Read-Write] The attribute on the input data to be compared against. Will be numerically evaluated.

Type:: (PCGAttributePropertyInputSelector)

property copy_key_for_unselected_grammar: bool¶

[Read-Write] If no grammar is selected for a given point, pass through the key value.

Type:: (bool)

property criteria: None¶

[Read-Write] Selection criteria that will be evaluated in order.

Type:: (Array[PCGSelectGrammarCriterion])

property criteria_as_input: bool¶

[Read-Write] Toggle for an additional input “Selection Criteria Data” which accepts criteria info as an attribute set matching the structure type ‘FPCGSelectGrammarCriteria’.