Pular para o conteúdo principal

Kit pcg

235 ferramentas. Gerado a partir do código-fonte do plugin; não edite manualmente.

As descrições das ferramentas e dos argumentos são exibidas em inglês porque espelham o schema das ferramentas (o mesmo texto que o agente recebe em tools/list).

Guia​

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.

Ferramentas​

Legenda. risco 0 = somente leitura, 1 = operação inofensiva do editor, 2 = altera asset, 3 = apaga/substitui asset, 4 = projeto/config/build, 5 = potencialmente destrutivo (chamadas acima de MaxAutoRisk exigem "_confirm": true). altera = roda numa transação (edit.undo reverte). requer PIE / requer mundo = recusado sem sessão PIE / sem nível aberto. requer plugin = indisponível quando o plugin está desativado. dryRun = aceita o argumento dryRun. smoke = coberto por edit.self_test.

pcg.add_add_tags (risco 2, altera, UE 5.4+, requer plugin PCG, smoke)​

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

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_attribute_filter (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Adds the attribute filter settings node.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_attribute_get_from_point_index (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Adds the attribute get from point index settings node.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_attribute_reduce (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Adds the attribute reduce settings node.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_attribute_select (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Adds the attribute select settings node.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_attribute_transfer (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Adds the attribute transfer settings node.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_bounds_from_mesh (risco 2, altera, UE 5.5+, requer plugin PCG, smoke)​

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

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_bounds_modifier (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Adds the bounds modifier settings node.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_branch (risco 2, altera, UE 5.3+, requer plugin PCG, smoke)​

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

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_collapse (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Adds the collapse settings node.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_comment_box (risco 2, altera, UE 5.6+, requer plugin PCG, smoke)​

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

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
commentstringobrigatório. 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.
xintegerPadrão 0.
yintegerPadrão 0.
widthintegerBox width. Padrão 400.
heightintegerBox height. Padrão 100.
fontSizeintegerFont size. Padrão 18.
color{x,y,z}RGB color 0..1. Padrão FUeaVec3(1,1,1).

Retorna: box, boxes, count.

pcg.add_component (risco 2, altera, UE 5.2+, requer plugin PCG, requer mundo, smoke)​

Sem descrição.

ArgumentoTipoDescrição
actorstringobrigatório. Actor label, object name, or path.
graphstringobrigatório. PCG graph asset path.
namestringOptional component name.
seedintegerDeterministic PCG seed. Padrão 42.

Retorna: component, message.

pcg.add_copy_points (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Adds the copy points settings node.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_create_attribute (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Adds the create attribute settings node.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_create_attribute_set (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Adds the create attribute set settings node.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_create_points (risco 2, altera, UE 5.4+, requer plugin PCG, smoke)​

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

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_create_points_grid (risco 2, altera, UE 5.4+, requer plugin PCG, smoke)​

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

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_create_spline (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Adds the create spline settings node.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_debug (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Adds the debug settings node.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_delete_tags (risco 2, altera, UE 5.4+, requer plugin PCG, smoke)​

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

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_density_filter (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Adds the density filter settings node.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_density_noise (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Adds the density noise settings node.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_density_remap (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Adds the density remap settings node.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_difference (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Adds the difference settings node.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_distance (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

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

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_filter_by_tag (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Adds the filter by tag settings node.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_get_actor_data (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Adds the get actor data settings node.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_get_landscape (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Adds the get landscape settings node.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_get_primitive (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Adds the get primitive settings node.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_get_spline (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Adds the get spline settings node.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_get_volume (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Adds the get volume settings node.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_intersection (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Adds the intersection settings node.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_linear_density_remap (risco 2, altera, UE 5.2+, UE ≤5.4, requer plugin PCG, smoke)​

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

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_loop (risco 2, altera, UE 5.3+, requer 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.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_merge (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Adds the merge settings node.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_metadata_bitwise (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Adds the metadata bitwise settings node.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_metadata_boolean (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Adds the metadata boolean settings node.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_metadata_break_transform (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Adds the metadata break transform settings node.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_metadata_break_vector (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Adds the metadata break vector settings node.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_metadata_compare (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Adds the metadata compare settings node.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_metadata_make_transform (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Adds the metadata make transform settings node.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_metadata_make_vector (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Adds the metadata make vector settings node.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_metadata_maths (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Adds the metadata maths settings node.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_metadata_partition (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Adds the metadata partition settings node.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_metadata_rename (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Adds the metadata rename settings node.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_metadata_rotator (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Adds the metadata rotator settings node.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_metadata_transform (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Adds the metadata transform settings node.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_metadata_trig (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Adds the metadata trig settings node.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_metadata_vector (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Adds the metadata vector settings node.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_node (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Sem descrição.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
classstringobrigatório. Public UPCGSettings class path, for example /Script/PCG.PCGTransformPointsSettings.
xintegerGraph X. Padrão 0.
yintegerGraph Y. Padrão 0.
titlestringOptional authored node title.

Retorna: node, message.

pcg.add_normal_to_density (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

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

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_parameter (risco 2, altera, UE 5.3+, requer 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+).

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
namestringobrigatório. 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. Padrão 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+). Padrão TEXT("none").
valuestringOptional default value in UE text form (UE 5.5+).

Retorna: parameters, count, readers, message.

pcg.add_point_extents_modifier (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Adds the point extents modifier settings node.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_point_filter (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Adds the point filter settings node.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_point_match_and_set (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Adds the point match and set settings node.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_point_neighborhood (risco 2, altera, UE 5.4+, requer plugin PCG, smoke)​

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

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_point_sampler (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Adds the point sampler settings node.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_projection (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Adds the projection settings node.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_property_to_param_data (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Adds the property to param data settings node.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_reroute (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Adds the reroute settings node.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_self_pruning (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Adds the self pruning settings node.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_sort_points (risco 2, altera, UE 5.4+, requer 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.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_spatial_noise (risco 2, altera, UE 5.3+, requer plugin PCG, smoke)​

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

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_spawn_actor (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Adds the spawn actor settings node.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_spline_sampler (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Adds the spline sampler settings node.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_static_mesh_spawner (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Adds the static mesh spawner settings node.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_subgraph (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

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

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_surface_sampler (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Adds the surface sampler settings node.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_switch (risco 2, altera, UE 5.4+, requer plugin PCG, smoke)​

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

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_texture_sampler (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Adds the texture sampler settings node.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_transform_points (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Adds the transform points settings node.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_union (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Adds the union settings node.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_user_parameter_get (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Adds the user parameter get settings node.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_volume (risco 2, altera, UE 5.2+, requer plugin PCG, requer mundo, smoke)​

Sem descrição.

ArgumentoTipoDescrição
graphstringobrigatório. Graph asset path.
namestringobrigatório. Actor label.
location{x,y,z}World location.
extent{x,y,z}Box extent in cm. Padrão FUeaVec3(500,500,500).
seedintegerPCG seed. Padrão 42.

Retorna: component, message.

pcg.add_volume_sampler (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Adds the volume sampler settings node.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_world_query (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Adds the world query settings node.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.add_world_ray_hit (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Adds the world ray hit settings node.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
xintegerGraph X coordinate. Padrão 0.
yintegerGraph Y coordinate. Padrão 0.
titlestringOptional authored node title (later tools accept it as the node reference).

Retorna: node, message.

pcg.arrange_nodes (risco 2, altera, UE 5.2+, requer 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.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
spacingXintegerHorizontal distance between dependency layers. Padrão 400.
spacingYintegerVertical distance between nodes of one layer. Padrão 200.
originXintegerX of the first layer (graph input node). Padrão 0.
originYintegerY of the first row. Padrão 0.

Retorna: nodes, count.

pcg.audit_duplicate_titles (risco 0, UE 5.2+, requer plugin PCG, smoke)​

Inspects audit duplicate titles for one graph.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: values, items, count, message.

pcg.audit_empty_graph (risco 0, UE 5.2+, requer plugin PCG, smoke)​

Inspects audit empty graph for one graph.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: values, items, count, message.

pcg.audit_graph (risco 0, UE 5.2+, requer plugin PCG, smoke)​

Inspects audit graph for one graph.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: values, items, count, message.

pcg.audit_graph_edges (risco 0, UE 5.2+, requer plugin PCG, smoke)​

Inspects audit graph edges for one graph.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: values, items, count, message.

pcg.audit_graph_input_output (risco 0, UE 5.2+, requer plugin PCG, smoke)​

Inspects audit graph input output for one graph.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: values, items, count, message.

pcg.audit_graph_readiness (risco 0, UE 5.2+, requer plugin PCG, smoke)​

Inspects audit graph readiness for one graph.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: values, items, count, message.

pcg.audit_missing_settings (risco 0, UE 5.2+, requer plugin PCG, smoke)​

Inspects audit missing settings for one graph.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: values, items, count, message.

pcg.audit_node_positions (risco 0, UE 5.2+, requer plugin PCG, smoke)​

Inspects audit node positions for one graph.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: values, items, count, message.

pcg.audit_node_titles (risco 0, UE 5.2+, requer plugin PCG, smoke)​

Inspects audit node titles for one graph.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: values, items, count, message.

pcg.audit_orphan_nodes (risco 0, UE 5.2+, requer plugin PCG, smoke)​

Inspects audit orphan nodes for one graph.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: values, items, count, message.

pcg.audit_unconnected_pins (risco 0, UE 5.2+, requer plugin PCG, smoke)​

Inspects audit unconnected pins for one graph.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: values, items, count, message.

pcg.batch_regenerate (risco 2, altera, UE 5.2+, requer plugin PCG, requer mundo, 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.

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

Retorna: items, scheduled, failed, message.

pcg.cancel_generation (risco 2, altera, UE 5.2+, requer plugin PCG, requer mundo, smoke)​

Sem descrição.

ArgumentoTipoDescrição
actorstringobrigatório. Actor label, object name, or path.
componentstringPCG component name; may be empty only when the actor has exactly one PCG component.

Retorna: message, count, generating, cleaningUp.

pcg.cleanup (risco 2, altera, UE 5.2+, requer plugin PCG, requer mundo, smoke)​

Sem descrição.

ArgumentoTipoDescrição
actorstringobrigatório. Actor label, object name, or path.
componentstringPCG component name; may be empty only when the actor has exactly one PCG component.

Retorna: message, count, generating, cleaningUp.

pcg.clear_component_parameter_override (risco 2, altera, UE 5.4+, requer plugin PCG, requer mundo, smoke)​

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

ArgumentoTipoDescrição
actorstringobrigatório. Actor label, object name, or path.
componentstringPCG component name; may be empty only when the actor has exactly one PCG component.
namestringobrigatório. Graph parameter name.
valuestringOverride value in UE text form (ignored by clear).

Retorna: component, parameters, count, message.

pcg.clear_instance_override (risco 2, altera, UE 5.4+, requer plugin PCG, smoke)​

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

ArgumentoTipoDescrição
instancestringobrigatório. PCG graph instance asset path.
namestringobrigatório. Parameter name.

Retorna: parameters, count, readers, message.

pcg.connect (risco 2, altera, UE 5.2+, requer 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.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
fromstringobrigatório. Source node name, or $input.
fromPinstringobrigatório. Source output pin label.
tostringobrigatório. Destination node name, or $output.
toPinstringobrigatório. Destination input pin label.

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

pcg.connect_many (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

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

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
edgesarray of UeaPcgEdgeSpecobrigatório. Edges to create; every node and pin is validated before any edge is added.

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

pcg.count_generated_instances (risco 0, UE 5.6+, requer plugin PCG, requer mundo, smoke)​

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

ArgumentoTipoDescrição
actorstringobrigatório. Actor label, object name, or path.
componentstringPCG component name; may be empty only when the actor has exactly one PCG component.

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

pcg.create (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Sem descrição.

ArgumentoTipoDescrição
folderstringobrigatório. Content folder.
namestringobrigatório. Bare asset name.

Retorna: asset, nodeCount, message.

pcg.create_density_biome_graph (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

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

ArgumentoTipoDescrição
folderstringobrigatório. Content folder of the new graph.
namestringobrigatório. Bare asset name.
meshesarray of stringobrigatório. One mesh per biome band (1..8); band i keeps densities [i/n, (i+1)/n].
pointsPerSquaredMeternumberSampling density (> 0). Padrão 0.05.
pointExtents{x,y,z}Half size of each sampled point in cm (> 0). Padrão FUeaVec3(50,50,50).

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

pcg.create_forest_graph (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

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

ArgumentoTipoDescrição
folderstringobrigatório. Content folder of the new graph.
namestringobrigatório. Bare asset name.
meshesarray of stringobrigatório. 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). Padrão TEXT("PCG_Exclude").
pointsPerSquaredMeternumberSampling density (> 0). Padrão 0.02.
pointExtents{x,y,z}Half size of each tree footprint in cm (> 0); self pruning removes overlapping footprints. Padrão FUeaVec3(150,150,100).
scaleMinnumberMinimum uniform scale (> 0). Padrão 0.8.
scaleMaxnumberMaximum uniform scale (>= scaleMin). Padrão 1.3.

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

pcg.create_grid_scatter_graph (risco 2, altera, UE 5.4+, requer 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).

ArgumentoTipoDescrição
folderstringobrigatório. Content folder.
namestringobrigatório. Bare asset name.
meshstringStatic mesh spawned on every point. Padrão TEXT("/Engine/BasicShapes/Cube").
gridExtent{x,y,z}Half size of the point grid in cm. Padrão FUeaVec3(200,200,0).
cellSize{x,y,z}Grid cell size in cm (all components > 0). Padrão FUeaVec3(100,100,100).

Retorna: asset, nodeCount, message.

pcg.create_instance (risco 2, altera, UE 5.2+, requer 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.

ArgumentoTipoDescrição
graphstringobrigatório. Parent PCG graph or graph instance asset the new instance points to.
folderstringobrigatório. Content folder of the new instance asset.
namestringobrigatório. Bare asset name of the new instance (convention: PCGI_ prefix).

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

pcg.create_points_from_actors_graph (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

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

ArgumentoTipoDescrição
folderstringobrigatório. Content folder of the new graph.
namestringobrigatório. Bare asset name.
actorTagstringobrigatório. Actor tag to read.
meshstringMesh spawned at each actor. Padrão TEXT("/Engine/BasicShapes/Cube").
offset{x,y,z}Offset from each actor in cm.
includeChildrenbooleanAlso read the tagged actors' children. Padrão false.

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

pcg.create_prop_grid_graph (risco 2, altera, UE 5.4+, requer 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.

ArgumentoTipoDescrição
folderstringobrigatório. Content folder of the new graph.
namestringobrigatório. Bare asset name.
meshesarray of stringobrigatório. 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). Padrão FUeaVec3(1000,1000,0).
cellSize{x,y,z}Cell size in cm (all > 0). Padrão FUeaVec3(200,200,100).
jitternumberRandom XY offset in cm (>= 0). Padrão 50.
randomYawbooleanRandom yaw 0..360. Padrão true.

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

pcg.create_scatter_on_surface_graph (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

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

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

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

pcg.create_spline_fence_graph (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

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

ArgumentoTipoDescrição
folderstringobrigatório. Content folder of the new graph.
namestringobrigatório. Bare asset name.
meshstringPost mesh. Padrão TEXT("/Engine/BasicShapes/Cube").
splineTagstringActor tag of the spline actors to follow. Padrão TEXT("PCG_Fence").
spacingnumberDistance between posts in cm (> 0). Padrão 200.

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

pcg.delete (risco 3, altera, destrutivo, UE 5.2+, requer plugin PCG, smoke)​

Sem descrição.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: message, count, generating, cleaningUp.

pcg.disconnect (risco 3, altera, UE 5.2+, requer plugin PCG, smoke)​

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

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
fromstringobrigatório. Source node name, or $input.
fromPinstringobrigatório. Source output pin label.
tostringobrigatório. Destination node name, or $output.
toPinstringobrigatório. Destination input pin label.

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

pcg.disconnect_node (risco 3, altera, UE 5.2+, requer plugin PCG, smoke)​

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

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
nodestringobrigatório. Node name or title.
pinstringOptional pin label; empty = every pin in the chosen direction.
directionstringinputs, outputs or both. Padrão TEXT("both").

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

pcg.duplicate (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Sem descrição.

ArgumentoTipoDescrição
graphstringobrigatório. Source graph.
folderstringobrigatório. Destination folder.
namestringobrigatório. Bare destination name.

Retorna: asset, nodeCount, message.

pcg.duplicate_node (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

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

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
nodestringobrigatório. Node to duplicate (settings are copied, edges are not).
offsetXintegerX offset of the copy. Padrão 50.
offsetYintegerY offset of the copy. Padrão 50.
titlestringOptional authored title for the copy.

Retorna: node, message.

pcg.export_graph (risco 0, UE 5.3+, requer 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+.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
filestringOptional absolute .json file path; when set the document is also written there.

Retorna: document, file, nodeCount, edgeCount.

pcg.find_components_using_graph (risco 0, UE 5.2+, requer plugin PCG, requer mundo, smoke)​

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

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: components, count.

pcg.find_graphs_using_mesh (risco 0, UE 5.2+, requer plugin PCG, smoke)​

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

ArgumentoTipoDescrição
meshstringobrigatório. Static mesh (or any asset) path referenced by node settings.
folderstringContent folder searched recursively. Padrão TEXT("/Game").

Retorna: graphs, count, scanned.

pcg.find_graphs_using_node_class (risco 0, UE 5.2+, requer plugin PCG, smoke)​

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

ArgumentoTipoDescrição
classstringobrigatório. UPCGSettings class path or name, e.g. /Script/PCG.PCGSurfaceSamplerSettings (subclasses match).
folderstringContent folder searched recursively. Padrão TEXT("/Game").

Retorna: graphs, count, scanned.

pcg.find_graphs_using_subgraph (risco 0, UE 5.2+, requer plugin PCG, smoke)​

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

ArgumentoTipoDescrição
subgraphstringobrigatório. PCG graph used as subgraph/loop body.
folderstringContent folder searched recursively. Padrão TEXT("/Game").

Retorna: graphs, count, scanned.

pcg.find_nodes (risco 0, UE 5.2+, requer plugin PCG, smoke)​

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

ArgumentoTipoDescrição
graphstringobrigatório. 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. Padrão false.
includeInputOutputbooleanInclude the graph input/output nodes. Padrão false.

Retorna: nodes, count.

pcg.generate (risco 2, altera, UE 5.2+, requer plugin PCG, requer mundo, smoke)​

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

ArgumentoTipoDescrição
actorstringobrigatório. Actor label, object name, or path.
componentstringPCG component name; may be empty only when the actor has exactly one PCG component.
forcebooleanForce regeneration. Padrão true.

Retorna: message, count, generating, cleaningUp.

pcg.generate_all (risco 2, altera, UE 5.2+, requer plugin PCG, requer mundo, 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.

ArgumentoTipoDescrição
graphstringOptional PCG graph asset path; when set only components using it are generated.
forcebooleanForce regeneration. Padrão true.

Retorna: scheduled, skipped, count, message.

pcg.get (risco 0, UE 5.2+, requer plugin PCG, smoke)​

Sem descrição.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: asset, nodeCount, message.

pcg.get_component (risco 0, UE 5.2+, requer plugin PCG, requer mundo, smoke)​

Sem descrição.

ArgumentoTipoDescrição
actorstringobrigatório. Actor label, object name, or path.
componentstringPCG component name; may be empty only when the actor has exactly one PCG component.

Retorna: component, message.

pcg.get_connected_pin_count (risco 0, UE 5.2+, requer plugin PCG, smoke)​

Inspects get connected pin count for one graph.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: values, items, count, message.

pcg.get_edge_count (risco 0, UE 5.2+, requer plugin PCG, smoke)​

Inspects get edge count for one graph.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: values, items, count, message.

pcg.get_generated_resources (risco 0, UE 5.6+, requer plugin PCG, requer mundo, 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+.

ArgumentoTipoDescrição
actorstringobrigatório. Actor label, object name, or path.
componentstringPCG component name; may be empty only when the actor has exactly one PCG component.

Retorna: component, resources, count, message.

pcg.get_graph_complexity (risco 0, UE 5.2+, requer plugin PCG, smoke)​

Inspects get graph complexity for one graph.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: values, items, count, message.

pcg.get_graph_connected_node_count (risco 0, UE 5.2+, requer plugin PCG, smoke)​

Inspects get graph connected node count for one graph.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: values, items, count, message.

pcg.get_graph_connection_count (risco 0, UE 5.2+, requer plugin PCG, smoke)​

Inspects get graph connection count for one graph.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: values, items, count, message.

pcg.get_graph_density (risco 0, UE 5.2+, requer plugin PCG, smoke)​

Inspects get graph density for one graph.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: values, items, count, message.

pcg.get_graph_endpoint_count (risco 0, UE 5.2+, requer plugin PCG, smoke)​

Inspects get graph endpoint count for one graph.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: values, items, count, message.

pcg.get_graph_input (risco 0, UE 5.2+, requer plugin PCG, smoke)​

Inspects get graph input for one graph.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: values, items, count, message.

pcg.get_graph_metadata_node_count (risco 0, UE 5.2+, requer plugin PCG, smoke)​

Inspects get graph metadata node count for one graph.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: values, items, count, message.

pcg.get_graph_node_bounds (risco 0, UE 5.2+, requer plugin PCG, smoke)​

Inspects get graph node bounds for one graph.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: values, items, count, message.

pcg.get_graph_node_class_count (risco 0, UE 5.2+, requer plugin PCG, smoke)​

Inspects get graph node class count for one graph.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: values, items, count, message.

pcg.get_graph_output (risco 0, UE 5.2+, requer plugin PCG, smoke)​

Inspects get graph output for one graph.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: values, items, count, message.

pcg.get_graph_pin_count (risco 0, UE 5.2+, requer plugin PCG, smoke)​

Inspects get graph pin count for one graph.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: values, items, count, message.

pcg.get_graph_settings (risco 0, UE 5.2+, requer 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.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: graph, settings, unavailable.

pcg.get_graph_settings_count (risco 0, UE 5.2+, requer plugin PCG, smoke)​

Inspects get graph settings count for one graph.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: values, items, count, message.

pcg.get_graph_spawner_node_count (risco 0, UE 5.2+, requer plugin PCG, smoke)​

Inspects get graph spawner node count for one graph.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: values, items, count, message.

pcg.get_graph_topology (risco 0, UE 5.2+, requer plugin PCG, smoke)​

Inspects get graph topology for one graph.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: values, items, count, message.

pcg.get_graph_unconnected_node_count (risco 0, UE 5.2+, requer plugin PCG, smoke)​

Inspects get graph unconnected node count for one graph.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: values, items, count, message.

pcg.get_input_pin_count (risco 0, UE 5.2+, requer plugin PCG, smoke)​

Inspects get input pin count for one graph.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: values, items, count, message.

pcg.get_instance (risco 0, UE 5.3+, requer plugin PCG, smoke)​

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

ArgumentoTipoDescrição
instancestringobrigatório. PCG graph instance asset path.

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

pcg.get_node (risco 0, UE 5.2+, requer plugin PCG, smoke)​

Sem descrição.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
nodestringobrigatório. Node object name returned by list_nodes, or its authored title when unique.

Retorna: node, message.

pcg.get_node_class_info (risco 0, UE 5.2+, requer plugin PCG, smoke)​

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

ArgumentoTipoDescrição
classstringobrigatório. UPCGSettings class path or unique class name (e.g. /Script/PCG.PCGTransformPointsSettings).

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

pcg.get_node_count (risco 0, UE 5.2+, requer plugin PCG, smoke)​

Inspects get node count for one graph.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: values, items, count, message.

pcg.get_node_setting (risco 0, UE 5.2+, requer plugin PCG, smoke)​

Sem descrição.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
nodestringobrigatório. Node name.
propertystringobrigatório. Reflected setting property path; dots enter structs and instanced sub-objects (MeshSelectorParameters.MeshEntries).
valuestringUE text-import value (ignored by get_node_setting).

Retorna: node, message.

pcg.get_node_settings (risco 0, UE 5.2+, requer plugin PCG, smoke)​

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

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
nodestringobrigatório. Node name or title.
onlyNonDefaultbooleanOnly list values that differ from the class defaults. Padrão false.

Retorna: node, properties, count.

pcg.get_orphan_node_count (risco 0, UE 5.2+, requer plugin PCG, smoke)​

Inspects get orphan node count for one graph.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: values, items, count, message.

pcg.get_output_pin_count (risco 0, UE 5.2+, requer plugin PCG, smoke)​

Inspects get output pin count for one graph.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: values, items, count, message.

pcg.get_parameter (risco 0, UE 5.3+, requer plugin PCG, smoke)​

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

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph (or graph instance) asset path.
namestringobrigatório. Parameter name.

Retorna: parameters, count, readers, message.

pcg.get_sink_node_count (risco 0, UE 5.2+, requer plugin PCG, smoke)​

Inspects get sink node count for one graph.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: values, items, count, message.

pcg.get_source_node_count (risco 0, UE 5.2+, requer plugin PCG, smoke)​

Inspects get source node count for one graph.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: values, items, count, message.

pcg.get_unconnected_pin_count (risco 0, UE 5.2+, requer plugin PCG, smoke)​

Inspects get unconnected pin count for one graph.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: values, items, count, message.

pcg.import_graph (risco 2, altera, UE 5.5+, requer 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+.

ArgumentoTipoDescrição
folderstringobrigatório. Content folder of the new graph.
namestringobrigatório. 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.

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

pcg.inspect_node_output (risco 0, UE 5.8+, requer plugin PCG, requer mundo, 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+.

ArgumentoTipoDescrição
actorstringobrigatório. Actor label, object name, or path.
componentstringPCG component name; may be empty only when the actor has exactly one PCG component.
nodestringobrigatório. Node name or unique title in the component's graph.
pinstringOptional output pin label filter.

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

pcg.list (risco 0, UE 5.2+, requer plugin PCG, smoke)​

Sem descrição.

ArgumentoTipoDescrição
folderstringContent folder. Padrão TEXT("/Game").
limitintegerMaximum results. Padrão 100.

Retorna: assets, count, message.

pcg.list_actor_data_nodes (risco 0, UE 5.2+, requer plugin PCG, smoke)​

Inspects list actor data nodes for one graph.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: values, items, count, message.

pcg.list_available_subgraphs (risco 0, UE 5.4+, requer 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+.

ArgumentoTipoDescrição
graphstringobrigatório. Graph that would host the subgraph node; candidates that would create a cycle are excluded.
folderstringContent folder searched recursively. Padrão TEXT("/Game").
limitintegerMaximum candidates returned. Padrão 100.

Retorna: candidates, excluded, count.

pcg.list_comment_boxes (risco 0, UE 5.6+, requer plugin PCG, smoke)​

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

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: box, boxes, count.

pcg.list_component_parameters (risco 0, UE 5.4+, requer plugin PCG, requer mundo, smoke)​

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

ArgumentoTipoDescrição
actorstringobrigatório. Actor label, object name, or path.
componentstringPCG component name; may be empty only when the actor has exactly one PCG component.

Retorna: component, parameters, count, message.

pcg.list_components (risco 0, UE 5.2+, requer plugin PCG, requer mundo, smoke)​

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

ArgumentoTipoDescrição
graphstringOptional PCG graph asset path; when set only components/volumes using that graph are listed.

Retorna: components, count.

pcg.list_connected_nodes (risco 0, UE 5.2+, requer plugin PCG, smoke)​

Inspects list connected nodes for one graph.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: values, items, count, message.

pcg.list_connected_pins (risco 0, UE 5.2+, requer plugin PCG, smoke)​

Inspects list connected pins for one graph.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: values, items, count, message.

pcg.list_debug_nodes (risco 0, UE 5.2+, requer plugin PCG, smoke)​

Inspects list debug nodes for one graph.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: values, items, count, message.

pcg.list_edge_pairs (risco 0, UE 5.2+, requer plugin PCG, smoke)​

Inspects list edge pairs for one graph.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: values, items, count, message.

pcg.list_edges (risco 0, UE 5.2+, requer plugin PCG, smoke)​

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

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: edges, count.

pcg.list_filter_nodes (risco 0, UE 5.2+, requer plugin PCG, smoke)​

Inspects list filter nodes for one graph.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: values, items, count, message.

pcg.list_input_pins (risco 0, UE 5.2+, requer plugin PCG, smoke)​

Inspects list input pins for one graph.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: values, items, count, message.

pcg.list_instance_overrides (risco 0, UE 5.3+, requer plugin PCG, smoke)​

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

ArgumentoTipoDescrição
instancestringobrigatório. PCG graph instance asset path.

Retorna: parameters, count, readers, message.

pcg.list_metadata_nodes (risco 0, UE 5.2+, requer plugin PCG, smoke)​

Inspects list metadata nodes for one graph.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: values, items, count, message.

pcg.list_node_classes (risco 0, UE 5.2+, requer plugin PCG, smoke)​

Inspects list node classes for one graph.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: values, items, count, message.

pcg.list_node_positions (risco 0, UE 5.2+, requer plugin PCG, smoke)​

Inspects list node positions for one graph.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: values, items, count, message.

pcg.list_node_titles (risco 0, UE 5.2+, requer plugin PCG, smoke)​

Inspects list node titles for one graph.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: values, items, count, message.

pcg.list_nodes (risco 0, UE 5.2+, requer plugin PCG, smoke)​

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

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: nodes, count.

pcg.list_orphan_nodes (risco 0, UE 5.2+, requer plugin PCG, smoke)​

Inspects list orphan nodes for one graph.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: values, items, count, message.

pcg.list_output_pins (risco 0, UE 5.2+, requer plugin PCG, smoke)​

Inspects list output pins for one graph.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: values, items, count, message.

pcg.list_parameter_nodes (risco 0, UE 5.2+, requer plugin PCG, smoke)​

Inspects list parameter nodes for one graph.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: values, items, count, message.

pcg.list_parameters (risco 0, UE 5.3+, requer 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+.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: parameters, count, readers, message.

pcg.list_pins (risco 0, UE 5.2+, requer plugin PCG, smoke)​

Sem descrição.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
nodestringobrigatório. Node object name returned by list_nodes, or its authored title when unique.

Retorna: node, message.

pcg.list_placed_nodes (risco 0, UE 5.2+, requer plugin PCG, smoke)​

Inspects list placed nodes for one graph.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: values, items, count, message.

pcg.list_point_nodes (risco 0, UE 5.2+, requer plugin PCG, smoke)​

Inspects list point nodes for one graph.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: values, items, count, message.

pcg.list_sampler_nodes (risco 0, UE 5.2+, requer plugin PCG, smoke)​

Inspects list sampler nodes for one graph.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: values, items, count, message.

pcg.list_sink_nodes (risco 0, UE 5.2+, requer plugin PCG, smoke)​

Inspects list sink nodes for one graph.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: values, items, count, message.

pcg.list_source_nodes (risco 0, UE 5.2+, requer plugin PCG, smoke)​

Inspects list source nodes for one graph.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: values, items, count, message.

pcg.list_spatial_nodes (risco 0, UE 5.2+, requer plugin PCG, smoke)​

Inspects list spatial nodes for one graph.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: values, items, count, message.

pcg.list_spawner_nodes (risco 0, UE 5.2+, requer plugin PCG, smoke)​

Inspects list spawner nodes for one graph.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: values, items, count, message.

pcg.list_unconnected_nodes (risco 0, UE 5.2+, requer plugin PCG, smoke)​

Inspects list unconnected nodes for one graph.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: values, items, count, message.

pcg.list_unconnected_pins (risco 0, UE 5.2+, requer plugin PCG, smoke)​

Inspects list unconnected pins for one graph.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: values, items, count, message.

pcg.list_unplaced_nodes (risco 0, UE 5.2+, requer plugin PCG, smoke)​

Inspects list unplaced nodes for one graph.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: values, items, count, message.

pcg.list_volumes (risco 0, UE 5.2+, requer plugin PCG, requer mundo, smoke)​

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

ArgumentoTipoDescrição
graphstringOptional PCG graph asset path; when set only components/volumes using that graph are listed.

Retorna: volumes, count, message.

pcg.move_node (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Sem descrição.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
nodestringobrigatório. Node name.
xintegerGraph X. Padrão 0.
yintegerGraph Y. Padrão 0.

Retorna: node, message.

pcg.refresh (risco 2, altera, UE 5.4+, requer plugin PCG, requer mundo, smoke)​

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

ArgumentoTipoDescrição
actorstringobrigatório. Actor label, object name, or path.
componentstringPCG component name; may be empty only when the actor has exactly one PCG component.

Retorna: message, count, generating, cleaningUp.

pcg.remove_comment_box (risco 2, altera, UE 5.6+, requer plugin PCG, smoke)​

Removes a comment box by GUID. UE 5.6+.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
idstringobrigatório. Comment box GUID, or its exact comment text when unique.

Retorna: box, boxes, count.

pcg.remove_node (risco 3, altera, UE 5.2+, requer plugin PCG, smoke)​

Sem descrição.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
nodestringobrigatório. Node object name returned by list_nodes, or its authored title when unique.

Retorna: message, count, generating, cleaningUp.

pcg.remove_nodes (risco 3, altera, UE 5.2+, requer plugin PCG, smoke)​

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

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
nodesarray of stringobrigatório. Node names or unique titles; all are resolved before anything is removed.

Retorna: nodes, count.

pcg.remove_parameter (risco 3, altera, UE 5.5+, requer plugin PCG, smoke)​

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

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
namestringobrigatório. Parameter name.
forcebooleanRemove even when Get Graph Parameter nodes read it (they become invalid). Padrão false.

Retorna: parameters, count, readers, message.

pcg.remove_volume (risco 3, altera, destrutivo, UE 5.2+, requer plugin PCG, requer mundo, smoke)​

Sem descrição.

ArgumentoTipoDescrição
actorstringobrigatório. Actor label, object name, or path.

Retorna: message, count, generating, cleaningUp.

pcg.rename (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Sem descrição.

ArgumentoTipoDescrição
graphstringobrigatório. Graph asset.
namestringobrigatório. Bare new name.

Retorna: asset, nodeCount, message.

pcg.rename_parameter (risco 2, altera, UE 5.6+, requer plugin PCG, smoke)​

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

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
namestringobrigatório. Current parameter name.
newNamestringobrigatório. New parameter name (valid identifier).

Retorna: parameters, count, readers, message.

pcg.reset_node_setting (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

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

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
nodestringobrigatório. Node name or title.
propertystringobrigatório. Editable property path, e.g. PointsPerSquaredMeter or SamplerParams.Mode.

Retorna: node, values, count, message.

pcg.save (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Sem descrição.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

Retorna: asset, nodeCount, message.

pcg.set_actor_selector (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

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

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
nodestringobrigatório. 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...

Retorna: node, values, count, message.

pcg.set_add_tags (risco 2, altera, UE 5.4+, requer plugin PCG, smoke)​

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

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
nodestringobrigatório. Add Tags node name or title.
tagsarray of stringobrigatório. Tags added to every data item (no commas inside a tag).

Retorna: node, values, count, message.

pcg.set_attribute_selector (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

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

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
nodestringobrigatório. Node name or title.
propertystringobrigatório. Selector property path, e.g. InputSource, OutputTarget, Parameters.ComparisonSource.
selectorstringobrigatório. Selector text: an attribute name, $Property (e.g. $Density, $Position.Z) or @Last.

Retorna: node, values, count, message.

pcg.set_bounds_modifier (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

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

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
nodestringobrigatório. Bounds Modifier node name or title.
modestringEPCGBoundsModifierMode: Set, Intersect, Include, Translate, Scale.
setBoundsbooleanWrite boundsMin/boundsMax. Padrão false.
boundsMin{x,y,z}Bounds min operand. Padrão FUeaVec3(1,1,1).
boundsMax{x,y,z}Bounds max operand. Padrão FUeaVec3(1,1,1).
affectSteepnessstring"true"/"false": also change the point steepness.
steepnessnumberSteepness 0..1. Padrão -1.

Retorna: node, values, count, message.

pcg.set_component (risco 2, altera, UE 5.2+, requer plugin PCG, requer mundo, smoke)​

Sem descrição.

ArgumentoTipoDescrição
actorstringobrigatório. Actor reference.
componentstringComponent name.
graphstringOptional graph asset path.
seedintegerSeed, or -1 to leave unchanged. Padrão -1.
activatedstringOptional activated state: true or false.
generationTriggerstringOptional public generation trigger enum text.

Retorna: component, message.

pcg.set_component_inspection (risco 1, UE 5.8+, requer plugin PCG, requer mundo, smoke)​

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

ArgumentoTipoDescrição
actorstringobrigatório. 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. Padrão true.

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

pcg.set_component_parameter_override (risco 2, altera, UE 5.4+, requer plugin PCG, requer mundo, smoke)​

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

ArgumentoTipoDescrição
actorstringobrigatório. Actor label, object name, or path.
componentstringPCG component name; may be empty only when the actor has exactly one PCG component.
namestringobrigatório. Graph parameter name.
valuestringOverride value in UE text form (ignored by clear).

Retorna: component, parameters, count, message.

pcg.set_create_points (risco 2, altera, UE 5.4+, requer plugin PCG, smoke)​

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

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
nodestringobrigatório. Create Points node name or title.
pointsarray of {x,y,z}obrigatório. Point locations (cm) in coordinateSpace.
extents{x,y,z}Half size of every point (cm, > 0). Padrão FUeaVec3(50,50,50).
densitynumberDensity of every point 0..1. Padrão 1.
coordinateSpacestringEPCGCoordinateSpace: World, OriginalComponent, LocalComponent; empty keeps the current one.

Retorna: node, values, count, message.

pcg.set_create_points_grid (risco 2, altera, UE 5.4+, requer plugin PCG, smoke)​

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

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
nodestringobrigatório. 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+). Padrão -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.

Retorna: node, values, count, message.

pcg.set_delete_tags (risco 2, altera, UE 5.4+, requer plugin PCG, smoke)​

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

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
nodestringobrigatório. Delete Tags node name or title.
tagsarray of stringobrigatório. Selected tags (no commas inside a tag).
operationstringEPCGTagFilterOperation: DeleteSelectedTags, KeepOnlySelectedTags; empty keeps the current one.

Retorna: node, values, count, message.

pcg.set_density_filter (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Sets the density band and inversion of a Density Filter.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
nodestringobrigatório. Density Filter node name or title.
lowerBoundnumberLowest kept density 0..1. Padrão -1.
upperBoundnumberHighest kept density 0..1. Padrão -1.
invertFilterstring"true"/"false": keep the points outside the band instead.

Retorna: node, values, count, message.

pcg.set_density_noise (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

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

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
nodestringobrigatório. Density noise node name or title (created by pcg.add_density_noise).
modestringNoise mode: Set, Minimum, Maximum, Add, Multiply.
setRangebooleanWrite noiseMin/noiseMax. Padrão false.
noiseMinnumberLowest random value. Padrão 0.
noiseMaxnumberHighest random value. Padrão 1.
invertSourcestring"true"/"false": invert the source value before applying.

Retorna: node, values, count, message.

pcg.set_difference (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

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

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
nodestringobrigatório. Difference node name or title.
densityFunctionstringEPCGDifferenceDensityFunction: Minimum, ClampedSubstraction, Binary.
modestringEPCGDifferenceMode: Inferred, Continuous, Discrete.
diffMetadatastring"true"/"false": diff metadata as well.

Retorna: node, values, count, message.

pcg.set_distance (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

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

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
nodestringobrigatório. Distance node name or title.
maximumDistancenumberMaximum distance in cm (> 0). Padrão -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.

Retorna: node, values, count, message.

pcg.set_graph_settings (risco 2, altera, UE 5.2+, requer 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.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
settingsarray of UeaKeyValueobrigatório. Key/value pairs; keys as returned by pcg.get_graph_settings (hierarchicalGeneration, hiGenGridSize, use2DGrid, landscapeUsesMetadata, exposeToLibrary, category, description...), values in UE text form.

Retorna: graph, settings, unavailable.

pcg.set_instance_graph (risco 2, altera, UE 5.4+, requer 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+.

ArgumentoTipoDescrição
instancestringobrigatório. PCG graph instance asset path.
graphstringobrigatório. New parent PCG graph or graph instance; must not create a cycle.

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

pcg.set_instance_override (risco 2, altera, UE 5.4+, requer plugin PCG, smoke)​

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

ArgumentoTipoDescrição
instancestringobrigatório. PCG graph instance asset path.
namestringobrigatório. Parameter name.
valuestringobrigatório. Override value in UE text form.

Retorna: parameters, count, readers, message.

pcg.set_mesh_spawner_meshes (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

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

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
nodestringobrigatório. Static Mesh Spawner node name or title.
meshesarray of stringobrigatório. Static mesh asset paths (at least one).
weightsarray of integerOne weight (> 0) per mesh; empty gives every mesh weight 1.

Retorna: node, values, count, message.

pcg.set_node_comment (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Sets or clears the node comment bubble.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
nodestringobrigatório. Node name or title.
commentstringComment text; empty clears it.
bubbleVisiblebooleanShow the comment bubble in the graph editor. Padrão true.

Retorna: node, message.

pcg.set_node_debug (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

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

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
nodestringobrigatório. Node name or title.
debugbooleanNew debug state (transient: draws the node output in the level on next generation, not saved). Padrão true.

Retorna: node, message.

pcg.set_node_enabled (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

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

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
nodestringobrigatório. Node name or title.
enabledbooleanNew enabled state (disabled nodes pass their input through). Padrão true.

Retorna: node, message.

pcg.set_node_setting (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

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

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
nodestringobrigatório. Node name.
propertystringobrigatório. Reflected setting property path; dots enter structs and instanced sub-objects (MeshSelectorParameters.MeshEntries).
valuestringUE text-import value (ignored by get_node_setting).

Retorna: node, message.

pcg.set_node_settings (risco 2, altera, UE 5.2+, requer 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.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
nodestringobrigatório. Node name or title.
settingsarray of UeaKeyValueobrigatório. Property path/value pairs; all are validated on a scratch copy before the node is changed.

Retorna: node, properties, count.

pcg.set_node_title (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

Sem descrição.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
nodestringobrigatório. Node object name.
titlestringAuthored title; empty clears it.

Retorna: node, message.

pcg.set_normal_to_density (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

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

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

Retorna: node, values, count, message.

pcg.set_parameter (risco 2, altera, UE 5.5+, requer 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+.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
namestringobrigatório. Parameter name.
valuestringobrigatório. New default value in UE text form, validated against the parameter type.

Retorna: parameters, count, readers, message.

pcg.set_self_pruning (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

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

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
nodestringobrigatório. Self Pruning node name or title.
pruningTypestringEPCGSelfPruningType: LargeToSmall, SmallToLarge, AllEqual, None, RemoveDuplicates.
radiusSimilarityFactornumberRadius similarity factor (>= 0). Padrão -1.
randomizedPruningstring"true"/"false": randomize the pruning order.

Retorna: node, values, count, message.

pcg.set_spline_sampler (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

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

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
nodestringobrigatório. 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). Padrão -1.
distanceIncrementnumberDistance between points in cm (Distance mode, > 0). Padrão -1.
interiorSampleSpacingnumberInterior sample spacing in cm (OnInterior, > 0). Padrão -1.
projectOntoSurfacestring"true"/"false": project interior samples onto the surface.

Retorna: node, values, count, message.

pcg.set_subgraph (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

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

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path that owns the node.
nodestringobrigatório. Subgraph or Loop node name or title.
subgraphstringobrigatório. PCG graph asset executed by the node (not the owning graph).

Retorna: node, values, count, message.

pcg.set_surface_sampler (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

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

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

Retorna: node, values, count, message.

pcg.set_transform_points (risco 2, altera, UE 5.2+, requer plugin PCG, smoke)​

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

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
nodestringobrigatório. Transform Points node name or title.
setOffsetbooleanWrite offsetMin/offsetMax. Padrão false.
offsetMin{x,y,z}Minimum random offset (cm).
offsetMax{x,y,z}Maximum random offset (cm).
setRotationbooleanWrite rotationMin/rotationMax. Padrão 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. Padrão false.
scaleMin{x,y,z}Minimum random scale (x only is used when uniformScale). Padrão FUeaVec3(1,1,1).
scaleMax{x,y,z}Maximum random scale. Padrão 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.

Retorna: node, values, count, message.

pcg.update_comment_box (risco 2, altera, UE 5.6+, requer plugin PCG, smoke)​

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

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.
idstringobrigatório. Comment box GUID from list/add, or its exact comment text when unique.
commentstringNew text; empty leaves it unchanged.
movebooleanApply x/y. Padrão false.
xintegerPadrão 0.
yintegerPadrão 0.
resizebooleanApply width/height. Padrão false.
widthintegerPadrão 400.
heightintegerPadrão 100.
fontSizeintegerNew font size; 0 leaves it unchanged. Padrão 0.
setColorbooleanApply color. Padrão false.
color{x,y,z}RGB color 0..1. Padrão FUeaVec3(1,1,1).

Retorna: box, boxes, count.

pcg.validate (risco 0, UE 5.3+, requer 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+.

ArgumentoTipoDescrição
graphstringobrigatório. PCG graph asset path.

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

pcg.wait_generation (risco 0, UE 5.2+, requer plugin PCG, requer mundo, 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.

ArgumentoTipoDescrição
actorstringobrigatório. 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. Padrão 300.

Retorna: message, count, generating, cleaningUp.