Skip to content
Search

Blueprint Developer API

Editor Utility Blueprint 和 Editor Utility Widget 作者应使用 Locus 的精选异步节点。较低级别的反射请求对象是 Python 使用的共享基础设施,不是常规的 Blueprint 工作流。

在 Blueprint 调色板的 Locus > 笔记Locus > 文档Locus > 标记点下查找节点。

类别 节点
Locus > 笔记 List Locus NotesGet Locus NoteSearch Locus NotesCreate Locus NoteUpdate Locus NoteArchive Locus Note
Locus > 文档 List Locus DocumentsGet Locus DocumentSearch Locus DocumentsCreate Locus DocumentUpdate Locus Document
Locus > 标记点 List Locus PinsGet Locus PinCreate Locus PinUpdate Locus Pin MetadataAdd Locus Pin Comment

每个节点都会暴露终端 SucceededFailed 执行输出。节点有意不提供可能被误认为异步结果的立即完成路径。

两种结果都会暴露:

  • 类型化的 Result
  • 与提供程序无关的 Operation Status
  • 类型化的 Error

失败时根据 Error > Code 分支,不要解析 Message。公开的 Async Action 代理为尚未开始执行的工作提供协作式 Cancel。取消不会中断已经进入持久化处理的变更。

添加 Create Locus Document 并提供:

  • Path: 相对于所选可见根的路径,例如 Design/Combat.md
  • Markdown: 初始源文本,例如 # Combat
  • Presentation Root: Locus 文档内容浏览器

使用 Succeeded 结果的 Identity > Relative Path 作为权威文档身份。不要将其替换为呈现路径或 /Game/... 上下文。

  1. 使用 Get Locus Note,保留其 IdentityRevision 输出。
  2. 创建 Locus Developer Note Changes 结构体。
  3. 只为要修改的字段设置 Set ... 意图标志。
  4. 使用 Identity、将读取到的修订版本作为 Expected Revision 以及 Changes,调用 Update Locus Note
  5. 遵循 Succeeded,或检查 Failed > Error > Code。遇到 Stale Revision 时,重新获取笔记并重新考虑更新。

更改结构体会区分保持不变、设置和清除:

含义
Set Title = false 保持 Title 不变;忽略 Title 值。
Set Title = trueTitle = "New Title" 设置非空标题。
Set Title = trueTitle = "" 根据域验证,明确请求空标题。

笔记正文、标签和状态也使用相同模式。成功后,下一次变更使用新结果修订版本。

标记点元数据变更使用 Set TitleSet DescriptionSet Pin TypeSet Tags,遵循相同的意图规则。Update Locus Pin Metadata会保留标记点的世界、位置、锚点、视图和范围。

Create Locus Pin接受明确的范围、已保存世界资产路径、世界空间位置和标题。高级输入包括世界标签、描述、标记点类型和标签。世界路径必须标识受支持的已保存项目所有世界,例如 /Game/Maps/Main.Main

Blueprint 可以列出和获取标记点、创建安全的基本标记点、更新元数据和添加评论。Developer API 不公开标记点重新定位或任意锚点替换。

有关修订版本、类型化错误、操作状态、范围和完整能力矩阵,请参阅Developer API 概览