UPCGToolset

Toolset for building and modifying PCG graphs

API > API/Plugins > API/Plugins/PCGToolset

Toolset for building and modifying PCG graphs

   
Name UPCGToolset
Type class
Header File /Engine/Plugins/Experimental/Toolsets/PCGToolset/Source/PCGToolset/Public/PCGToolset.h
Include Path #include "PCGToolset.h"

Syntax

UCLASS (BlueprintType)  
class UPCGToolset : public UToolsetDefinition

Inheritance Hierarchy

Functions

Static

Name Remarks Include Path Unreal Specifiers

static FString AddCommentBox ( UPCGGraph* Graph,
const TArray< UPCGNode* >& Nodes,
const FString& Comment,
FLinearColor Color
)

 Adds a comment box around the given nodes. PCGToolset.h
  • Meta=(AICallable)
  • Category="PCG|CommentBox"

static UPCGNode * AddNode ( UPCGGraph* Graph,
const FString& NativeNodeType,
const FString& NodeName,
const FString& JsonParams,
const FString& NodeTitle,
const FString& NodeComment,
const int32 XPositionIdx,
const int32 YPositionIdx
)

 Adds a native node to the graph. PCGToolset.h
  • Meta=(AICallable)
  • Category="PCG|Nodes"

static UPCGNode * AddSubgraphNode ( UPCGGraph* Graph,
UPCGGraph* SubGraphForNode,
const FString& NodeName,
const FString& JsonParams,
const FString& NodeTitle,
const FString& NodeComment,
const int32 XPositionIdx,
const int32 YPositionIdx
)

 Adds a subgraph node to the graph. PCGToolset.h
  • Meta=(AICallable)
  • Category="PCG|Nodes"

static TArray< UPCGNode * > ConnectNodePins ( UPCGNode* FromNode,
const FString& FromPinLabel,
UPCGNode* ToNode,
const FString& ToPinLabel
)

 Add an edge between two nodes connected to the specified pins. PCGToolset.h
  • Meta=(AICallable)
  • Category="PCG|Nodes"

static UPCGGraph * CreateGraph ( const FString& Name,
const FString& Path
)

 Graph --------------------------------------------------------------------------------------------------------. PCGToolset.h
  • Meta=(AICallable)
  • Category="PCG|Graph"

static bool DisconnectNodePins ( UPCGNode* FromNode,
const FString& FromPinLabel,
UPCGNode* ToNode,
const FString& ToPinLabel
)

 Removes the edge between two nodes connected to the specified pins. PCGToolset.h
  • Meta=(AICallable)
  • Category="PCG|Nodes"

static UToolCallAsyncResultVoid * DrawSpline ( const FString& ActorLabel,
const FString& ActorTag,
bool bRedraw,
bool bClosedSpline
)

 Triggers the user to draw a spline in the viewport to be used later in the world building. PCGToolset.h
  • Meta=(AICallable)
  • Category="PCG|Other"

static UPCGExecuteGraphInstanceAsyncResult * ExecuteGraphInstance ( const APCGVolume* PCGVolume
)

 Graph Instance Params -----------------------------------------------------------------------------------------. PCGToolset.h
  • Meta=(AICallable, NonTransactableToolCall)
  • Category="PCG|GraphInstanceParams"

static FString GetGraphDescription ( const UPCGGraph* Graph
)

 Returns the description of a PCG graph. PCGToolset.h
  • Meta=(AICallable)
  • Category="PCG|GraphParams"

static FInstancedPropertyBag GetGraphInstanceParams ( const APCGVolume* PCGVolume
)

 Gets the graph instance params of a specific actor, actor MUST have a graph instance PCGToolset.h
  • Meta=(AICallable)
  • Category="PCG|GraphInstanceParams"

static FPCGGraphSchema GetGraphSchema ( const UPCGGraph* Graph
)

 Returns the schema for a PCG Graph's graph parameters PCGToolset.h
  • Meta=(AICallable)
  • Category="PCG|GraphParams"
Graph Params --------------------------------------------------------------------------------------------------. PCGToolset.h
  • Meta=(AICallable)
  • Category="PCG|GraphParams"

static FPCGNativeNodeSchema GetNativeNodeSchema ( const FString& NodeName
)

 Returns the schema for a PCG node type including input/output pins, parameters, and their types. PCGToolset.h
  • Meta=(AICallable)
  • Category="PCG|Nodes"

