Zum Inhalt springen
Suchen

Blueprint Developer API

Autoren von Editor Utility Blueprints und Editor Utility Widgets sollten die kuratierten asynchronen Locus-Knoten verwenden. Die niedriger liegenden reflektierten Anfrageobjekte sind gemeinsame Infrastruktur für Python und nicht der normale Blueprint-Workflow.

Sie finden die Knoten in der Blueprint-Palette unter Locus > Notes, Locus > Documents und Locus > Pins.

Kategorie Knoten
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

Jeder Knoten stellt die abschließenden Ausführungsausgänge Succeeded und Failed bereit. Der Knoten besitzt absichtlich keinen unmittelbaren Abschlussweg, der mit dem asynchronen Ergebnis verwechselt werden könnte.

Beide Ergebnisse stellen bereit:

  • ein typisiertes Result;
  • einen anbieterneutralen Operation Status;
  • einen typisierten Error.

Verzweigen Sie bei einem Fehler nach Error > Code, statt Message zu parsen. Der Async Action-Proxy stellt eine kooperative Cancel-Aktion für Arbeit bereit, die noch nicht begonnen hat. Eine bereits lokal gespeicherte Änderung wird durch die Abbruchaktion nicht unterbrochen.

Fügen Sie Create Locus Document hinzu und geben Sie Folgendes an:

  • Path: ein Pfad relativ zur ausgewählten sichtbaren Wurzel, etwa Design/Combat.md;
  • Markdown: die initiale Quelle, etwa # Combat;
  • Presentation Root: Locus Documents oder Content Browser.

Verwenden Sie Identity > Relative Path des Succeeded-Ergebnisses als maßgebliche Dokumentidentität. Ersetzen Sie sie nicht durch den Präsentationspfad oder den /Game/...-Kontext.

  1. Verwenden Sie Get Locus Note und behalten Sie die Ausgaben Identity und Revision.
  2. Erstellen Sie eine Struktur Locus Developer Note Changes.
  3. Setzen Sie nur die Set ...-Intent-Flags für Felder, die Sie ändern möchten.
  4. Rufen Sie Update Locus Note mit Identity, der gelesenen Revision als Expected Revision und Changes auf.
  5. Folgen Sie Succeeded oder prüfen Sie Failed > Error > Code. Bei Stale Revision lesen Sie die Notiz erneut und prüfen die Änderung.

Die Änderungsstruktur unterscheidet unverändert, setzen und löschen:

Werte Bedeutung
Set Title = false Titel unverändert lassen; der Titelwert wird ignoriert
Set Title = true, Title = "New Title" Einen nicht leeren Titel setzen
Set Title = true, Title = "" Einen leeren Titel ausdrücklich anfordern, vorbehaltlich der Domänenvalidierung

Dasselbe Muster gilt für Notizkörper, Tags und Status. Verwenden Sie nach Erfolg die neue Ergebnisrevision für die nächste Änderung.

Metadatenänderungen von Pins verwenden Set Title, Set Description, Set Pin Type und Set Tags nach denselben Intent-Regeln. Update Locus Pin Metadata bewahrt Welt, Position, Anker, Ansicht und Bereich des Pins.

Create Locus Pin akzeptiert ausdrücklichen Bereich, Asset-Pfad einer gespeicherten Welt, Position im Weltraum und Titel. Erweiterte Eingaben umfassen Weltbezeichnung, Beschreibung, Pin-Typ und Tags. Der Weltpfad muss eine unterstützte gespeicherte, projekt-eigene Welt identifizieren, beispielsweise /Game/Maps/Main.Main.

Blueprint kann Pins auflisten und abrufen, die sichere Grundform eines Pins erstellen, Metadaten aktualisieren und Kommentare hinzufügen. Die Developer API stellt weder das Neupositionieren von Pins noch den beliebigen Austausch eines Ankers bereit.

Siehe die Developer-API-Übersicht zu Revisionen, typisierten Fehlern, Operationsstatus, Bereichen und der vollständigen Fähigkeitsmatrix.