Skip to content

Editor panel

The Blueprint Scribe panel is where you scan Blueprints, browse what was found, review the audit findings and the C++ candidates, and export the documentation. It has a header with the main buttons, a summary row, four pages (Blueprints, Audit, C++ migration and Export) and a footer with the status line.

You can open the panel from these places:

Where Entry What happens
Tools menu ta Blueprint Scribe, in the tridiART section Opens the panel.
Content Browser, right-click on folders Document and Audit Blueprints Opens the panel and scans the selected folders and their subfolders.
Content Browser, right-click on assets Document and Audit Opens the panel and scans the selected assets. Shown when the selection contains a Blueprint, structure or enum.
Content Browser, right-click on assets Export Blueprint Docs Scans the selected assets and exports their documentation right away, with the options of the Export page.
Blueprint editor toolbar Scribe Scans the Blueprint you are editing and selects it on the Blueprints page. Available in the Blueprint, Widget Blueprint and Animation Blueprint editors.

The panel opens as a regular editor tab that you can dock anywhere. Its layout adapts to its width: in a narrow tab the buttons, tiles and details wrap and some table columns are hidden (see Narrow panels).

Next to the title (ta Blueprint Scribe, “Document and audit your Blueprints”) are four buttons:

Button What it does
Scan selection Scans what is selected in the Content Browser. If assets are selected, only those assets are scanned. If only folders are selected, the folders and their subfolders are scanned. With nothing selected, the status line says “Nothing is selected in the Content Browser.”
Scan project Scans the Included Paths from the settings (by default /Game).
Export docs Writes the documentation (HTML, Markdown, JSON, AI-ready text) of all scanned assets with the options of the Export page. Available after a scan that found at least one asset.
Settings (gear icon) Opens Project Settings > Plugins > ta Blueprint Scribe.

Before the first scan, the panel shows Scan project and Scan selection buttons in its center as well.

A scan loads each Blueprint, structure and enum in its scope once, documents it, runs the audit rules and computes the complexity and C++ scores. Other asset types in the scope are ignored. A progress dialog (Documenting Blueprints…) shows the asset being documented; if you click Cancel, the panel shows the assets documented so far.

  • Folder scans (Scan project, Scan selection with folders, Document and Audit Blueprints) skip the Excluded Paths from the settings and World Partition __ExternalActors__ and __ExternalObjects__ folders.
  • Assets you select directly are scanned even if they are in an excluded folder.
  • If you start a folder scan right after the editor opened, while the Asset Registry is still discovering assets, the status line says “Waiting for the Asset Registry to finish discovering assets; the scan starts on its own.” The scan then starts by itself.

When the scan is done, the status line shows a summary in this form:

Scanned <assets> assets of <scope> in <seconds>s: <errors> errors, <warnings> warnings, <suggestions> suggestions.

The scope is the scanned folders, or the names of the selected assets (“N selected assets” when more than five were selected).

If the scope contains no supported assets, it says “No Blueprints, structures or enums were found in the scanned scope.”

The summary row shows the results of the last scan:

Item Shows
Blueprint health ring The health score from 0 to 100, and below it “N of M assets without warnings”. The ring is green from 80, amber from 50 and red below 50. Before the first scan it shows - and “Not scanned yet”.
Blueprints Number of Blueprints. Hover it to see the number of structures and enums.
Nodes Nodes in all graphs, without comments and reroute nodes.
Documented Documentation coverage of all scanned assets.
Complexity Average complexity of the Blueprints with logic, from 0 (simple) to 100 (very complex).
Errors, Warnings, Suggestions Number of findings with severity Error, Warning and Info. Click a tile to open the Audit page filtered to that severity.

The health score is the share of scanned assets that have no Error or Warning finding, rounded to a whole number. Info findings (suggestions) don’t lower it. The documentation coverage is the number of documented members divided by the number of members that can have a description, over all scanned assets. See Health and coverage for what counts.

The Blueprints tab (with the number of scanned assets) has the list of assets and the details of the selected asset. In a wide panel the details are on the right; in a narrower one they are below the list.

  • Search (Search Blueprints, folders, descriptions…): matches the asset name, package path, description and kind.
  • Copy for AI: copies every asset in the list, as it is filtered, as compact text for AI assistants. See AI export.
  • Clean up: opens the cleanup preview for every Blueprint in the list. See Cleanup.
  • Kind chips: All and one chip per asset kind found in the scan (Actor, Component, Object, Widget, Animation, Interface, Function Library, Macro Library, Structure, Enum), each with its count.
  • Sort: click a column header. The list is sorted by name by default.
Column Shows
Name Thumbnail, asset name and folder
Kind Asset kind
Nodes Nodes in all graphs of the asset
Complexity Complexity score, green below 50, amber from 50, red from 75. Hover it for the label and what the score is made of. - for assets without logic.
C++ C++ migration score, green below 30, amber from 30, red from 60. Hover it for the verdict. - for assets without logic.
Documented Documentation coverage of the asset, with a bar that is green from 80 %, amber from 50 % and red below
Hard refs Disk size of everything the asset loads through hard references (– when it loads nothing). Hover to see the number of packages.
Findings Number of findings per severity. Sorting by this column orders by errors, then warnings, then suggestions.

Double-click an asset to open it in its editor.

