Blueprint Developer API
Editor Utility Blueprint and Editor Utility Widget authors should use Locus’s curated async nodes. The lower-level reflected request objects are shared infrastructure for Python and are not the normal Blueprint workflow.
Find nodes in the Blueprint palette under Locus > Notes, Locus > Documents, and Locus > Pins.
Available nodes
Section titled “Available nodes”| Category | Nodes |
|---|---|
| Locus > Notes | List Locus Notes, Get Locus Note, Search Locus Notes, Create Locus Note, Update Locus Note, Archive Locus Note |
| Locus > Documents | List Locus Documents, Get Locus Document, Search Locus Documents, Create Locus Document, Update Locus Document |
| Locus > Pins | List Locus Pins, Get Locus Pin, Create Locus Pin, Update Locus Pin Metadata, Add Locus Pin Comment |
Async outcomes
Section titled “Async outcomes”Each node exposes terminal Succeeded and Failed execution outputs. The node deliberately has no immediate completion path that could be mistaken for the asynchronous result.
Both outcomes expose:
- a typed Result;
- provider-neutral Operation Status;
- a typed Error.
On failure, branch on Error > Code rather than parsing Message. The exposed Async Action proxy provides cooperative Cancel for work that has not begun executing. Cancellation does not interrupt a mutation already being committed.
Create a Document
Section titled “Create a Document”Add Create Locus Document and provide:
- Path: a path relative to the selected visible root, such as
Design/Combat.md; - Markdown: the initial source, such as
# Combat; - Presentation Root: Locus Documents or Content Browser.
Use the Succeeded result’s Identity > Relative Path as the authoritative
Document identity. Do not substitute its presentation path or /Game/...
context.
Revision-safe Note update
Section titled “Revision-safe Note update”- Use Get Locus Note and retain its Identity and Revision outputs.
- Make a Locus Developer Note Changes struct.
- Set only the
Set ...intent flags for fields you want to modify. - Call Update Locus Note with Identity, the read revision as Expected Revision, and Changes.
- Follow Succeeded or inspect Failed > Error > Code. On Stale Revision, get the Note again and reconsider the update.
The change struct distinguishes unchanged, set, and clear:
| Values | Meaning |
|---|---|
Set Title = false |
Leave Title unchanged; the Title value is ignored |
Set Title = true, Title = "New Title" |
Set a non-empty title |
Set Title = true, Title = "" |
Explicitly request an empty title, subject to domain validation |
The same pattern applies to Note body, tags, and status. After success, use the new result revision for the next mutation.
Pin metadata changes use Set Title, Set Description, Set Pin Type, and Set Tags with the same intent rules. Update Locus Pin Metadata preserves the Pin’s world, position, anchor, view, and scope.
Create Locus Pin accepts explicit scope, saved-world asset path, world-space
location, and title. Advanced inputs include world label, description, Pin
type, and tags. The world path must identify a supported saved project-owned
world, for example /Game/Maps/Main.Main.
Blueprint can list and get Pins, create the safe basic Pin form, update metadata, and add comments. The Developer API does not expose Pin repositioning or arbitrary anchor replacement.
See the Developer API overview for revisions, typed errors, operation status, scope, and the complete capability matrix.