unreal.PCGGraph

class unreal.PCGGraph

Bases: PCGGraphInterface

C++ Source:

  • Plugin: PCG

  • Module: PCG

  • File: PCGGraph.h

Editor Properties: (see get_editor_property/set_editor_property)

  • auto_refresh_on_quality_settings_changed (bool): [Read-Write] Auto-refresh when engine scalability settings or the pcg.Quality CVar change. Disable for slow CPU-generated graphs that shouldn’t tear down on quality toggles.

  • auto_refresh_on_render_state_refresh (bool): [Read-Write] Auto-refresh on render-state events: viewport resize, component re-register, scene material change, preview platform change, fast-geo recreate. Disable for slow CPU-generated graphs that should survive incidental render-state churn.

  • category (Text): [Read-Write]

  • change_tracking_ignored_classes (Array[type(Class)]): [Read-Write]

  • color (LinearColor): [Read-Write] Override of the color for the subgraph node for this graph.

  • console_variables_triggering_refresh (Array[str]): [Read-Write] Console variable names that trigger a runtime PCG refresh of this graph when any of their values change. Disabled in shipping game builds.

  • debug_flag_applies_to_individual_components (bool): [Read-Write] When true the Debug flag in the graph editor will display debug information contextually for the selected debug object. Otherwise debug information is displayed for all components using a graph (requires regenerate).

  • description (Text): [Read-Write]

  • expose_to_library (bool): [Read-Write]

  • generation_radii (PCGRuntimeGenerationRadii): [Read-Write]

  • graph_customization (PCGGraphEditorCustomization): [Read-Write]

  • graph_usage_context (PCGGraphUsage): [Read-Write] Controls whether a graph can be executed outside of the context of a PCG actor/entity, e.g. run on for asset or level workflows.

  • has_default_constructed_inputs (bool): [Read-Write] Controls whether the default pins (In, …) are provided data on top-level graphs automatically. Note this will eventually change to be turned off by default.

  • hi_gen_grid_size (PCGHiGenGrid): [Read-Write]

  • hi_gen_grid_size_multiplier (double): [Read-Write] Scales the grid sizes allowing to use larger or smaller grids than those provided out of the box. Can be useful to align generation to other grids in the world.

  • ignore_landscape_tracking (bool): [Read-Write] Marks the graph to be not refreshed automatically when the landscape changes, even if it is used.

  • input_node (PCGNode): [Read-Write] Add input/output nodes

  • is_standalone_graph (bool): [Read-Write] deprecated: Deprecated in favor of GraphUsageContext

  • is_template (bool): [Read-Write]

  • landscape_uses_metadata (bool): [Read-Write]

  • nodes (Array[PCGNode]): [Read-Write]

  • output_node (PCGNode): [Read-Write]

  • override_color (bool): [Read-Write]

  • override_title (bool): [Read-Write]

  • should_cook (PerPlatformBool): [Read-Write] Controls whether this PCG graph is included when cooking for each platform. If disabled, the graph and all of its compiled data (compute graphs, kernel sources, pins, nodes, edges) will be stripped from cooked builds. Any PCG components or graph instances that reference this graph will also be excluded from cooking.

    Not exposed on embedded subgraphs: the cook decision is inherited from the parent graph.

  • title (Text): [Read-Write] Override of the title for the subgraph node for this graph.

  • tool_data (PCGGraphToolData): [Read-Write] Contains the data relevant for PCG Editor Mode usage.

  • use2d_grid (bool): [Read-Write]

  • use_actor_componentless_generation (bool): [Read-Write] [EXPERIMENTAL] Avoids creating partition actors and local PCG components. Any functionality which depends on a target actor/component are not supported in this mode.

  • use_hierarchical_generation (bool): [Read-Write]

  • user_parameters (InstancedPropertyBag): [Read-Write] Parameters

add_edge(from_, from_pin_label, to, to_pin_label) → PCGNode

Adds a directed edge in the graph. Returns the “To” node for easy chaining

