Skip to main content

pcg kit

235 tools. Generated from the plugin source; do not edit by hand.

Guide​

The pcg kit creates native PCG graph assets, builds them node by node or from ready-made recipes, configures node settings with typed tools, attaches graphs to actors through a UPCGComponent and drives generation. It needs Unreal Engine 5.2 or newer with the PCG plugin enabled. UE 4.27 has no PCG, so every pcg.* tool is hidden there. Some nodes only exist in newer engines; each tool carries its own minEngine (and maxEngine for removed nodes), so a tool that is listed in tools/list works on the running engine.

Fastest path: recipes​

Every recipe creates a new graph asset (folder + name), wires it end to end and returns the asset, every node it added (name, class, title, pins) and every edge. Titles are stable references for later edits ({'node':'Sampler'}). A recipe never places anything in the level: attach the graph afterwards (see "Attach and generate").

recipegraphengine
pcg.create_scatter_on_surface_graphLandscape -> Sampler (Surface Sampler) -> Transform (random yaw, uniform scale range) -> Spawner (weighted meshes) -> Output5.2+
pcg.create_forest_graphLandscape -> Sampler -> Difference (Source) minus Exclusions (Get Actor Data, actors tagged exclusionTag, on Differences) -> Pruning (Self Pruning) -> Transform -> Spawner -> Output5.2+
pcg.create_spline_fence_graphSplines (Get Spline Data, actors tagged splineTag) -> Sampler (Spline Sampler, Distance mode, one point every spacing cm) -> Spawner (mesh) -> Output5.2+
pcg.create_prop_grid_graphGrid (Create Points Grid, local to the component) -> Transform (XY jitter, random yaw) -> Spawner (weighted meshes) -> Output5.4+
pcg.create_points_from_actors_graphActors (Get Actor Data, every world actor tagged actorTag, one point each) -> Transform (offset) -> Spawner (mesh) -> Output5.2+
pcg.create_density_biome_graphLandscape -> Sampler -> Noise (density noise 0..1) -> per mesh i: Band<i> (Density Filter [i/n, (i+1)/n]) -> Spawner<i> -> Output5.2+

pcg.create_grid_scatter_graph (UE 5.4+, single mesh, nodes Grid/Transform/Spawner) is the minimal fixture-style recipe. The landscape recipes need a landscape inside the PCG component's bounds when generating; the tag-driven recipes read actors that carry the tag (actor.add_tag). Meshes are validated before the asset is created, so a bad mesh path never leaves a half graph.

Building a graph node by node​

  1. pcg.create makes an empty graph (direct UPCGGraph creation; the PCG editor factory is a private engine class and is not used).
  2. Add nodes with typed adders pcg.add_*. Each adder creates exactly one public settings class, chosen by engine version at compile time; the reply's node.class is the class actually created. Pass title so later calls can use it as the node reference.
  3. pcg.list_pins gives exact pin labels; connect them with pcg.connect. Common labels: In / Out, Surface Sampler input Surface, Spline Sampler input Spline, Difference inputs Source and Differences. The graph output node is $output (its input pin is Out), the input node $input.
  4. Configure nodes with the typed setters below, or with pcg.set_node_setting for any other reflected property.

Node references everywhere accept the node object name (from pcg.list_nodes) or its authored title; a title shared by several nodes is an error, never a guess.

Typed adders​

Sources and samplers: add_create_points (5.4+), add_create_points_grid (5.4+), add_get_actor_data, add_get_landscape, add_get_spline, add_get_volume, add_get_primitive, add_surface_sampler, add_spline_sampler, add_volume_sampler, add_texture_sampler, add_create_spline, add_world_query, add_world_ray_hit.

Point and density operations: add_transform_points, add_bounds_modifier, add_point_extents_modifier, add_bounds_from_mesh (5.5+), add_density_filter, add_density_noise (Attribute Noise from 5.3), add_density_remap, add_linear_density_remap (5.2-5.4 only), add_normal_to_density, add_distance, add_self_pruning, add_point_neighborhood (5.4+), add_spatial_noise (5.3+), add_sort_points (Sort Attributes, 5.4+), add_point_sampler (Select Points from 5.3), add_point_filter, add_point_match_and_set, add_copy_points, add_projection.

Spatial set operations: add_difference, add_union, add_intersection, add_merge, add_collapse.

Attributes and metadata: add_create_attribute, add_create_attribute_set, add_attribute_filter, add_attribute_select, add_attribute_reduce, add_attribute_transfer, add_attribute_get_from_point_index, add_property_to_param_data, add_metadata_* (maths, boolean, bitwise, compare, trig, vector, rotator, transform, make/break vector and transform, partition, rename), add_user_parameter_get.

Tags and control flow: add_add_tags (5.4+), add_delete_tags (5.4+), add_filter_by_tag, add_subgraph, add_loop (5.3+), add_branch (5.3+), add_switch (5.4+), add_reroute, add_debug.

Output: add_static_mesh_spawner, add_spawn_actor.

Where PCG renamed a node, the adder creates the current class: from 5.3 add_create_attribute -> PCGAddAttributeSettings, add_density_noise -> PCGAttributeNoiseSettings, add_intersection -> PCGInnerIntersectionSettings, add_point_sampler -> PCGSelectPointsSettings; from 5.4 add_attribute_filter -> PCGDeleteAttributesSettings, add_point_filter -> PCGAttributeFilteringSettings, add_property_to_param_data -> PCGGetActorPropertySettings. add_density_remap and add_attribute_transfer create classes PCG deprecated in 5.5 (still functional).

Typed setters​

Each setter targets one node kind, checks the node's class (a wrong node answers E_INVALID_ARG naming the adder to use) and writes only the fields you pass: empty text, negative numbers, all-zero vectors and set* flags left false keep the current value; booleans are passed as "true" / "false" text so they can be omitted. Enum fields take the enumerator name; an unknown name answers E_INVALID_ARG listing the valid names for the running engine. The reply returns the node (with refreshed pins) and every written property as UE text in values. A call that writes nothing is an error.

toolnodefields
pcg.set_surface_samplerSurface SamplerpointsPerSquaredMeter, pointExtents, looseness, pointSteepness, unbounded, applyDensityToPoints
pcg.set_transform_pointsTransform PointssetOffset + offsetMin/Max, setRotation + rotationMin/Max (pitch, yaw, roll), setScale + scaleMin/Max, uniformScale, absoluteOffset/Rotation/Scale
pcg.set_mesh_spawner_meshesStatic Mesh Spawnerreplaces the weighted entries: meshes, optional weights (one per mesh)
pcg.set_density_filterDensity FilterlowerBound, upperBound, invertFilter
pcg.set_self_pruningSelf PruningpruningType, radiusSimilarityFactor, randomizedPruning
pcg.set_bounds_modifierBounds Modifiermode, setBounds + boundsMin/Max, affectSteepness, steepness
pcg.set_distanceDistancemaximumDistance, setDensity, outputDistanceVector, sourceShape, targetShape
pcg.set_spline_samplerSpline Samplermode (Subdivision/Distance/NumberOfSamples), dimension, fill, subdivisionsPerSegment, distanceIncrement, interiorSampleSpacing, projectOntoSurface
pcg.set_actor_selectorGet Actor Data and the Get Spline/Landscape/Volume/Primitive gettersactorFilter (Self, Parent, Root, AllWorldActors...), actorSelection (ByTag, ByClass), tag, actorClass, selectMultiple, includeChildren, mustOverlapSelf, mode (ParseActorComponents, GetSinglePoint...)
pcg.set_create_points_grid (5.4+)Create Points GridgridExtents, cellSize, pointSteepness (5.5+), coordinateSpace, pointPosition, setPointsBounds, cullPointsOutsideVolume
pcg.set_create_points (5.4+)Create Pointsreplaces the point list: points, extents, density, coordinateSpace
pcg.set_subgraphSubgraph or Loopsubgraph (another graph; the owning graph is refused)
pcg.set_add_tags / pcg.set_delete_tags (5.4+)Add Tags / Delete Tagstags (list), operation for delete
pcg.set_density_noisenode from add_density_noisemode, setRange + noiseMin/Max, invertSource
pcg.set_normal_to_densityNormal To Densitynormal, setOffset + offset, strength, densityMode
pcg.set_differenceDifferencedensityFunction, mode, diffMetadata

Two generic helpers complete them:

  • pcg.set_attribute_selector {graph, node, property, selector} writes any attribute/property selector setting (InputSource, OutputTarget, Parameters.ComparisonSource...). The selector text is an attribute name, a point property such as $Density or $Position.Z, or @Last. Non-selector properties are refused.
  • pcg.reset_node_setting {graph, node, property} restores one editable setting (dotted paths such as SamplerParams.Mode are allowed) to the settings-class default and returns the value.

