- Documentação
- Locus
- Blueprint Developer API
Blueprint Developer API
Autores de Editor Utility Blueprint e Editor Utility Widget devem usar os nós assíncronos selecionados do Locus. Os objetos de requisição refletidos de nível inferior são infraestrutura compartilhada para Python e não são o fluxo normal do Blueprint.
Encontre os nós na paleta Blueprint em Locus > Notes, Locus > Documents e Locus > Pins.
Nós disponíveis
Seção intitulada “Nós disponíveis”| Categoria | Nós |
|---|---|
| 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 |
Resultados assíncronos
Seção intitulada “Resultados assíncronos”Cada nó expõe saídas de execução terminais Succeeded e Failed. O nó não tem deliberadamente um caminho de conclusão imediata que possa ser confundido com o resultado assíncrono.
Ambos os resultados expõem:
- um Result tipado;
- um Operation Status neutro em relação ao provedor;
- um Error tipado.
Em caso de falha, ramifique por Error > Code em vez de analisar Message. O proxy Async Action oferece Cancel cooperativo para trabalho que ainda não começou. O cancelamento não interrompe uma mutação já persistida.
Criar um Documento
Seção intitulada “Criar um Documento”Adicione Create Locus Document e forneça:
- Path: um caminho relativo à raiz visível selecionada, como
Design/Combat.md; - Markdown: a origem inicial, como
# Combat; - Presentation Root: Locus Documents ou Content Browser.
Use Identity > Relative Path do resultado Succeeded como a identidade autoritativa do Documento. Não substitua por seu caminho de apresentação ou pelo contexto /Game/....
Atualização de Nota segura para revisão
Seção intitulada “Atualização de Nota segura para revisão”- Use Get Locus Note e mantenha as saídas Identity e Revision.
- Crie uma struct Locus Developer Note Changes.
- Defina apenas as flags de intenção
Set ...dos campos que quer alterar. - Chame Update Locus Note com Identity, a revisão lida como Expected Revision e Changes.
- Siga Succeeded ou inspecione Failed > Error > Code. Em Stale Revision, obtenha a Nota novamente e reconsidere a alteração.
A struct de alterações distingue manter, definir e limpar:
| Valores | Significado |
|---|---|
Set Title = false |
Deixar o título inalterado; o valor Title é ignorado |
Set Title = true, Title = "New Title" |
Definir um título não vazio |
Set Title = true, Title = "" |
Solicitar explicitamente um título vazio, sujeito à validação do domínio |
O mesmo padrão se aplica ao corpo, tags e status da Nota. Após o sucesso, use a nova revisão do resultado para a próxima mutação.
Alterações de metadados de Pins usam Set Title, Set Description, Set Pin Type e Set Tags com as mesmas regras de intenção. Update Locus Pin Metadata preserva mundo, posição, âncora, visualização e escopo do Pin.
Create Locus Pin aceita escopo explícito, caminho de asset de mundo salvo, localização no espaço do mundo e título. Entradas avançadas incluem rótulo do mundo, descrição, tipo de Pin e tags. O caminho do mundo deve identificar um mundo salvo, compatível e pertencente ao projeto, por exemplo /Game/Maps/Main.Main.
Blueprint pode listar e obter Pins, criar a forma básica segura de um Pin, atualizar metadados e adicionar comentários. A Developer API não expõe reposicionamento de Pin nem substituição arbitrária de âncora.
Consulte a visão geral da Developer API para revisões, erros tipados, status da operação, escopo e a matriz completa de recursos.