Select an asset to see its details. With nothing selected, the area says “Select a Blueprint to see its documentation and findings.”

  • Thumbnail, name, kind and package path.
  • Buttons: Open (opens the asset editor), Browse (shows the asset in the Content Browser), Copy for AI (copies this asset for AI assistants), Clean up (opens the cleanup preview for this Blueprint; not available for structures, enums and interfaces) and Export page (exports the documentation of this asset only and opens it).
  • The description, or “No description. Add one in Class Settings > Description.”
  • Facts: Parent (the parent class chain), Interfaces, Category, Skeleton, Compile, Size (nodes, graphs and the largest graph), Complexity and C++ candidate (score and label or verdict; only for assets with logic), Hard references (size and number of assets), Used by, Members (counts of variables or fields, functions, events, dispatchers, macros, components, widgets and entries) and Documented (coverage with “documented of documentable”).
  • C++ migration: the C++ score, the verdict, the reasons (lines starting with -) and the upgrade notes (lines starting with !), or “Nothing that needs C++.”
  • Findings (N): every finding of the asset with its rule and message. The button next to a finding (Go to node or Open) opens the Blueprint at the node, or opens the asset. “No findings.” when there are none.
  • Graphs (N): every graph with its kind and node count. Sub-graphs are indented under their parent graph. Node counts above Max Nodes Per Graph are shown in amber. Click a graph to open it in the Blueprint editor.

The Audit tab (with the number of findings) lists every finding of the last scan, errors first.

  • Chips: All, Errors, Warnings and Suggestions, each with its count.
  • Search (Search findings, assets, rules…): matches the asset name, the message and the rule name.
Column Shows
Severity Icon and severity (Error, Warning or Suggestion)
Asset Thumbnail, asset name and folder
Rule Rule name, for example Event Tick
Message The finding
Action A button that depends on where the finding points
Button Opens
Go to node The Blueprint editor with the node focused
Open graph The Blueprint editor at the graph
Open The asset editor

Double-clicking a row does the same. If the asset can’t be opened, the status line says “Could not open” and the asset name.

With no findings the page says “No findings. Your Blueprints look healthy.” If the filters hide everything, it says “No findings match the filter.”

The C++ migration tab (with the number of Blueprints that score 30 or more) ranks the Blueprints by their C++ score, with the verdict, the reasons and the notes for the next engine upgrade. Click Details on a row, or double-click it, to show the Blueprint on the Blueprints page. See C++ migration report for the columns and how the score is computed.

The Export tab sets the options of Export docs, Export page and Export Blueprint Docs. The options start with the values from Project Settings > Plugins > ta Blueprint Scribe when the panel opens. Changes made here apply to exports from this panel and are not written back to the settings.

Option Default Meaning
Output folder Saved/BlueprintScribe Where the docs are written. Relative paths start at the project folder; hover the field to see the full path. The folder button picks a folder; folders inside the project are stored as relative paths.
Title Empty Used as the site title and in headers. When empty, the project name followed by “Blueprints” is used, as the hint text shows.
Formats: HTML site, Markdown, JSON, AI-ready text All on Which outputs to write. At least one is needed. AI-ready text is described in AI export.
Graph images: Include On A PNG of every graph. See Graph images.
Zoom (0.25 - 2.0) 1.0 Zoom of the graph images. Available when Include is on.
Max size (512 - 16384) 4096 Longest side of a graph image in pixels. Available when Include is on.
Content: Private members On Private variables and functions. Also applies to Copy for AI.
Content: Audit findings On Findings on the pages and audit.html.
Content: Credit line On The “Generated with ta Blueprint Scribe” line at the bottom of the pages. See Credit line.

Below the options, the page says how many scanned assets will be exported (“Exports the N scanned assets.”), or “Scan the project or a selection first.”, and has its own Export docs button.

During an export, a Rendering graph images… progress dialog appears while the images are drawn. Cancelling it skips the remaining images; the pages are still written.

The Last export card says “Nothing exported yet.” until the first export. After an export it shows how many pages and graph images were written, the folder and the time, followed by any warnings or errors, and two buttons: Open in browser (opens index.html, or the Markdown index, scribe.json or ai/blueprints.md when HTML is off) and Open folder. With Open After Export enabled in the settings (the default), the start page opens automatically. The status line and a notification report the result as well.

The bottom of the panel shows the result of the last scan, export, copy or cleanup on the left. Problems, such as an export with warnings, are marked with a warning icon. On the right are “by tridiART” and the links Website, Contact and Documentation, and the plugin version. In a narrow panel the links move under the status line.

The panel rearranges itself when its tab is narrow, so you can dock it at the side of the editor:

Panel width Changes
Below 1700 pixels The summary shows the health ring with three tiles in the first row and the other four in the second.
Below 1100 pixels The header buttons go below the title (the settings button stays next to it). The health ring gets a row of its own, followed by two rows of smaller tiles. The Blueprint details move below the list. The Audit page hides the Rule column, the severity text, the thumbnails and the button labels; the C++ migration page hides the #, Kind, Complexity and Action columns and the thumbnails. The Export page shows the Last export card below the options, with each option’s label above its controls.
Below 800 pixels Only Name, Complexity and Findings stay in the Blueprints table, the kind chips are hidden, and Copy for AI and Clean up go below the search box. The summary tiles show only their numbers; the label is in the tooltip. In the details, the C++ migration, findings and graphs cards go below the facts.

The widths are in real screen pixels, independent of the editor’s DPI scale.