Finding and batch operations​

  • pcg.find_graphs_using_mesh {mesh, folder} scans the PCG graphs under folder (default /Game) and lists the nodes whose settings reference the asset, including spawner selector entries. It loads the graphs, so it also sees unsaved graphs.
  • pcg.find_graphs_using_subgraph {subgraph, folder} lists Subgraph/Loop nodes running a graph.
  • pcg.find_graphs_using_node_class {class, folder} lists nodes of a settings class or subclass (/Script/PCG.PCGSurfaceSamplerSettings, as shown in node.class).
  • pcg.find_components_using_graph {graph} lists the editor-world components using a graph.
  • pcg.batch_regenerate {graphs, force, dryRun} calls GenerateLocal on every editor-world PCG component whose graph is listed (empty list: every component with a graph). items holds one entry per component (scheduled, wouldRegenerate with dryRun, or failed with the reason, e.g. already generating) and one failed entry per listed graph that was not found or that no component uses. It only schedules work: poll pcg.wait_generation per actor afterwards.
  • Graph review: pcg.get_graph_*, pcg.list_* and pcg.audit_* inspect nodes, pins, edges and settings (source, sink, orphan, connected, unconnected, metadata, spawner, sampler, filter, actor-data, debug, parameter, spatial, point, placed and unplaced nodes).

Graph editing, parameters and instances​

Graph editing (UE 5.2+ unless noted)​

  • Node references: object name from pcg.list_nodes, a unique title, or $input/$output.
  • Every node reply carries pin schema (allowedTypes, allowMultipleConnections/Data, required/advanced on 5.4+, edgeCount). Edge identity is "From:FromPin->To:ToPin" (node object names).
  • pcg.connect / pcg.connect_many reply edges (created), replaced (edges PCG dropped because the destination pin takes one connection) and pins. connect_many validates every edge first.
  • pcg.disconnect_node {node, pin?, direction: inputs|outputs|both}; pcg.remove_nodes {nodes:[...]}.
  • pcg.duplicate_node copies settings, not edges. pcg.arrange_nodes lays nodes out by dependency depth.
  • Settings: pcg.get_node_settings {onlyNonDefault} lists paths/types/values; pcg.set_node_settings {settings:[{key,value}]} applies to a scratch copy first (all-or-nothing). Paths enter structs and instanced sub-objects: MeshSelectorParameters.MeshEntries. Values are UE text (FText as plain text).
  • pcg.set_node_enabled (refused for nodes that cannot be disabled), pcg.set_node_debug (transient), pcg.set_node_comment. Comment boxes (UE 5.6+): list/add (optionally around nodes)/update/remove; id = GUID or the exact comment text when unique.
  • pcg.get_node_class_info {class} shows default pins and settings before adding a node.
  • pcg.validate reports NULL_SETTINGS, INVALID_EDGE, REQUIRED_PIN_UNCONNECTED (5.4+), UNKNOWN_PARAMETER, ORPHAN_NODE, DISABLED_NODE, OUTPUT_UNCONNECTED (5.3+).
  • pcg.get/set_graph_settings keys: landscapeUsesMetadata, exposeToLibrary, category, description (5.2), hierarchicalGeneration, hiGenGridSize (5.3), use2DGrid, ignoreLandscapeTracking (5.5), hasDefaultConstructedInputs (5.7), hiGenGridSizeMultiplier, graphUsage (5.8).
  • pcg.export_graph (5.3) returns a typed document (graphSettings, parameters, nodes with non-default settings, edges; optional file = absolute .json). pcg.import_graph (5.5) recreates it as a new asset from document or file; everything is validated before the asset exists.
  • pcg.list_available_subgraphs (5.4) lists graphs/instances usable as subgraphs, excluding cycles.

Parameters and instances​

  • add_parameter (5.3): types bool, byte, int32, int64, float, double, name, string, text, vector, vector2d, rotator, transform, color, enum/struct (typeObject path), object/softobject/class/softclass (typeObject = base class); container none|array (5.3) | set (5.5); value needs 5.5.
  • set_parameter / remove_parameter (5.5; remove refuses while Get Graph Parameter nodes read it unless force), rename_parameter (5.6). list/get_parameter accept a graph or an instance.
  • Instances: pcg.create_instance {graph, folder, name} (5.2), pcg.set_instance_graph (5.4, no cycles), pcg.list_instance_overrides (overridden, value, parentValue), set/clear_instance_override (5.4).
  • Per component: pcg.list_component_parameters, set/clear_component_parameter_override (5.4).

Attach and generate​

pcg.add_volume {graph, name} spawns a PCG volume with a component; pcg.add_component {actor, graph, seed} attaches a component to an existing actor; pcg.generate schedules generation; poll pcg.wait_generation {actor, maxFrames} in separate requests until it reports idle (a frame limit is an error, never success); pcg.get_component shows the graph, seed, state and output data count; pcg.cleanup removes generated resources (asynchronous too).

Runtime (asynchronous generation)​

  • pcg.generate, pcg.generate_all {graph?}, pcg.refresh (5.4) only schedule work and return at once.
  • Direct-call scenario: pcg.generate, then pcg.wait_generation {maxFrames} as a separate request (it lets editor frames pass and fails on timeout; never inside edit.call_many/self-test), then read.
  • pcg.count_generated_instances / pcg.get_generated_resources (5.6) read the last finished generation (bGenerating=true means counts are stale). Partitioned components keep resources on local components.
  • pcg.inspect_node_output (5.8): node '$output' reads the graph output directly. For any other node: pcg.set_component_inspection {enabled:true}, pcg.generate {force:true}, pcg.wait_generation, then inspect (per pin: data class, point count, bounds, attributes, tags; executed=false = not run yet).
  • Empty component is accepted only when the actor has exactly one PCG component.

Engine differences​

  • UE 4.27: no PCG; all tools hidden.
  • 5.2: first supported version. add_density_noise creates PCGDensityNoiseSettings; Loop, Branch, Spatial Noise, Create Points (Grid), tags and Switch nodes do not exist yet.
  • 5.3: Loop, Branch, Spatial Noise; several renamed classes (see above).
  • 5.4: Create Points, Create Points Grid, Add/Delete Tags, Switch, Sort Attributes, Point Neighborhood; Self Pruning settings move into a Parameters struct (handled internally).
  • 5.5: Bounds From Mesh, pointSteepness on Create Points Grid; Linear Density Remap removed.

Generation is asynchronous everywhere: pcg.generate, pcg.cleanup, pcg.batch_regenerate only schedule work, and waiting must happen in separate requests so editor frames can pass.

Tools​

Legend. risk 0 = read-only, 1 = harmless editor op, 2 = modifies asset, 3 = deletes/replaces asset, 4 = project/config/build op, 5 = potentially destructive (calls above MaxAutoRisk need "_confirm": true). mutates = runs in a transaction (edit.undo reverts). requires PIE / requires world = refused without a PIE session / an open level. requires plugin = unavailable while the plugin is disabled. dryRun = honours the dryRun argument. smoke = covered by edit.self_test.

pcg.add_add_tags (risk 2, mutates, UE 5.4+, requires plugin PCG, smoke)​

