unreal.PCGDataFromActorSettings¶
- class unreal.PCGDataFromActorSettings(outer: Object | None = None, name: Name | str = 'None')¶
Bases:
PCGSettingsBuilds a collection of PCG-compatible data from the selected actors.
C++ Source:
Plugin: PCG
Module: PCG
File: PCGDataFromActor.h
Editor Properties: (see get_editor_property/set_editor_property)
actor_selector(PCGActorSelectorSettings): [Read-Write] Describes which actors to select for data collection.allowed_grids(int32): [Read-Write] Select which grid sizes to consider when collecting data from partitioned PCG components.also_output_single_point_data(bool): [Read-Write] Also produces a single point data at the actor location.break_debugger(bool): [Read-Write] If a debugger is attached, triggers a breakpoint inside IPCGElement::Execute(). Editor only. Transient.category(Text): [Read-Write]components_must_overlap_self(bool): [Read-Write] Only get data from components which overlap with the bounds of your source component.debug(bool): [Read-Write]debug_settings(PCGDebugVisualizationSettings): [Read-Write]description(Text): [Read-Write]determinism_settings(PCGDeterminismSettings): [Read-Write]enabled(bool): [Read-Write]expected_pins(Array[Name]): [Read-Write] Provide pin names to match against the found component output pins. Data will automatically be wired to the expected pin if the name comparison succeeds. All unmatched pins will go into the standard out pin.expose_to_library(bool): [Read-Write]get_data_on_all_grids(bool): [Read-Write] Get data from all grid sizes if there is a partitioned PCG component on the actor, instead of a specific set of grid sizes.merge_single_point_data(bool): [Read-Write] Merges all the single point data outputs into a single point data.mode(PCGGetDataFromActorMode): [Read-Write] Describes what kind of data we will collect from the found actor(s).property_name(Name): [Read-Write] The property name on the found actor to create a data collection from.seed(int32): [Read-Write]silence_sanitized_attribute_name_warnings(bool): [Read-Write] Silence warnings that attribute names were sanitized to replace invalid characters.track_actors_only_within_bounds(bool): [Read-Write] If this is checked, found actors that are outside component bounds will not trigger a refresh. Only works for tags for now in editor.use_seed(bool): [Read-Only] By default, settings won’t use a seed. Set this bool to true in the child ctor to allow edition and use it.
- property actor_selector: PCGActorSelectorSettings¶
[Read-Write] Describes which actors to select for data collection.
- Type:
- property allowed_grids: int¶
[Read-Write] Select which grid sizes to consider when collecting data from partitioned PCG components.
- Type:
(int32)
- property also_output_single_point_data: bool¶
[Read-Write] Also produces a single point data at the actor location.
- Type:
(bool)
- property components_must_overlap_self: bool¶
[Read-Write] Only get data from components which overlap with the bounds of your source component.
- Type:
(bool)
- property expected_pins: None¶
[Read-Write] Provide pin names to match against the found component output pins. Data will automatically be wired to the expected pin if the name comparison succeeds. All unmatched pins will go into the standard out pin.
- property get_data_on_all_grids: bool¶
[Read-Write] Get data from all grid sizes if there is a partitioned PCG component on the actor, instead of a specific set of grid sizes.
- Type:
(bool)
- property merge_single_point_data: bool¶
[Read-Write] Merges all the single point data outputs into a single point data.
- Type:
(bool)
- property mode: PCGGetDataFromActorMode¶
[Read-Write] Describes what kind of data we will collect from the found actor(s).
- Type:
- property property_name: Name¶
[Read-Write] The property name on the found actor to create a data collection from.
- Type:
(Name)