static FString GetNodeDataView ( const APCGVolume* PCGVolume,
const UPCGNode* Node,
const FString& PinLabel,
const FString& AttributeName,
const int32 StartIndex,
const int32 EndIndex
)

 Returns a JSON Data View of a specific node's output data from the last graph execution. PCGToolset.h
  • Meta=(AICallable)
  • Category="PCG|Data"

static FPCGNodeInfo GetNodeInfo ( const UPCGNode* Node
)

 Returns node details including name, position, and all parameter values. PCGToolset.h
  • Meta=(AICallable)
  • Category="PCG|Nodes"
Lists the PCG graphs that can be used with the Subgraph native node. PCGToolset.h
  • Meta=(AICallable)
  • Category="PCG|Nodes"

static TArray< FPCGGraphInstanceInfo > ListGraphInstances()

 Graph Instance -----------------------------------------------------------------------------------------------. PCGToolset.h
  • Meta=(AICallable)
  • Category="PCG|GraphInstance"

static TArray< FString > ListNativeNodes ( const bool bCommonOnly
)

 Nodes -------------------------------------------------------------------------------------------------------. PCGToolset.h
  • Meta=(AICallable)
  • Category="PCG|Nodes"

static bool RemoveCommentBox ( UPCGGraph* Graph,
const FString& CommentId
)

 Removes a comment box from the graph. Does not affect the nodes it contains. PCGToolset.h
  • Meta=(AICallable)
  • Category="PCG|CommentBox"

static bool RemoveGraphParams ( UPCGGraph* Graph,
const TArray< FName >& ParamNames
)

 Removes graph parameters to a specific PCG graph, such that they are not overridable anymore. PCGToolset.h
  • Meta=(AICallable)
  • Category="PCG|GraphParams"

static bool RemoveNode ( UPCGGraph* Graph,
UPCGNode* Node
)

 Removes the node from the graph, will also remove edges connected to the node. PCGToolset.h
  • Meta=(AICallable)
  • Category="PCG|Nodes"

static bool RepositionNode ( UPCGNode* Node,
const int32 XPositionIdx,
const int32 YPositionIdx
)

 Change the position of node. PCGToolset.h
  • Meta=(AICallable)
  • Category="PCG|Nodes"

static bool ResetGraphInstanceParams ( const APCGVolume* PCGVolume,
const TArray< FName >& ParamNames
)

 Resets the given graph instance params back to the graph's default values. PCGToolset.h
  • Meta=(AICallable)
  • Category="PCG|GraphInstanceParams"

static bool SetGraphDescription ( UPCGGraph* Graph,
const FString& Description
)

 Set the description of a PCGGraph PCGToolset.h
  • Meta=(AICallable)
  • Category="PCG|GraphParams"

static bool SetGraphInstanceParams ( const APCGVolume* PCGVolume,
const FString& JsonParams
)

 Sets the graph instance params of a specific actor, actor MUST have a graph instance PCGToolset.h
  • Meta=(AICallable)
  • Category="PCG|GraphInstanceParams"

static bool SetGraphParams ( UPCGGraph* Graph,
const TArray< FPCGParamDefinition >& Params
)

 Adds one or more graph user parameters to a specific PCG graph, such that they will be overridable in per graph instance. PCGToolset.h
  • Meta=(AICallable)
  • Category="PCG|GraphParams"

static bool SetNodeComment ( UPCGNode* Node,
const FString& NodeComment
)

 Change the comment on the specified node. PCGToolset.h
  • Meta=(AICallable)
  • Category="PCG|Nodes"

static FPCGGraphInstanceInfo SpawnGraphInstance ( UPCGGraph* Graph,
const FString& Name,
const FTransform& Transform,
const FString& JsonParams
)

 Spawns a PCG Volume with associated Graph Instance into the scene, optionally with Graph Param overrides. PCGToolset.h
  • Meta=(AICallable)
  • Category="PCG|GraphInstance"

static bool UpdateCommentBox ( UPCGGraph* Graph,
const FString& CommentId,
const TArray< UPCGNode* >& Nodes,
const FString& Comment,
FLinearColor Color
)

 Updates an existing comment box with new nodes and value. PCGToolset.h
  • Meta=(AICallable)
  • Category="PCG|CommentBox"

static bool UpdateNode ( UPCGNode* Node,
const FString& JsonParams,
const FString& NodeTitle
)

 Updates a node by changing its params and/or title. PCGToolset.h
  • Meta=(AICallable)
  • Category="PCG|Nodes"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page