Adds an Add Tags node (PCGAddTagSettings, UE 5.4+); list the tags with pcg.set_add_tags.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_attribute_filter (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Adds the attribute filter settings node.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_attribute_get_from_point_index (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Adds the attribute get from point index settings node.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_attribute_reduce (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Adds the attribute reduce settings node.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_attribute_select (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Adds the attribute select settings node.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_attribute_transfer (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Adds the attribute transfer settings node.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_bounds_from_mesh (risk 2, mutates, UE 5.5+, requires plugin PCG, smoke)​

Adds a Bounds From Mesh node (PCGBoundsFromMeshSettings, UE 5.5+): sets point bounds from a mesh.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_bounds_modifier (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Adds the bounds modifier settings node.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_branch (risk 2, mutates, UE 5.3+, requires plugin PCG, smoke)​

Adds a Branch node (PCGBranchSettings, UE 5.3+): routes the input to output A or B by a bool (overridable).

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_collapse (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Adds the collapse settings node.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_comment_box (risk 2, mutates, UE 5.6+, requires plugin PCG, smoke)​

Adds a comment box, optionally sized around given nodes; replies its GUID. UE 5.6+.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
commentstringrequired. Comment text.
nodesarray of stringOptional nodes to enclose; when set, the box geometry is computed around them (padding 60) and x/y/width/height are ignored.
xintegerDefault 0.
yintegerDefault 0.
widthintegerBox width. Default 400.
heightintegerBox height. Default 100.
fontSizeintegerFont size. Default 18.
color{x,y,z}RGB color 0..1. Default FUeaVec3(1,1,1).

Returns: box, boxes, count.

pcg.add_component (risk 2, mutates, UE 5.2+, requires plugin PCG, requires world, smoke)​

No description.

ArgumentTypeDescription
actorstringrequired. Actor label, object name, or path.
graphstringrequired. PCG graph asset path.
namestringOptional component name.
seedintegerDeterministic PCG seed. Default 42.

Returns: component, message.

pcg.add_copy_points (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Adds the copy points settings node.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_create_attribute (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Adds the create attribute settings node.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_create_attribute_set (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Adds the create attribute set settings node.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_create_points (risk 2, mutates, UE 5.4+, requires plugin PCG, smoke)​

Adds a Create Points node (PCGCreatePointsSettings, UE 5.4+); fill it with pcg.set_create_points.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_create_points_grid (risk 2, mutates, UE 5.4+, requires plugin PCG, smoke)​

Adds a Create Points Grid node (PCGCreatePointsGridSettings, UE 5.4+); configure it with pcg.set_create_points_grid.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_create_spline (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Adds the create spline settings node.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_debug (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Adds the debug settings node.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_delete_tags (risk 2, mutates, UE 5.4+, requires plugin PCG, smoke)​

Adds a Delete Tags node (PCGDeleteTagsSettings, UE 5.4+); list the tags with pcg.set_delete_tags.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_density_filter (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Adds the density filter settings node.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_density_noise (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Adds the density noise settings node.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_density_remap (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Adds the density remap settings node.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_difference (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Adds the difference settings node.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_distance (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Adds a Distance node (PCGDistanceSettings, UE 5.2+): distance from each source point to the nearest target point.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_filter_by_tag (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Adds the filter by tag settings node.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_get_actor_data (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Adds the get actor data settings node.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_get_landscape (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Adds the get landscape settings node.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_get_primitive (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Adds the get primitive settings node.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_get_spline (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Adds the get spline settings node.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_get_volume (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Adds the get volume settings node.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_intersection (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Adds the intersection settings node.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_linear_density_remap (risk 2, mutates, UE 5.2+, UE ≤5.4, requires plugin PCG, smoke)​

Adds the linear density remap settings node (removed from PCG in UE 5.5; use add_density_remap there).

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_loop (risk 2, mutates, UE 5.3+, requires plugin PCG, smoke)​

Adds a Loop node (PCGLoopSettings, UE 5.3+) that runs a subgraph once per input data; choose the graph with pcg.set_subgraph.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_merge (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Adds the merge settings node.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_metadata_bitwise (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Adds the metadata bitwise settings node.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_metadata_boolean (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Adds the metadata boolean settings node.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_metadata_break_transform (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Adds the metadata break transform settings node.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_metadata_break_vector (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Adds the metadata break vector settings node.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_metadata_compare (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Adds the metadata compare settings node.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_metadata_make_transform (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Adds the metadata make transform settings node.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_metadata_make_vector (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Adds the metadata make vector settings node.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_metadata_maths (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Adds the metadata maths settings node.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_metadata_partition (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Adds the metadata partition settings node.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_metadata_rename (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Adds the metadata rename settings node.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_metadata_rotator (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Adds the metadata rotator settings node.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_metadata_transform (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Adds the metadata transform settings node.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_metadata_trig (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Adds the metadata trig settings node.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_metadata_vector (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Adds the metadata vector settings node.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_node (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

No description.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
classstringrequired. Public UPCGSettings class path, for example /Script/PCG.PCGTransformPointsSettings.
xintegerGraph X. Default 0.
yintegerGraph Y. Default 0.
titlestringOptional authored node title.

Returns: node, message.

pcg.add_normal_to_density (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Adds a Normal To Density node (PCGNormalToDensitySettings, UE 5.2+): density from the point normal vs a reference normal.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_parameter (risk 2, mutates, UE 5.3+, requires plugin PCG, smoke)​

Adds a typed graph user parameter (scalar, string, vector/rotator/transform/color, enum, struct, object/class refs; optional array/set container) with an optional default value. UE 5.3+ (default value: 5.5+, set container: 5.5+).

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
namestringrequired. New parameter name (valid identifier).
typestringbool, byte, int32, int64, float, double, name, string, text, vector, vector2d, rotator, transform, color, enum, struct, object, softobject, class or softclass. Default TEXT("double").
typeObjectstringEnum path (enum), struct path (struct) or base class path (object, softobject, class, softclass; default /Script/CoreUObject.Object).
containerstringnone, array (UE 5.3+) or set (UE 5.5+). Default TEXT("none").
valuestringOptional default value in UE text form (UE 5.5+).

Returns: parameters, count, readers, message.

pcg.add_point_extents_modifier (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Adds the point extents modifier settings node.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_point_filter (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Adds the point filter settings node.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_point_match_and_set (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Adds the point match and set settings node.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_point_neighborhood (risk 2, mutates, UE 5.4+, requires plugin PCG, smoke)​

Adds a Point Neighborhood node (PCGPointNeighborhoodSettings, UE 5.4+): averages neighbours within a radius.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_point_sampler (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Adds the point sampler settings node.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_projection (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Adds the projection settings node.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_property_to_param_data (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Adds the property to param data settings node.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_reroute (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Adds the reroute settings node.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_self_pruning (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Adds the self pruning settings node.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_sort_points (risk 2, mutates, UE 5.4+, requires plugin PCG, smoke)​

Adds a Sort Attributes node (PCGSortAttributesSettings, UE 5.4+) that sorts points by an attribute; pick it with pcg.set_attribute_selector.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_spatial_noise (risk 2, mutates, UE 5.3+, requires plugin PCG, smoke)​

Adds a Spatial Noise node (PCGSpatialNoiseSettings, UE 5.3+): perlin/voronoi style noise written to density or an attribute.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_spawn_actor (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Adds the spawn actor settings node.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_spline_sampler (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Adds the spline sampler settings node.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_static_mesh_spawner (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Adds the static mesh spawner settings node.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_subgraph (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Adds a Subgraph node (PCGSubgraphSettings, UE 5.2+); choose the graph with pcg.set_subgraph.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_surface_sampler (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Adds the surface sampler settings node.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_switch (risk 2, mutates, UE 5.4+, requires plugin PCG, smoke)​

Adds a Switch node (PCGSwitchSettings, UE 5.4+): routes the input to one of several outputs.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_texture_sampler (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Adds the texture sampler settings node.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_transform_points (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Adds the transform points settings node.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_union (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Adds the union settings node.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_user_parameter_get (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Adds the user parameter get settings node.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_volume (risk 2, mutates, UE 5.2+, requires plugin PCG, requires world, smoke)​

No description.

ArgumentTypeDescription
graphstringrequired. Graph asset path.
namestringrequired. Actor label.
location{x,y,z}World location.
extent{x,y,z}Box extent in cm. Default FUeaVec3(500,500,500).
seedintegerPCG seed. Default 42.

Returns: component, message.

pcg.add_volume_sampler (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Adds the volume sampler settings node.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_world_query (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Adds the world query settings node.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.add_world_ray_hit (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Adds the world ray hit settings node.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
xintegerGraph X coordinate. Default 0.
yintegerGraph Y coordinate. Default 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Returns: node, message.

pcg.arrange_nodes (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Lays nodes out left to right by dependency depth from the graph input (the output node goes last); replies the new positions.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
spacingXintegerHorizontal distance between dependency layers. Default 400.
spacingYintegerVertical distance between nodes of one layer. Default 200.
originXintegerX of the first layer (graph input node). Default 0.
originYintegerY of the first row. Default 0.

Returns: nodes, count.

pcg.audit_duplicate_titles (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Inspects audit duplicate titles for one graph.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: values, items, count, message.

pcg.audit_empty_graph (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Inspects audit empty graph for one graph.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: values, items, count, message.

pcg.audit_graph (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Inspects audit graph for one graph.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: values, items, count, message.

pcg.audit_graph_edges (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Inspects audit graph edges for one graph.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: values, items, count, message.

pcg.audit_graph_input_output (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Inspects audit graph input output for one graph.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: values, items, count, message.

pcg.audit_graph_readiness (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Inspects audit graph readiness for one graph.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: values, items, count, message.

pcg.audit_missing_settings (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Inspects audit missing settings for one graph.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: values, items, count, message.

pcg.audit_node_positions (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Inspects audit node positions for one graph.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: values, items, count, message.

pcg.audit_node_titles (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Inspects audit node titles for one graph.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: values, items, count, message.

pcg.audit_orphan_nodes (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Inspects audit orphan nodes for one graph.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: values, items, count, message.

pcg.audit_unconnected_pins (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Inspects audit unconnected pins for one graph.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: values, items, count, message.

pcg.batch_regenerate (risk 2, mutates, UE 5.2+, requires plugin PCG, requires world, dryRun, smoke)​

Regenerates (GenerateLocal) every editor-world PCG component using the listed graphs, or all components; reports per-component and per-graph failures. Asynchronous: poll pcg.wait_generation per actor.

ArgumentTypeDescription
graphsarray of stringGraph asset paths; empty regenerates every PCG component that has a graph.
forcebooleanForce regeneration even when inputs did not change. Default true.
dryRunbooleanOnly report what would be regenerated. Default false.

Returns: items, scheduled, failed, message.

pcg.cancel_generation (risk 2, mutates, UE 5.2+, requires plugin PCG, requires world, smoke)​

No description.

ArgumentTypeDescription
actorstringrequired. Actor label, object name, or path.
componentstringPCG component name; may be empty only when the actor has exactly one PCG component.

Returns: message, count, generating, cleaningUp.

pcg.cleanup (risk 2, mutates, UE 5.2+, requires plugin PCG, requires world, smoke)​

No description.

ArgumentTypeDescription
actorstringrequired. Actor label, object name, or path.
componentstringPCG component name; may be empty only when the actor has exactly one PCG component.

Returns: message, count, generating, cleaningUp.

pcg.clear_component_parameter_override (risk 2, mutates, UE 5.4+, requires plugin PCG, requires world, smoke)​

Clears a component parameter override (the component follows the graph value again). UE 5.4+.

ArgumentTypeDescription
actorstringrequired. Actor label, object name, or path.
componentstringPCG component name; may be empty only when the actor has exactly one PCG component.
namestringrequired. Graph parameter name.
valuestringOverride value in UE text form (ignored by clear).

Returns: component, parameters, count, message.

pcg.clear_instance_override (risk 2, mutates, UE 5.4+, requires plugin PCG, smoke)​

Clears an instance override: the parameter follows the parent value again. UE 5.4+.

ArgumentTypeDescription
instancestringrequired. PCG graph instance asset path.
namestringrequired. Parameter name.

Returns: parameters, count, readers, message.

pcg.connect (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Connects an output pin to an input pin; replies the edge identity, the edges PCG replaced on single-connection pins and both pin schemas.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
fromstringrequired. Source node name, or $input.
fromPinstringrequired. Source output pin label.
tostringrequired. Destination node name, or $output.
toPinstringrequired. Destination input pin label.

Returns: edges, replaced, pins, count, message.

pcg.connect_many (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Creates several edges; every node and pin is validated before the first edge is added.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
edgesarray of UeaPcgEdgeSpecrequired. Edges to create; every node and pin is validated before any edge is added.

Returns: edges, replaced, pins, count, message.

pcg.count_generated_instances (risk 0, UE 5.6+, requires plugin PCG, requires world, smoke)​

Counts generated static mesh instances per mesh (and spawned actors) for the component's last finished generation. UE 5.6+.

ArgumentTypeDescription
actorstringrequired. Actor label, object name, or path.
componentstringPCG component name; may be empty only when the actor has exactly one PCG component.

Returns: total, meshes, actors, generating, message.

pcg.create (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

No description.

ArgumentTypeDescription
folderstringrequired. Content folder.
namestringrequired. Bare asset name.

Returns: asset, nodeCount, message.

pcg.create_density_biome_graph (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Recipe: landscape Surface Sampler -> density noise -> one Density Filter band + Static Mesh Spawner per mesh -> Output.

ArgumentTypeDescription
folderstringrequired. Content folder of the new graph.
namestringrequired. Bare asset name.
meshesarray of stringrequired. One mesh per biome band (1..8); band i keeps densities [i/n, (i+1)/n].
pointsPerSquaredMeternumberSampling density (> 0). Default 0.05.
pointExtents{x,y,z}Half size of each sampled point in cm (> 0). Default FUeaVec3(50,50,50).

Returns: asset, nodes, edges, nodeCount, message.

pcg.create_forest_graph (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Recipe: landscape Surface Sampler minus tagged exclusion actors (Difference) -> Self Pruning -> Transform Points -> Static Mesh Spawner -> Output.

ArgumentTypeDescription
folderstringrequired. Content folder of the new graph.
namestringrequired. Bare asset name.
meshesarray of stringrequired. Tree meshes picked at random (weighted).
weightsarray of integerOne weight (> 0) per mesh; empty gives weight 1.
exclusionTagstringActor tag of the exclusion volumes/meshes (their bounds are cut out of the forest). Default TEXT("PCG_Exclude").
pointsPerSquaredMeternumberSampling density (> 0). Default 0.02.
pointExtents{x,y,z}Half size of each tree footprint in cm (> 0); self pruning removes overlapping footprints. Default FUeaVec3(150,150,100).
scaleMinnumberMinimum uniform scale (> 0). Default 0.8.
scaleMaxnumberMaximum uniform scale (>= scaleMin). Default 1.3.

Returns: asset, nodes, edges, nodeCount, message.

pcg.create_grid_scatter_graph (risk 2, mutates, UE 5.4+, requires plugin PCG, smoke)​

Recipe: creates a graph wired Create Points Grid -> Transform Points -> Static Mesh Spawner -> Output (nodes titled Grid, Transform, Spawner). UE 5.4+ (Create Points Grid node).

ArgumentTypeDescription
folderstringrequired. Content folder.
namestringrequired. Bare asset name.
meshstringStatic mesh spawned on every point. Default TEXT("/Engine/BasicShapes/Cube").
gridExtent{x,y,z}Half size of the point grid in cm. Default FUeaVec3(200,200,0).
cellSize{x,y,z}Grid cell size in cm (all components > 0). Default FUeaVec3(100,100,100).

Returns: asset, nodeCount, message.

pcg.create_instance (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Creates a PCG graph instance asset (UPCGGraphInstance) pointing to a graph or another instance; its parameters start equal to the parent and can be overridden with pcg.set_instance_override.

ArgumentTypeDescription
graphstringrequired. Parent PCG graph or graph instance asset the new instance points to.
folderstringrequired. Content folder of the new instance asset.
namestringrequired. Bare asset name of the new instance (convention: PCGI_ prefix).

Returns: asset, parent, rootGraph, parameterCount, overriddenCount.

pcg.create_points_from_actors_graph (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Recipe: Get Actor Data (every world actor tagged actorTag, one point each) -> Transform Points (offset) -> Static Mesh Spawner -> Output.

ArgumentTypeDescription
folderstringrequired. Content folder of the new graph.
namestringrequired. Bare asset name.
actorTagstringrequired. Actor tag to read.
meshstringMesh spawned at each actor. Default TEXT("/Engine/BasicShapes/Cube").
offset{x,y,z}Offset from each actor in cm.
includeChildrenbooleanAlso read the tagged actors' children. Default false.

Returns: asset, nodes, edges, nodeCount, message.

pcg.create_prop_grid_graph (risk 2, mutates, UE 5.4+, requires plugin PCG, smoke)​

Recipe (UE 5.4+): Create Points Grid (local to the component) -> Transform Points (XY jitter, random yaw) -> Static Mesh Spawner (weighted meshes) -> Output.

ArgumentTypeDescription
folderstringrequired. Content folder of the new graph.
namestringrequired. Bare asset name.
meshesarray of stringrequired. Prop meshes picked at random (weighted).
weightsarray of integerOne weight (> 0) per mesh; empty gives weight 1.
gridExtent{x,y,z}Half size of the grid in cm, around the PCG component (>= 0). Default FUeaVec3(1000,1000,0).
cellSize{x,y,z}Cell size in cm (all > 0). Default FUeaVec3(200,200,100).
jitternumberRandom XY offset in cm (>= 0). Default 50.
randomYawbooleanRandom yaw 0..360. Default true.

Returns: asset, nodes, edges, nodeCount, message.

pcg.create_scatter_on_surface_graph (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Recipe: Get Landscape Data -> Surface Sampler -> Transform Points (random yaw/scale) -> Static Mesh Spawner (weighted meshes) -> Output.

ArgumentTypeDescription
folderstringrequired. Content folder of the new graph.
namestringrequired. Bare asset name.
meshesarray of stringrequired. Static meshes picked at random (weighted).
weightsarray of integerOne weight (> 0) per mesh; empty gives weight 1.
pointsPerSquaredMeternumberSampling density (> 0). Default 0.05.
pointExtents{x,y,z}Half size of each sampled point in cm (> 0). Default FUeaVec3(50,50,50).
scaleMinnumberMinimum uniform scale (> 0). Default 0.8.
scaleMaxnumberMaximum uniform scale (>= scaleMin). Default 1.2.
randomYawbooleanRandom yaw 0..360. Default true.

Returns: asset, nodes, edges, nodeCount, message.

pcg.create_spline_fence_graph (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Recipe: Get Spline Data (actors tagged splineTag) -> Spline Sampler (one point every spacing cm) -> Static Mesh Spawner -> Output.

ArgumentTypeDescription
folderstringrequired. Content folder of the new graph.
namestringrequired. Bare asset name.
meshstringPost mesh. Default TEXT("/Engine/BasicShapes/Cube").
splineTagstringActor tag of the spline actors to follow. Default TEXT("PCG_Fence").
spacingnumberDistance between posts in cm (> 0). Default 200.

Returns: asset, nodes, edges, nodeCount, message.

pcg.delete (risk 3, mutates, destructive, UE 5.2+, requires plugin PCG, smoke)​

No description.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: message, count, generating, cleaningUp.

pcg.disconnect (risk 3, mutates, UE 5.2+, requires plugin PCG, smoke)​

Removes one edge; replies the removed edge identity and both pin schemas.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
fromstringrequired. Source node name, or $input.
fromPinstringrequired. Source output pin label.
tostringrequired. Destination node name, or $output.
toPinstringrequired. Destination input pin label.

Returns: edges, replaced, pins, count, message.

pcg.disconnect_node (risk 3, mutates, UE 5.2+, requires plugin PCG, smoke)​

Removes every edge of a node (or of one pin), inputs, outputs or both; replies the removed edge identities.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
nodestringrequired. Node name or title.
pinstringOptional pin label; empty = every pin in the chosen direction.
directionstringinputs, outputs or both. Default TEXT("both").

Returns: edges, replaced, pins, count, message.

pcg.duplicate (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

No description.

ArgumentTypeDescription
graphstringrequired. Source graph.
folderstringrequired. Destination folder.
namestringrequired. Bare destination name.

Returns: asset, nodeCount, message.

pcg.duplicate_node (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Duplicates a node (settings copied, edges not) at an offset; replies the new node.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
nodestringrequired. Node to duplicate (settings are copied, edges are not).
offsetXintegerX offset of the copy. Default 50.
offsetYintegerY offset of the copy. Default 50.
titlestringOptional authored title for the copy.

Returns: node, message.

pcg.export_graph (risk 0, UE 5.3+, requires plugin PCG, smoke)​

Exports a graph as a typed document (graph settings, parameters, nodes with non-default settings, edges) that pcg.import_graph recreates; optional file writes it as JSON. UE 5.3+.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
filestringOptional absolute .json file path; when set the document is also written there.

Returns: document, file, nodeCount, edgeCount.

pcg.find_components_using_graph (risk 0, UE 5.2+, requires plugin PCG, requires world, smoke)​

Lists the editor-world PCG components whose graph is the given asset.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: components, count.

pcg.find_graphs_using_mesh (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Lists the PCG graphs under a folder whose node settings reference a mesh (weighted selector entries, overrides...).

ArgumentTypeDescription
meshstringrequired. Static mesh (or any asset) path referenced by node settings.
folderstringContent folder searched recursively. Default TEXT("/Game").

Returns: graphs, count, scanned.

pcg.find_graphs_using_node_class (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Lists the PCG graphs under a folder containing nodes of a settings class (or subclass).

ArgumentTypeDescription
classstringrequired. UPCGSettings class path or name, e.g. /Script/PCG.PCGSurfaceSamplerSettings (subclasses match).
folderstringContent folder searched recursively. Default TEXT("/Game").

Returns: graphs, count, scanned.

pcg.find_graphs_using_subgraph (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Lists the PCG graphs under a folder with a Subgraph or Loop node running the given graph.

ArgumentTypeDescription
subgraphstringrequired. PCG graph used as subgraph/loop body.
folderstringContent folder searched recursively. Default TEXT("/Game").

Returns: graphs, count, scanned.

pcg.find_nodes (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Finds nodes by class/title/comment substring, enabled state or connection state.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
classstringCase-insensitive substring of the settings class name (e.g. Spawner).
titlestringCase-insensitive substring of the authored or default title.
commentstringCase-insensitive substring of the node comment.
enabledstringFilter by enabled flag: empty (any), true or false.
unconnectedOnlybooleanOnly nodes without any connected pin. Default false.
includeInputOutputbooleanInclude the graph input/output nodes. Default false.

Returns: nodes, count.

pcg.generate (risk 2, mutates, UE 5.2+, requires plugin PCG, requires world, smoke)​

Schedules generation (asynchronous: returns immediately; call pcg.wait_generation before reading results).

ArgumentTypeDescription
actorstringrequired. Actor label, object name, or path.
componentstringPCG component name; may be empty only when the actor has exactly one PCG component.
forcebooleanForce regeneration. Default true.

Returns: message, count, generating, cleaningUp.

pcg.generate_all (risk 2, mutates, UE 5.2+, requires plugin PCG, requires world, smoke)​

Schedules generation on every PCG component of the editor world (optionally only those using one graph); skipped components are reported with the reason. Asynchronous.

ArgumentTypeDescription
graphstringOptional PCG graph asset path; when set only components using it are generated.
forcebooleanForce regeneration. Default true.

Returns: scheduled, skipped, count, message.

pcg.get (risk 0, UE 5.2+, requires plugin PCG, smoke)​

No description.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: asset, nodeCount, message.

pcg.get_component (risk 0, UE 5.2+, requires plugin PCG, requires world, smoke)​

No description.

ArgumentTypeDescription
actorstringrequired. Actor label, object name, or path.
componentstringPCG component name; may be empty only when the actor has exactly one PCG component.

Returns: component, message.

pcg.get_connected_pin_count (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Inspects get connected pin count for one graph.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: values, items, count, message.

pcg.get_edge_count (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Inspects get edge count for one graph.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: values, items, count, message.

pcg.get_generated_resources (risk 0, UE 5.6+, requires plugin PCG, requires world, smoke)​

Lists the component's managed resources (instanced mesh components with mesh and instance count, spawned actors). Reflects the last finished generation. UE 5.6+.

ArgumentTypeDescription
actorstringrequired. Actor label, object name, or path.
componentstringPCG component name; may be empty only when the actor has exactly one PCG component.

Returns: component, resources, count, message.

pcg.get_graph_complexity (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Inspects get graph complexity for one graph.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: values, items, count, message.

pcg.get_graph_connected_node_count (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Inspects get graph connected node count for one graph.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: values, items, count, message.

pcg.get_graph_connection_count (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Inspects get graph connection count for one graph.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: values, items, count, message.

pcg.get_graph_density (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Inspects get graph density for one graph.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: values, items, count, message.

pcg.get_graph_endpoint_count (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Inspects get graph endpoint count for one graph.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: values, items, count, message.

pcg.get_graph_input (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Inspects get graph input for one graph.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: values, items, count, message.

pcg.get_graph_metadata_node_count (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Inspects get graph metadata node count for one graph.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: values, items, count, message.

pcg.get_graph_node_bounds (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Inspects get graph node bounds for one graph.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: values, items, count, message.

pcg.get_graph_node_class_count (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Inspects get graph node class count for one graph.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: values, items, count, message.

pcg.get_graph_output (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Inspects get graph output for one graph.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: values, items, count, message.

pcg.get_graph_pin_count (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Inspects get graph pin count for one graph.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: values, items, count, message.

pcg.get_graph_settings (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Lists the graph-level settings available on this engine (hierarchical generation, HiGen grid, 2D grid, landscape metadata, library exposure, category, description...) with their values.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: graph, settings, unavailable.

pcg.get_graph_settings_count (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Inspects get graph settings count for one graph.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: values, items, count, message.

pcg.get_graph_spawner_node_count (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Inspects get graph spawner node count for one graph.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: values, items, count, message.

pcg.get_graph_topology (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Inspects get graph topology for one graph.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: values, items, count, message.

pcg.get_graph_unconnected_node_count (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Inspects get graph unconnected node count for one graph.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: values, items, count, message.

pcg.get_input_pin_count (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Inspects get input pin count for one graph.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: values, items, count, message.

pcg.get_instance (risk 0, UE 5.3+, requires plugin PCG, smoke)​

Describes a graph instance: parent, root graph, parameter and override counts. UE 5.3+.

ArgumentTypeDescription
instancestringrequired. PCG graph instance asset path.

Returns: asset, parent, rootGraph, parameterCount, overriddenCount.

pcg.get_node (risk 0, UE 5.2+, requires plugin PCG, smoke)​

No description.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
nodestringrequired. Node object name returned by list_nodes, or its authored title when unique.

Returns: node, message.

pcg.get_node_class_info (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Describes a node settings class without adding it: default title, tooltip, type, default pins with schema, editable settings with defaults.

ArgumentTypeDescription
classstringrequired. UPCGSettings class path or unique class name (e.g. /Script/PCG.PCGTransformPointsSettings).

Returns: class, defaultTitle, tooltip, type, hasDynamicPins, canBeDisabled, inputs, outputs, properties.

pcg.get_node_count (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Inspects get node count for one graph.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: values, items, count, message.

pcg.get_node_setting (risk 0, UE 5.2+, requires plugin PCG, smoke)​

No description.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
nodestringrequired. Node name.
propertystringrequired. Reflected setting property path; dots enter structs and instanced sub-objects (MeshSelectorParameters.MeshEntries).
valuestringUE text-import value (ignored by get_node_setting).

Returns: node, message.

pcg.get_node_settings (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Lists the node's editable settings (type, category, value, pin-overridable), optionally only the non-default ones.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
nodestringrequired. Node name or title.
onlyNonDefaultbooleanOnly list values that differ from the class defaults. Default false.

Returns: node, properties, count.

pcg.get_orphan_node_count (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Inspects get orphan node count for one graph.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: values, items, count, message.

pcg.get_output_pin_count (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Inspects get output pin count for one graph.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: values, items, count, message.

pcg.get_parameter (risk 0, UE 5.3+, requires plugin PCG, smoke)​

Reads one parameter of a graph or graph instance and lists the Get Graph Parameter nodes reading it. UE 5.3+.

ArgumentTypeDescription
graphstringrequired. PCG graph (or graph instance) asset path.
namestringrequired. Parameter name.

Returns: parameters, count, readers, message.

pcg.get_sink_node_count (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Inspects get sink node count for one graph.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: values, items, count, message.

pcg.get_source_node_count (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Inspects get source node count for one graph.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: values, items, count, message.

pcg.get_unconnected_pin_count (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Inspects get unconnected pin count for one graph.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: values, items, count, message.

pcg.import_graph (risk 2, mutates, UE 5.5+, requires plugin PCG, smoke)​

Creates a new graph from a document (inline or a JSON file written by pcg.export_graph): parameters, nodes, settings, edges; everything is validated before the asset is created. UE 5.5+.

ArgumentTypeDescription
folderstringrequired. Content folder of the new graph.
namestringrequired. Bare asset name of the new graph.
documentUeaPcgGraphDocumentInline document (as returned by pcg.export_graph); leave empty when file is set.
filestringAbsolute .json file written by pcg.export_graph; used instead of document.

Returns: asset, nodeMap, nodeCount, edgeCount, parameterCount.

pcg.inspect_node_output (risk 0, UE 5.8+, requires plugin PCG, requires world, smoke)​

Summarizes the data a node produced in the component's last generation (per pin: data class, point count, bounds, attributes, tags). node '$output' reads the graph output without inspection; other nodes need pcg.set_component_inspection before generating. UE 5.8+.

ArgumentTypeDescription
actorstringrequired. Actor label, object name, or path.
componentstringPCG component name; may be empty only when the actor has exactly one PCG component.
nodestringrequired. Node name or unique title in the component's graph.
pinstringOptional output pin label filter.

Returns: node, inspecting, executed, stacks, data, message.

pcg.list (risk 0, UE 5.2+, requires plugin PCG, smoke)​

No description.

ArgumentTypeDescription
folderstringContent folder. Default TEXT("/Game").
limitintegerMaximum results. Default 100.

Returns: assets, count, message.

pcg.list_actor_data_nodes (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Inspects list actor data nodes for one graph.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: values, items, count, message.

pcg.list_available_subgraphs (risk 0, UE 5.4+, requires plugin PCG, smoke)​

Lists graph and graph-instance assets that can be used as a subgraph inside the given graph (itself and graphs that already contain it are excluded as cycles). UE 5.4+.

ArgumentTypeDescription
graphstringrequired. Graph that would host the subgraph node; candidates that would create a cycle are excluded.
folderstringContent folder searched recursively. Default TEXT("/Game").
limitintegerMaximum candidates returned. Default 100.

Returns: candidates, excluded, count.

pcg.list_comment_boxes (risk 0, UE 5.6+, requires plugin PCG, smoke)​

Lists the graph's comment boxes. UE 5.6+ (comments stored on the graph).

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: box, boxes, count.

pcg.list_component_parameters (risk 0, UE 5.4+, requires plugin PCG, requires world, smoke)​

Lists the graph parameters seen by a component with its override state and values. UE 5.4+.

ArgumentTypeDescription
actorstringrequired. Actor label, object name, or path.
componentstringPCG component name; may be empty only when the actor has exactly one PCG component.

Returns: component, parameters, count, message.

pcg.list_components (risk 0, UE 5.2+, requires plugin PCG, requires world, smoke)​

Lists PCG components in the editor world, optionally only those using one graph.

ArgumentTypeDescription
graphstringOptional PCG graph asset path; when set only components/volumes using that graph are listed.

Returns: components, count.

pcg.list_connected_nodes (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Inspects list connected nodes for one graph.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: values, items, count, message.

pcg.list_connected_pins (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Inspects list connected pins for one graph.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: values, items, count, message.

pcg.list_debug_nodes (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Inspects list debug nodes for one graph.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: values, items, count, message.

pcg.list_edge_pairs (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Inspects list edge pairs for one graph.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: values, items, count, message.

pcg.list_edges (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Lists every edge with its identity 'From:FromPin->To:ToPin' (node object names).

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: edges, count.

pcg.list_filter_nodes (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Inspects list filter nodes for one graph.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: values, items, count, message.

pcg.list_input_pins (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Inspects list input pins for one graph.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: values, items, count, message.

pcg.list_instance_overrides (risk 0, UE 5.3+, requires plugin PCG, smoke)​

Lists the parameters of a graph instance with override state, instance value and parent value. UE 5.3+.

ArgumentTypeDescription
instancestringrequired. PCG graph instance asset path.

Returns: parameters, count, readers, message.

pcg.list_metadata_nodes (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Inspects list metadata nodes for one graph.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: values, items, count, message.

pcg.list_node_classes (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Inspects list node classes for one graph.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: values, items, count, message.

pcg.list_node_positions (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Inspects list node positions for one graph.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: values, items, count, message.

pcg.list_node_titles (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Inspects list node titles for one graph.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: values, items, count, message.

pcg.list_nodes (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Lists every node with its pin schema (allowed types, multiplicity, required/advanced, edge count).

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: nodes, count.

pcg.list_orphan_nodes (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Inspects list orphan nodes for one graph.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: values, items, count, message.

pcg.list_output_pins (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Inspects list output pins for one graph.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: values, items, count, message.

pcg.list_parameter_nodes (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Inspects list parameter nodes for one graph.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: values, items, count, message.

pcg.list_parameters (risk 0, UE 5.3+, requires plugin PCG, smoke)​

Lists the user parameters of a graph or graph instance: name, type, type object, container, value, GUID (instances also override state and parent value). UE 5.3+.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: parameters, count, readers, message.

pcg.list_pins (risk 0, UE 5.2+, requires plugin PCG, smoke)​

No description.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
nodestringrequired. Node object name returned by list_nodes, or its authored title when unique.

Returns: node, message.

pcg.list_placed_nodes (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Inspects list placed nodes for one graph.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: values, items, count, message.

pcg.list_point_nodes (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Inspects list point nodes for one graph.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: values, items, count, message.

pcg.list_sampler_nodes (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Inspects list sampler nodes for one graph.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: values, items, count, message.

pcg.list_sink_nodes (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Inspects list sink nodes for one graph.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: values, items, count, message.

pcg.list_source_nodes (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Inspects list source nodes for one graph.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: values, items, count, message.

pcg.list_spatial_nodes (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Inspects list spatial nodes for one graph.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: values, items, count, message.

pcg.list_spawner_nodes (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Inspects list spawner nodes for one graph.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: values, items, count, message.

pcg.list_unconnected_nodes (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Inspects list unconnected nodes for one graph.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: values, items, count, message.

pcg.list_unconnected_pins (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Inspects list unconnected pins for one graph.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: values, items, count, message.

pcg.list_unplaced_nodes (risk 0, UE 5.2+, requires plugin PCG, smoke)​

Inspects list unplaced nodes for one graph.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: values, items, count, message.

pcg.list_volumes (risk 0, UE 5.2+, requires plugin PCG, requires world, smoke)​

Lists PCG volumes in the editor world, optionally only those using one graph.

ArgumentTypeDescription
graphstringOptional PCG graph asset path; when set only components/volumes using that graph are listed.

Returns: volumes, count, message.

pcg.move_node (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

No description.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
nodestringrequired. Node name.
xintegerGraph X. Default 0.
yintegerGraph Y. Default 0.

Returns: node, message.

pcg.refresh (risk 2, mutates, UE 5.4+, requires plugin PCG, requires world, smoke)​

Schedules a refresh of the component (PCG decides whether to regenerate, as after an edit). Asynchronous. UE 5.4+.

ArgumentTypeDescription
actorstringrequired. Actor label, object name, or path.
componentstringPCG component name; may be empty only when the actor has exactly one PCG component.

Returns: message, count, generating, cleaningUp.

pcg.remove_comment_box (risk 2, mutates, UE 5.6+, requires plugin PCG, smoke)​

Removes a comment box by GUID. UE 5.6+.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
idstringrequired. Comment box GUID, or its exact comment text when unique.

Returns: box, boxes, count.

pcg.remove_node (risk 3, mutates, UE 5.2+, requires plugin PCG, smoke)​

No description.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
nodestringrequired. Node object name returned by list_nodes, or its authored title when unique.

Returns: message, count, generating, cleaningUp.

pcg.remove_nodes (risk 3, mutates, UE 5.2+, requires plugin PCG, smoke)​

Removes several nodes at once (all references are resolved first; graph input/output nodes are refused).

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
nodesarray of stringrequired. Node names or unique titles; all are resolved before anything is removed.

Returns: nodes, count.

pcg.remove_parameter (risk 3, mutates, UE 5.5+, requires plugin PCG, smoke)​

Removes a graph parameter; refused while Get Graph Parameter nodes read it unless force is true. UE 5.5+.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
namestringrequired. Parameter name.
forcebooleanRemove even when Get Graph Parameter nodes read it (they become invalid). Default false.

Returns: parameters, count, readers, message.

pcg.remove_volume (risk 3, mutates, destructive, UE 5.2+, requires plugin PCG, requires world, smoke)​

No description.

ArgumentTypeDescription
actorstringrequired. Actor label, object name, or path.

Returns: message, count, generating, cleaningUp.

pcg.rename (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

No description.

ArgumentTypeDescription
graphstringrequired. Graph asset.
namestringrequired. Bare new name.

Returns: asset, nodeCount, message.

pcg.rename_parameter (risk 2, mutates, UE 5.6+, requires plugin PCG, smoke)​

Renames a graph parameter through PCG (Get Graph Parameter nodes and instance overrides follow). UE 5.6+.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
namestringrequired. Current parameter name.
newNamestringrequired. New parameter name (valid identifier).

Returns: parameters, count, readers, message.

pcg.reset_node_setting (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Restores one editable setting (dotted path allowed) to the settings-class default.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
nodestringrequired. Node name or title.
propertystringrequired. Editable property path, e.g. PointsPerSquaredMeter or SamplerParams.Mode.

Returns: node, values, count, message.

pcg.save (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

No description.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: asset, nodeCount, message.

pcg.set_actor_selector (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Sets which actors a Get Actor Data node (or Get Spline/Volume/Primitive/Landscape Data) reads, and its mode.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
nodestringrequired. Get Actor Data (or Get Spline/Volume/Primitive/Landscape Data) node name or title.
actorFilterstringEPCGActorFilter: Self, Parent, Root, AllWorldActors, Original.
actorSelectionstringEPCGActorSelection: ByTag, ByClass.
tagstringActor tag used with ByTag; empty keeps the current tag.
actorClassstringActor class used with ByClass; empty keeps the current class.
selectMultiplestring"true"/"false": select every matching actor, not only the first.
includeChildrenstring"true"/"false": include the selected actors' children.
mustOverlapSelfstring"true"/"false": only actors overlapping the PCG component bounds.
modestringEPCGGetDataFromActorMode: ParseActorComponents, GetSinglePoint, GetDataFromProperty, GetDataFromPCGComponent...

Returns: node, values, count, message.

pcg.set_add_tags (risk 2, mutates, UE 5.4+, requires plugin PCG, smoke)​

Sets the tags written by an Add Tags node (UE 5.4+).

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
nodestringrequired. Add Tags node name or title.
tagsarray of stringrequired. Tags added to every data item (no commas inside a tag).

Returns: node, values, count, message.

pcg.set_attribute_selector (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Writes an attribute/property selector setting (e.g. InputSource '$Density', OutputTarget 'Height') after validating it is selector-typed.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
nodestringrequired. Node name or title.
propertystringrequired. Selector property path, e.g. InputSource, OutputTarget, Parameters.ComparisonSource.
selectorstringrequired. Selector text: an attribute name, $Property (e.g. $Density, $Position.Z) or @Last.

Returns: node, values, count, message.

pcg.set_bounds_modifier (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Sets mode, bounds operands and steepness of a Bounds Modifier.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
nodestringrequired. Bounds Modifier node name or title.
modestringEPCGBoundsModifierMode: Set, Intersect, Include, Translate, Scale.
setBoundsbooleanWrite boundsMin/boundsMax. Default false.
boundsMin{x,y,z}Bounds min operand. Default FUeaVec3(1,1,1).
boundsMax{x,y,z}Bounds max operand. Default FUeaVec3(1,1,1).
affectSteepnessstring"true"/"false": also change the point steepness.
steepnessnumberSteepness 0..1. Default -1.

Returns: node, values, count, message.

pcg.set_component (risk 2, mutates, UE 5.2+, requires plugin PCG, requires world, smoke)​

No description.

ArgumentTypeDescription
actorstringrequired. Actor reference.
componentstringComponent name.
graphstringOptional graph asset path.
seedintegerSeed, or -1 to leave unchanged. Default -1.
activatedstringOptional activated state: true or false.
generationTriggerstringOptional public generation trigger enum text.

Returns: component, message.

pcg.set_component_inspection (risk 1, UE 5.8+, requires plugin PCG, requires world, smoke)​

Enables or disables per-node data capture on a component; needed before pcg.inspect_node_output can read intermediate nodes. UE 5.8+.

ArgumentTypeDescription
actorstringrequired. Actor label, object name, or path.
componentstringPCG component name; may be empty only when the actor has exactly one PCG component.
enabledbooleanEnable (true) or disable (false) per-node data capture for the next generations. Default true.

Returns: node, inspecting, executed, stacks, data, message.

pcg.set_component_parameter_override (risk 2, mutates, UE 5.4+, requires plugin PCG, requires world, smoke)​

Overrides a graph parameter on this component only (its graph instance). UE 5.4+.

ArgumentTypeDescription
actorstringrequired. Actor label, object name, or path.
componentstringPCG component name; may be empty only when the actor has exactly one PCG component.
namestringrequired. Graph parameter name.
valuestringOverride value in UE text form (ignored by clear).

Returns: component, parameters, count, message.

pcg.set_create_points (risk 2, mutates, UE 5.4+, requires plugin PCG, smoke)​

Replaces the explicit point list of a Create Points node (UE 5.4+).

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
nodestringrequired. Create Points node name or title.
pointsarray of {x,y,z}required. Point locations (cm) in coordinateSpace.
extents{x,y,z}Half size of every point (cm, > 0). Default FUeaVec3(50,50,50).
densitynumberDensity of every point 0..1. Default 1.
coordinateSpacestringEPCGCoordinateSpace: World, OriginalComponent, LocalComponent; empty keeps the current one.

Returns: node, values, count, message.

pcg.set_create_points_grid (risk 2, mutates, UE 5.4+, requires plugin PCG, smoke)​

Sets extents, cell size, space and point placement of a Create Points Grid node (UE 5.4+; pointSteepness 5.5+).

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
nodestringrequired. Create Points Grid node name or title.
gridExtents{x,y,z}Half size of the grid in cm.
cellSize{x,y,z}Cell size in cm (all components > 0 when given).
pointSteepnessnumberPoint steepness 0..1 (UE 5.5+). Default -1.
coordinateSpacestringEPCGCoordinateSpace: World, OriginalComponent, LocalComponent.
pointPositionstringEPCGPointPosition: CellCenter, CellCorners.
setPointsBoundsstring"true"/"false": give points the cell bounds.
cullPointsOutsideVolumestring"true"/"false": drop points outside the component volume.

Returns: node, values, count, message.

pcg.set_delete_tags (risk 2, mutates, UE 5.4+, requires plugin PCG, smoke)​

Sets the selected tags and operation of a Delete Tags node (UE 5.4+).

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
nodestringrequired. Delete Tags node name or title.
tagsarray of stringrequired. Selected tags (no commas inside a tag).
operationstringEPCGTagFilterOperation: DeleteSelectedTags, KeepOnlySelectedTags; empty keeps the current one.

Returns: node, values, count, message.

pcg.set_density_filter (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Sets the density band and inversion of a Density Filter.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
nodestringrequired. Density Filter node name or title.
lowerBoundnumberLowest kept density 0..1. Default -1.
upperBoundnumberHighest kept density 0..1. Default -1.
invertFilterstring"true"/"false": keep the points outside the band instead.

Returns: node, values, count, message.

pcg.set_density_noise (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Sets mode, range and inversion of the density noise node created by pcg.add_density_noise.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
nodestringrequired. Density noise node name or title (created by pcg.add_density_noise).
modestringNoise mode: Set, Minimum, Maximum, Add, Multiply.
setRangebooleanWrite noiseMin/noiseMax. Default false.
noiseMinnumberLowest random value. Default 0.
noiseMaxnumberHighest random value. Default 1.
invertSourcestring"true"/"false": invert the source value before applying.

Returns: node, values, count, message.

pcg.set_difference (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Sets density function, mode and metadata diffing of a Difference node.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
nodestringrequired. Difference node name or title.
densityFunctionstringEPCGDifferenceDensityFunction: Minimum, ClampedSubstraction, Binary.
modestringEPCGDifferenceMode: Inferred, Continuous, Discrete.
diffMetadatastring"true"/"false": diff metadata as well.

Returns: node, values, count, message.

pcg.set_distance (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Sets maximum distance, density output and shapes of a Distance node.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
nodestringrequired. Distance node name or title.
maximumDistancenumberMaximum distance in cm (> 0). Default -1.
setDensitystring"true"/"false": write the normalized distance into the density.
outputDistanceVectorstring"true"/"false": output the vector instead of the scalar distance.
sourceShapestringPCGDistanceShape of the source points: SphereBounds, BoxBounds, Center.
targetShapestringPCGDistanceShape of the target points.

Returns: node, values, count, message.

pcg.set_graph_settings (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Sets graph-level settings by key (see pcg.get_graph_settings); every key and value is validated before the graph changes. Returns all settings.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
settingsarray of UeaKeyValuerequired. Key/value pairs; keys as returned by pcg.get_graph_settings (hierarchicalGeneration, hiGenGridSize, use2DGrid, landscapeUsesMetadata, exposeToLibrary, category, description...), values in UE text form.

Returns: graph, settings, unavailable.

pcg.set_instance_graph (risk 2, mutates, UE 5.4+, requires plugin PCG, smoke)​

Re-targets a graph instance to another graph or instance (refused when it would create a cycle); overrides of parameters that still exist are kept. UE 5.4+.

ArgumentTypeDescription
instancestringrequired. PCG graph instance asset path.
graphstringrequired. New parent PCG graph or graph instance; must not create a cycle.

Returns: asset, parent, rootGraph, parameterCount, overriddenCount.

pcg.set_instance_override (risk 2, mutates, UE 5.4+, requires plugin PCG, smoke)​

Overrides one parameter on a graph instance (value validated against the type first). UE 5.4+.

ArgumentTypeDescription
instancestringrequired. PCG graph instance asset path.
namestringrequired. Parameter name.
valuestringrequired. Override value in UE text form.

Returns: parameters, count, readers, message.

pcg.set_mesh_spawner_meshes (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Replaces the weighted mesh entries of a Static Mesh Spawner (weighted selector).

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
nodestringrequired. Static Mesh Spawner node name or title.
meshesarray of stringrequired. Static mesh asset paths (at least one).
weightsarray of integerOne weight (> 0) per mesh; empty gives every mesh weight 1.

Returns: node, values, count, message.

pcg.set_node_comment (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Sets or clears the node comment bubble.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
nodestringrequired. Node name or title.
commentstringComment text; empty clears it.
bubbleVisiblebooleanShow the comment bubble in the graph editor. Default true.

Returns: node, message.

pcg.set_node_debug (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Toggles the node debug flag (transient: draws the node output on the next generation, not saved).

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
nodestringrequired. Node name or title.
debugbooleanNew debug state (transient: draws the node output in the level on next generation, not saved). Default true.

Returns: node, message.

pcg.set_node_enabled (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Enables or disables a node (a disabled node passes its input through); refused for nodes that cannot be disabled.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
nodestringrequired. Node name or title.
enabledbooleanNew enabled state (disabled nodes pass their input through). Default true.

Returns: node, message.

pcg.set_node_setting (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Writes one setting; the path may enter structs and instanced sub-objects (MeshSelectorParameters.MeshEntries).

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
nodestringrequired. Node name.
propertystringrequired. Reflected setting property path; dots enter structs and instanced sub-objects (MeshSelectorParameters.MeshEntries).
valuestringUE text-import value (ignored by get_node_setting).

Returns: node, message.

pcg.set_node_settings (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Writes several settings at once; the list is first applied to a scratch copy so a bad entry leaves the node untouched.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
nodestringrequired. Node name or title.
settingsarray of UeaKeyValuerequired. Property path/value pairs; all are validated on a scratch copy before the node is changed.

Returns: node, properties, count.

pcg.set_node_title (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

No description.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
nodestringrequired. Node object name.
titlestringAuthored title; empty clears it.

Returns: node, message.

pcg.set_normal_to_density (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Sets reference normal, offset, strength and mode of a Normal To Density node.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
nodestringrequired. Normal To Density node name or title.
normal{x,y,z}Reference normal; all zero keeps the current one.
setOffsetbooleanWrite offset. Default false.
offsetnumberOffset added to the dot product (-1..1). Default 0.
strengthnumberStrength exponent (> 0); negative keeps the current value. Default -1.
densityModestringPCGNormalToDensityMode: Set, Minimum, Maximum, Add, Subtract, Multiply, Divide.

Returns: node, values, count, message.

pcg.set_parameter (risk 2, mutates, UE 5.5+, requires plugin PCG, smoke)​

Sets the default value of a graph parameter (validated against its type first); instances that do not override it follow. UE 5.5+.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
namestringrequired. Parameter name.
valuestringrequired. New default value in UE text form, validated against the parameter type.

Returns: parameters, count, readers, message.

pcg.set_self_pruning (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Sets pruning type, radius similarity and randomization of a Self Pruning node.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
nodestringrequired. Self Pruning node name or title.
pruningTypestringEPCGSelfPruningType: LargeToSmall, SmallToLarge, AllEqual, None, RemoveDuplicates.
radiusSimilarityFactornumberRadius similarity factor (>= 0). Default -1.
randomizedPruningstring"true"/"false": randomize the pruning order.

Returns: node, values, count, message.

pcg.set_spline_sampler (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Sets mode, dimension, fill and spacing of a Spline Sampler.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
nodestringrequired. Spline Sampler node name or title.
modestringEPCGSplineSamplingMode: Subdivision, Distance (NumberOfSamples on 5.4+).
dimensionstringEPCGSplineSamplingDimension: OnSpline, OnHorizontal, OnVertical, OnVolume, OnInterior.
fillstringEPCGSplineSamplingFill: Fill, EdgesOnly.
subdivisionsPerSegmentintegerPoints per spline segment (Subdivision mode, >= 0). Default -1.
distanceIncrementnumberDistance between points in cm (Distance mode, > 0). Default -1.
interiorSampleSpacingnumberInterior sample spacing in cm (OnInterior, > 0). Default -1.
projectOntoSurfacestring"true"/"false": project interior samples onto the surface.

Returns: node, values, count, message.

pcg.set_subgraph (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Sets the graph executed by a Subgraph or Loop node (refuses the owning graph).

ArgumentTypeDescription
graphstringrequired. PCG graph asset path that owns the node.
nodestringrequired. Subgraph or Loop node name or title.
subgraphstringrequired. PCG graph asset executed by the node (not the owning graph).

Returns: node, values, count, message.

pcg.set_surface_sampler (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Sets the Surface Sampler density, point extents, looseness, steepness and bounded mode.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
nodestringrequired. Surface Sampler node name or title.
pointsPerSquaredMeternumberPoints per square meter (> 0). Default -1.
pointExtents{x,y,z}Half size of every sampled point in cm.
loosenessnumberLooseness 0..1 of the sampling grid jitter. Default -1.
pointSteepnessnumberPoint steepness 0..1. Default -1.
unboundedstring"true"/"false": sample the whole surface instead of the bounding shape.
applyDensityToPointsstring"true"/"false": multiply the surface density into the points.

Returns: node, values, count, message.

pcg.set_transform_points (risk 2, mutates, UE 5.2+, requires plugin PCG, smoke)​

Sets the random offset/rotation/scale ranges and absolute/uniform flags of a Transform Points node.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
nodestringrequired. Transform Points node name or title.
setOffsetbooleanWrite offsetMin/offsetMax. Default false.
offsetMin{x,y,z}Minimum random offset (cm).
offsetMax{x,y,z}Maximum random offset (cm).
setRotationbooleanWrite rotationMin/rotationMax. Default false.
rotationMin{x,y,z}Minimum random rotation (pitch, yaw, roll degrees).
rotationMax{x,y,z}Maximum random rotation (pitch, yaw, roll degrees).
setScalebooleanWrite scaleMin/scaleMax. Default false.
scaleMin{x,y,z}Minimum random scale (x only is used when uniformScale). Default FUeaVec3(1,1,1).
scaleMax{x,y,z}Maximum random scale. Default FUeaVec3(1,1,1).
uniformScalestring"true"/"false": one random factor for all axes.
absoluteOffsetstring"true"/"false": offset replaces the point location.
absoluteRotationstring"true"/"false": rotation replaces the point rotation.
absoluteScalestring"true"/"false": scale replaces the point scale.

Returns: node, values, count, message.

pcg.update_comment_box (risk 2, mutates, UE 5.6+, requires plugin PCG, smoke)​

Changes a comment box (text, position, size, font size, color). UE 5.6+.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.
idstringrequired. Comment box GUID from list/add, or its exact comment text when unique.
commentstringNew text; empty leaves it unchanged.
movebooleanApply x/y. Default false.
xintegerDefault 0.
yintegerDefault 0.
resizebooleanApply width/height. Default false.
widthintegerDefault 400.
heightintegerDefault 100.
fontSizeintegerNew font size; 0 leaves it unchanged. Default 0.
setColorbooleanApply color. Default false.
color{x,y,z}RGB color 0..1. Default FUeaVec3(1,1,1).

Returns: box, boxes, count.

pcg.validate (risk 0, UE 5.3+, requires plugin PCG, smoke)​

Checks a graph: null settings, invalid edges, unconnected required pins, unknown parameter reads, disabled nodes, nodes that never reach the output. UE 5.3+.

ArgumentTypeDescription
graphstringrequired. PCG graph asset path.

Returns: graph, valid, errorCount, warningCount, issues.

pcg.wait_generation (risk 0, UE 5.2+, requires plugin PCG, requires world, smoke)​

Lets editor frames pass until the component is idle (never ticks the editor); a timeout is a failure. Call it as a separate request, not inside a batch.

ArgumentTypeDescription
actorstringrequired. Actor label, object name, or path.
componentstringPCG component name; may be empty only when the actor has exactly one PCG component.
maxFramesintegerMaximum editor frames to wait. Default 300.

Returns: message, count, generating, cleaningUp.