- Dokumentacja
- Locus
- Blueprint Developer API
Blueprint Developer API
Autorzy Editor Utility Blueprint i Editor Utility Widget powinni używać wybranych asynchronicznych węzłów Locus. Niższopoziomowe odzwierciedlone obiekty żądań są wspólną infrastrukturą dla Pythona i nie stanowią zwykłego przepływu pracy Blueprint.
Znajdź węzły w palecie Blueprint pod Locus > Notes, Locus > Documents i Locus > Pins.
Dostępne węzły
Dział zatytułowany „Dostępne węzły”| Kategoria | Węzły |
|---|---|
| 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 |
Wyniki asynchroniczne
Dział zatytułowany „Wyniki asynchroniczne”Każdy węzeł udostępnia końcowe wyjścia wykonania Succeeded i Failed. Węzeł celowo nie ma natychmiastowej ścieżki zakończenia, którą można pomylić z wynikiem asynchronicznym.
Oba wyniki udostępniają:
- typowany Result;
- neutralny względem dostawcy Operation Status;
- typowany Error.
W przypadku błędu rozgałęziaj logikę według Error > Code, zamiast analizować Message. Udostępniany proxy Async Action zapewnia kooperacyjne Cancel dla pracy, która jeszcze się nie rozpoczęła. Anulowanie nie przerywa mutacji, która już jest zatwierdzana.
Tworzenie Dokumentu
Dział zatytułowany „Tworzenie Dokumentu”Dodaj Create Locus Document i podaj:
- Path: ścieżkę względem wybranego widocznego korzenia, taką jak
Design/Combat.md; - Markdown: początkowe źródło, takie jak
# Combat; - Presentation Root: Locus Documents albo Content Browser.
Użyj Identity > Relative Path z wyniku Succeeded jako autorytatywnej tożsamości Dokumentu. Nie zastępuj jej ścieżką prezentacji ani kontekstem /Game/....
Aktualizacja Notatki bezpieczna względem rewizji
Dział zatytułowany „Aktualizacja Notatki bezpieczna względem rewizji”- Użyj Get Locus Note i zachowaj wyjścia Identity oraz Revision.
- Utwórz strukturę Locus Developer Note Changes.
- Ustaw tylko flagi zamiaru
Set ...dla pól, które chcesz zmienić. - Wywołaj Update Locus Note z Identity, odczytaną rewizją jako Expected Revision oraz Changes.
- Podążaj za Succeeded albo sprawdź Failed > Error > Code. Przy Stale Revision ponownie pobierz Notatkę i ponownie rozważ aktualizację.
Struktura zmian rozróżnia pozostawienie bez zmian, ustawienie i wyczyszczenie:
| Wartości | Znaczenie |
|---|---|
Set Title = false |
Pozostaw Tytuł bez zmian; wartość Title jest ignorowana |
Set Title = true, Title = "New Title" |
Ustaw niepusty tytuł |
Set Title = true, Title = "" |
Jawnie zażądaj pustego tytułu, z uwzględnieniem walidacji domeny |
Ten sam wzorzec dotyczy treści Notatki, tagów i statusu. Po sukcesie użyj nowej rewizji wyniku przy następnej mutacji.
Zmiany metadanych Pinezki używają Set Title, Set Description, Set Pin Type i Set Tags z tymi samymi zasadami zamiaru. Update Locus Pin Metadata zachowuje świat, położenie, kotwicę, widok i zakres Pinezki.
Pinezki
Dział zatytułowany „Pinezki”Create Locus Pin przyjmuje jawny zakres, ścieżkę zasobu zapisanego świata, położenie w przestrzeni świata i tytuł. Zaawansowane dane wejściowe obejmują etykietę świata, opis, typ Pinezki i tagi. Ścieżka świata musi wskazywać obsługiwany zapisany należący do projektu świat, na przykład /Game/Maps/Main.Main.
Blueprint może listować i pobierać Pinezki, tworzyć bezpieczną podstawową formę Pinezki, aktualizować metadane i dodawać komentarze. Developer API nie udostępnia zmiany położenia Pinezki ani dowolnej wymiany kotwicy.
Zobacz Przegląd Developer API — znajdziesz tam rewizje, typowane błędy, stan operacji, zakres i pełną macierz możliwości.