- Documentación
- Locus
- Blueprint Developer API
Blueprint Developer API
Los autores de Editor Utility Blueprint y Editor Utility Widget deben usar los nodos asíncronos seleccionados de Locus. Los objetos de solicitud reflejados de nivel inferior son infraestructura compartida para Python y no forman parte del flujo normal de Blueprint.
Encuentra los nodos en la paleta Blueprint bajo Locus > Notes, Locus > Documents y Locus > Pins.
Nodos disponibles
Sección titulada «Nodos disponibles»| Categoría | Nodos |
|---|---|
| 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 asíncronos
Sección titulada «Resultados asíncronos»Cada nodo expone las salidas de ejecución terminales Succeeded y Failed. El nodo no tiene deliberadamente una ruta de finalización inmediata que pueda confundirse con el resultado asíncrono.
Ambos resultados exponen:
- un Result tipado;
- un Operation Status neutral para el proveedor;
- un Error tipado.
Cuando falla, ramifica por Error > Code en lugar de analizar Message. El proxy Async Action ofrece Cancel cooperativo para el trabajo que aún no ha comenzado. La cancelación no interrumpe una mutación que ya está persistida.
Crear un Documento
Sección titulada «Crear un Documento»Añade Create Locus Document y proporciona:
- Path: una ruta relativa a la raíz visible seleccionada, como
Design/Combat.md; - Markdown: el origen inicial, como
# Combat; - Presentation Root: Locus Documents o Content Browser.
Usa Identity > Relative Path del resultado Succeeded como identidad autoritativa del Documento. No la sustituyas por su ruta de presentación ni por el contexto /Game/....
Actualización de Nota segura frente a revisiones
Sección titulada «Actualización de Nota segura frente a revisiones»- Usa Get Locus Note y conserva sus salidas Identity y Revision.
- Crea una estructura Locus Developer Note Changes.
- Establece solo las marcas de intención
Set ...de los campos que quieras modificar. - Llama a Update Locus Note con Identity, la revisión leída como Expected Revision y Changes.
- Sigue Succeeded o inspecciona Failed > Error > Code. En Stale Revision, vuelve a obtener la Nota y reconsidera la actualización.
La estructura de cambios distingue dejar sin cambios, establecer y borrar:
| Valores | Significado |
|---|---|
Set Title = false |
Dejar Title sin cambios; se ignora el valor de Title |
Set Title = true, Title = "New Title" |
Establecer un título no vacío |
Set Title = true, Title = "" |
Solicitar explícitamente un título vacío, sujeto a la validación del dominio |
El mismo patrón se aplica al cuerpo, etiquetas y estado de la Nota. Después de tener éxito, usa la nueva revisión del resultado para la siguiente mutación.
Los cambios de metadatos de Pines usan Set Title, Set Description, Set Pin Type y Set Tags con las mismas reglas de intención. Update Locus Pin Metadata conserva el mundo, la posición, el anclaje, la vista y el ámbito del Pin.
Create Locus Pin acepta ámbito explícito, ruta de asset de mundo guardado, ubicación en el espacio del mundo y título. Las entradas avanzadas incluyen etiqueta del mundo, descripción, tipo de Pin y etiquetas. La ruta del mundo debe identificar un mundo guardado y propiedad del proyecto compatible, por ejemplo /Game/Maps/Main.Main.
Blueprint puede listar y obtener Pines, crear la forma básica segura de un Pin, actualizar metadatos y añadir comentarios. La Developer API no expone reposicionar Pines ni sustituir anclajes arbitrariamente.
Consulta la descripción general de Developer API para revisiones, errores tipados, estado de operación, ámbito y la matriz completa de capacidades.