Parameters:
Return type:

PCGNode

add_node_copy(settings) -> (PCGNode, default_node_settings=PCGSettings)

Creates a node and copies the input settings. Returns the created node.

Parameters:

settings (PCGSettings)

Returns:

default_node_settings (PCGSettings):

Return type:

PCGSettings

add_node_instance(settings) → PCGNode

Creates a node containing an instance to the given settings. Returns the created node.

Parameters:

settings (PCGSettings)

Return type:

PCGNode

add_node_of_type(settings_class) -> (PCGNode, default_node_settings=PCGSettings)

Creates a default node based on the settings class wanted. Returns the newly created node.

Parameters:

settings_class (type(Class))

Returns:

default_node_settings (PCGSettings):

Return type:

PCGSettings

property auto_refresh_on_quality_settings_changed: bool

[Read-Write] Auto-refresh when engine scalability settings or the pcg.Quality CVar change. Disable for slow CPU-generated graphs that shouldn’t tear down on quality toggles.

Type:

(bool)

property auto_refresh_on_render_state_refresh: bool

viewport resize, component re-register, scene material change, preview platform change, fast-geo recreate. Disable for slow CPU-generated graphs that should survive incidental render-state churn.

Type:

(bool)

Type:

[Read-Write] Auto-refresh on render-state events

property category: Text

[Read-Write]

Type:

(Text)

property console_variables_triggering_refresh: None

[Read-Write] Console variable names that trigger a runtime PCG refresh of this graph when any of their values change. Disabled in shipping game builds.

Type:

(Array[str])

property description: Text

[Read-Write]

Type:

(Text)

force_notification_for_editor(change_type=PCGChangeType.STRUCTURAL) → None

Force Notification for Editor

Parameters:

change_type (PCGChangeType)

property generation_radii: PCGRuntimeGenerationRadii

[Read-Write]

Type:

(PCGRuntimeGenerationRadii)

get_all_edges() → Array[PCGEdge]

Returns all the edges of the graph

Return type:

Array[PCGEdge]

get_input_node() → PCGNode

Returns the graph input node

Return type:

PCGNode

get_output_node() → PCGNode

Returns the graph output node

Return type:

PCGNode

property graph_usage_context: PCGGraphUsage

[Read-Write] Controls whether a graph can be executed outside of the context of a PCG actor/entity, e.g. run on for asset or level workflows.

Type:

(PCGGraphUsage)

property has_default_constructed_inputs: bool

[Read-Write] Controls whether the default pins (In, …) are provided data on top-level graphs automatically. Note this will eventually change to be turned off by default.

Type:

(bool)

property ignore_landscape_tracking: bool

[Read-Write] Marks the graph to be not refreshed automatically when the landscape changes, even if it is used.

Type:

(bool)

property input_node: PCGNode

[Read-Only] Add input/output nodes

Type:

(PCGNode)

property is_standalone_graph: bool

[Read-Write] deprecated: Deprecated in favor of GraphUsageContext

Type:

(bool)

property nodes: None

[Read-Only]

Type:

(Array[PCGNode])

property output_node: PCGNode

[Read-Only]

Type:

(PCGNode)

remove_edge(from_, from_label, to, to_label) → bool

Removes an edge in the graph. Returns true if an edge was removed.

Parameters:
Return type:

bool

remove_node(node) → None

Removes a node from the graph.

Parameters:

node (PCGNode)

remove_nodes() → Array[PCGNode]

Bulk removal of nodes, to avoid notifying the world everytime.

Returns:

nodes (Array[PCGNode]):

Return type:

Array[PCGNode]

property tool_data: PCGGraphToolData

[Read-Write] Contains the data relevant for PCG Editor Mode usage.

Type:

(PCGGraphToolData)

property use_actor_componentless_generation: bool

[Read-Write] [EXPERIMENTAL] Avoids creating partition actors and local PCG components. Any functionality which depends on a target actor/component are not supported in this mode.

Type:

(bool)