Splicing Juncture

bpgraph format, version 1

Blueprint Graph Exporter writes one JSON file per asset (<package path>.bpgraph.json). The format describes a Blueprint without depending on any language. It's the front end for tools that read Blueprints: diff and review tools, documentation generators, AI assistants, and code generators (our own Blueprint-to-C++ tools read exactly this).

Top level (every file)

Key Type Meaning
format "bpgraph" Always.
formatVersion number 1.
exporter string e.g. "Blueprint Graph Exporter 1.0.0".
engine string Engine version that exported it, e.g. "5.7.0".
assetKind "blueprint", "struct" or "enum" Which of the shapes below follows.
path string Object path, e.g. /Game/Export/BP_Door.BP_Door.
name string Asset name.

Pin type (type objects)

Used for variables, pins, struct members and function parameters. It mirrors Unreal's FEdGraphPinType.

Key Type Meaning
category string Always. exec, bool, byte, int, int64, real, name, string, text, struct, object, class, softobject, softclass, interface, enum, delegate, mcdelegate, wildcard, ...
subCategory string e.g. double or float for real; self for self references.
object string Path of the struct, enum or class the type refers to (/Script/CoreUObject.Vector, /Game/Data/S_Item.S_Item).
member string Delegate signature name, for delegate pins.
container "none", "array", "set", "map" Always.
value object Map value type (category, subCategory, object), for maps only.
reference true Passed by reference.
const true Const.
text string Always. The type as the editor shows it, e.g. Float (double-precision) or Array of S Item Structures. For people, not for parsing.

Blueprint (assetKind: "blueprint")

Key Type Meaning
assetClass string /Script/Engine.Blueprint, /Script/UMGEditor.WidgetBlueprint, ...
blueprintType string BPTYPE_Normal, BPTYPE_FunctionLibrary, BPTYPE_Interface, BPTYPE_MacroLibrary, BPTYPE_LevelScript, ...
parent string Parent class path (empty if missing).
generatedClass string e.g. /Game/Export/BP_Door.BP_Door_C.
description, category string From Class Settings, when set.
status string upToDate, warnings, error or notCompiled, as loaded.
interfaces string[] Always. Implemented interface paths.
variables variable[] Always. Member variables (see below).
components component[] Always. Components added in this Blueprint, as a tree.
inheritedComponentOverrides component[] Always. Components inherited from a parent Blueprint whose properties this Blueprint changes.
classDefaults object Class default values that differ from the parent class, { "Property": "value" } (authored names).
defaultSubobjects object[] C++ components and other default subobjects whose properties differ: name, class, properties.
timelines object[] Always. name, length, autoPlay, loop, tracks ("float:Alpha", "vector:...", "color:...", "event:...").
graphs graph[] Always. Every graph, including collapsed subgraphs.

Variable

Key Type Meaning
name string Variable name.
type pin type
category string Category in the My Blueprint panel.
default string Default value as Unreal text: the value in the compiled class defaults (what the Details panel shows). Local variables: the default typed into the variable.
tooltip string
flags string[] Always. Any of instanceEditable, readOnly, exposeOnSpawn, replicated, saveGame, transient, config, private.
repNotify string RepNotify function name.

Component

name, class, attachParent (the parent component or native component name), socket, properties (values that differ from the component class defaults), children (always, components attached to this one).

Graph

Key Type Meaning
name string Graph name (EventGraph, function name, ...).
kind string eventGraph, function, constructionScript, macro, delegate, interfaceFunction or subgraph (collapsed graphs, anim graphs, ...).
parentGraph string For subgraphs: the graph that contains it.
signature object Functions only: inputs and outputs (name, type), pure, const, static, access (public/protected/private), tooltip, category, locals (local variables, same shape as variables).
nodes node[] Always.

Nodes are sorted top to bottom, then left to right, and numbered N0, N1, ... in that order. The numbers are only unique within one graph. Use guid to follow a node across exports.

Node

