跳转到正文
iPlugin

布局

Layout 文件、默认值和元素的完整字段参考

本页查询字段。先在资产配置登记字体、图片和需要的模板,再在 Layout 中引用它们;最后由HUD或其它显示系统负责显示。完整操作见创建 Layout。

Layout 位于 core/layout。一份文件可以定义多个 Layout,顶层节点就是全局 Layout ID。

文件关系

tutorial.yml

常用文字元素示例

下面使用自带 ui、ui_title 字体和 stack_announcement 背景模板。新建项目可替换为自己先登记的 ID。

defaults:
  font: ui
  image:
    namespace: xerr_ui
    basename: icon

example:
  title:
    anchor:
      x: 50
      y: 0
    layer: 20
    affect-bounds: true
    condition: |
      perm xerr.hud
    x: 0
    y: -30
    align: center
    font: ui_title
    value: "&f示例文字"
    background:
      id: stack_announcement
      x: 0
      y: -26
      padding:
        left: 6
        right: 6

文件级 defaults

字段类型 / 省略值说明
defaults.font字体 ID / 无当前文件中元素的默认字体
defaults.image.namespace字符串 / 无默认图片命名空间
defaults.image.basename字符串 / 无默认图片组

defaults 不是 Layout ID,只对当前 YAML 文件生效。

元素通用字段

字段类型 / 省略值说明生效
anchor.x小数 / 无屏幕宽度百分比打包
anchor.y小数 / 无屏幕高度百分比打包
layer整数 / 0绘制层级,越大越靠前打包
affect-bounds布尔 / true是否参与 Stack 等系统的边界测量打包
conditionKether / 无返回 true 时显示当前元素重载
x整数 / 0水平像素偏移打包
y整数 / 0顶部垂直偏移,正数向上打包
alignleft/center/right / left文字水平对齐打包
font字体 ID / 继承覆盖默认字体打包

文字元素

文字可以使用单行 value、固定多行 list,或由脚本生成的 lines。它们共享本页的字体、位置、对齐和条件字段。

布局中的完整单行文字元素
message:
  value: "&f欢迎,{{ player name }}"

文字来源、优先级、变量、行距与动态行数的完整规则统一见文字与多行,静态译文见多语言。

图片元素

image:
  namespace: xerr_ui
  basename: icon
  id: gem
字段类型 / 省略值说明
image.namespace字符串 / 继承图片命名空间
image.basename字符串 / 继承图片组
image.id字符串 / 必填图片 ID

头像元素

head:
  template: portrait
  target:
    type: viewer
字段说明
head.template头像模板 ID,必填
head.target可选,整体覆盖模板默认目标

目标字段见玩家头像。

人物元素

avatar.template 引用人物模板。可选的 avatar.target 与 avatar.motion 分别整体覆盖模板目标和动作,只影响当前元素。人物沿用普通锚点、坐标和层级,一个布局最多四个人物。

完整示例见人物模板,可视化操作见制作全身人物。

进度元素

progress:
  namespace: xerr_ui
  basename: player_status
  # 其它字段

全部字段见图片进度。

Compass 元素

compass:
  template: navigation
  id: quest_navigation
字段类型 / 省略值说明
compass.template字符串 / 必填Compass 模板 ID
compass.id字符串 / 模板 ID运行时目标集合 ID

省略 id 时,同一模板共享同一组目标。

文字背景

背景模板和三段图片必须先登记,参见背景教程。以下为元素内片段。

background:
  id: modern_text
  x: 0
  y: 18
  padding:
    left: 6
    right: 8
字段类型 / 省略值说明
background.id字符串 / 无背景模板 ID
background.x整数 / 0只移动背景,不移动文字
background.y整数 / 0独立顶部坐标,不叠加元素 y
background.padding.left整数 0~512 / 继承覆盖左内边距
background.padding.right整数 0~512 / 继承覆盖右内边距

内容选择顺序

同一个元素应只选择一种主要内容。不要在一个元素里同时配置多种主要内容。需要同时显示图标和文字时,创建两个元素。