Key Type Meaning
id string Always. N<number>, unique in the graph.
guid string Always. The node's GUID (stable across exports and renames).
class string Always. Node class path, e.g. /Script/BlueprintGraph.K2Node_CallFunction.
kind string Always. What the node does, see the table below.
(kind fields) See below.
title string Always. The title shown on the node, on one line.
x, y number Always. Position in the graph.
comment string The node's comment bubble.
disabled true The node is disabled (or a ghost node).
pins pin[] Always. Hidden pins are left out unless they're connected.
kind Extra fields Node
event event (function name, e.g. ReceiveBeginPlay), declaredIn (class), custom (bool) Events and custom events
functionEntry, functionResult Function entry and return nodes (the signature is on the graph)
call function (path, e.g. /Script/Engine.KismetSystemLibrary:PrintString), pure, static, latent, self (called on self), unresolved (true when the function can't be found; function then holds just its name) Function calls, including math and library calls
variableGet, variableSet variable, owner (self, local, or the class path) Variable get and set
branch, sequence, self, reroute, tunnel Branch, Sequence, Self, reroute knots, macro/collapsed graph entry and exit
cast targetClass, pure Cast To
macro macro (macro graph path) Macro instances (ForEach, ...)
timeline timeline Timeline nodes
comment text Comment boxes
switch on (pin category switched on), enum (for Switch on enum) Switch on Int / String / Name / enum
makeStruct, breakStruct, setStructMembers struct Make, Break, Set Members in
delegate operation (add, remove, call, clear), delegate (event dispatcher name) Bind / Unbind / Call / Unbind all on event dispatchers
arrayGet, makeArray, select, temporaryVariable, assign, enumEquality, formatText, spawnActor Get (array item), Make Array, Select, Local variable (macro), Assign, enum ==, Format Text, Spawn Actor from Class
other Anything else. class says what it is; pins and links are complete.

Pin

Key Type Meaning
name string Always. Pin name, unique per direction on its node (e.g. execute, then, InString, ReturnValue).
label string Display name, when it differs from name.
direction "in" or "out" Always.
type pin type Always.
default string Inputs that aren't connected: the value typed into the pin (object references as paths).
hidden true Hidden pin (only listed when connected).
links object[] Always. Connected pins: { "node": "N3", "pin": "execute" }. Links are listed on both ends.

Execution flows from an out pin of category exec to an in exec pin. Data flows from out data pins to in data pins.

Blueprint struct (assetKind: "struct")

tooltip, and members (always): name (as shown in the editor), internalName (the stored property name, Name_<n>_<GUID>, which saved data and CoreRedirects refer to), type, default, tooltip, saveGame.

Blueprint enum (assetKind: "enum")

values (always): name (stored name, e.g. NewEnumerator0), displayName (e.g. Walk), value (number). The generated _MAX entry is left out.

index.json

format: "bpgraph-index", formatVersion, exporter, assets (path, assetKind, file relative to the output folder, nodes), problems (strings).

Example (shortened)

{
	"format": "bpgraph",
	"formatVersion": 1,
	"assetKind": "blueprint",
	"path": "/Game/Export/BP_ExportSample.BP_ExportSample",
	"parent": "/Script/Engine.Actor",
	"graphs": [
		{
			"name": "EventGraph",
			"kind": "eventGraph",
			"nodes": [
				{
					"id": "N1",
					"class": "/Script/BlueprintGraph.K2Node_Event",
					"kind": "event",
					"event": "ReceiveBeginPlay",
					"pins": [
						{ "name": "then", "direction": "out", "type": { "category": "exec", "container": "none", "text": "Exec" },
						  "links": [ { "node": "N2", "pin": "execute" } ] }
					]
				},
				{
					"id": "N2",
					"kind": "call",
					"function": "/Script/Engine.KismetSystemLibrary:PrintString",
					"pins": [
						{ "name": "InString", "direction": "in", "type": { "category": "string", "container": "none", "text": "String" },
						  "default": "Hello export", "links": [] }
					]
				}
			]
		}
	]
}