默认页面类型 - SQwatermark/Patchouli-wiki-zh_cn GitHub Wiki

此页面详细说明了帕秋莉手册模组默认提供的手册页面类型。如果你需要任何其他页面类型,请阅读使用模板以获取创建自定义页面类型的信息。

这些页面应该在章节(Entries)下使用,在 "pages" 数组下,在每个对象中使用 "type" 来指定使用哪种页面类型。你可以在章节 JSON 格式中获取更多信息。

以下属性对所有页面类型都是通用的:

  • type(字符串,必需

页面的类型是什么。这不是被页面本身使用的,而是被加载器用来判断应该加载哪种页面。例如,你想要一个文本页面,就需要将此项设为 "text"。

  • advancement(字符串)

指向一个进度的资源路径(resource location),让这个页面在进度达成时才出现。阅读用进度锁定内容获取更多有关信息。不设置此项,或者设为空字符串都会使页面不上锁。提供一个不存在的进度会永久锁定这个章节,除非后来在这个资源路径添加了进度。

  • flag(字符串)

一个用于判断这个页面是否应该存在的配置标记表达式(config flag expression)。阅读使用配置标记获取更多有关信息。

  • anchor(字符串)

锚(anchor)是用于在本手册的其他地方链接到这个页面的坐标。查看文本样式 101 获取更多有关信息。

用法示例

使用文本页面的示例:

{
    "type": "text",
    "text": "这是一个例子"
}

文本页面


页面类型:"text"

任何章节的第一页都应该是文本页。如果某个文本页是章节的第一页,它会显示上图左侧页面所示的标题。而其他文本页面会显示成上图右侧页面的形式。

属性

  • text(字符串,必需

页面显示的文本。文本内容可以被设置样式

  • title(字符串)

一个可选的显示在页面顶部的标题。如果你设置了此项,文本内容会稍微往下移动一些。你不能在章节的第一页使用 "title" 属性。

图片页面


页面类型:"image"

属性

  • images(字符串数组,必需

要显示的图片的数组。图片应该以资源路径的形式给出,并且应该是 png 格式。这里使用的图片应该为 256x256 像素,且只有左上角的 200x200 的像素是有内容的。它们以 0.5x 的比例渲染。

如果数组内有不止一张图片,就会显示上图所示的箭头按钮,用于切换不同的图片。如果只有一张图片,就不会显示此按钮。

  • title(字符串)

页面的标题,在图片上方显示。

  • border(字符串)

默认为 false。如果你想让图片有个边框,例如上面那张图片所示,就把这个属性设置为 true。建议给使用了整张画布的图片设置边框,本身就够不到画布边缘的图片不应该使用边框。

  • text(字符串)

页面显示的文本,它会显示在图片下方。文本可以被设置样式

合成配方页面


页面类型:"crafting"

属性

  • recipe(字符串,必需

显示的第一个配方(recipe)的ID

  • recipe2(字符串)

显示的第二个配方的ID。第二个配方是可选的。

  • title(字符串)

页面的标题,显示在两个配方上方。这是可选的,但是如果你填写了此项,就只会显示这个标题,而不会显示配方输出的物品名。

  • text(字符串)

页面显示的文本,它会显示在合成表下方。文本可以被设置样式

注意:当有两个输出不同物品的配方时,这个文本不会显示,而且标题也不会显示。这是因为两个配方有不同的输出物品名,图片展示的时候,没有空间留给文本了。

烧炼配方页面


页面类型:"smelting"

属性

  • recipe(字符串,必需

显示的第一个配方。由于烧炼配方在 1.13 中只能使用名字而不能用配方 ID,我们使用被烧炼物品的 ItemStack 字符串,所以如果你想要显示将沙子烧炼成玻璃的配方,你应该在这里写上 "minecraft:sand"。

  • recipe2(字符串)

显示的第二个配方。这是可选的。

  • title(字符串)

页面的标题,显示在两个配方上方。这是可选的,但是如果你填写了此项,就只会显示这个标题,不会显示配方输出的物品名。

  • text(字符串)

页面显示的文本,它会显示在烧炼配方下方。文本可以被设置样式

多方块结构页面


页面类型:"multiblock"

属性

  • name(字符串,必需

多方块结构的名字。显示为多方块结构展示窗口上方的标题。

  • multiblock_id(字符串)

仅供模组作者使用。你想要展示的多方块结构的 ID。阅读使用 API了解如何在代码中创建并注册多方块结构。

注意:这一项和 "multiblock" 必需设置其一才能使此页面正常工作

  • multiblock(对象)

要显示的多方块结构对象。阅读使用多方块结构了解如何创建这个对象。

注意:这一项和 "multiblock_id" 必需设置其一才能使此页面正常工作

  • enable_visualize(布尔值)

默认为 true。设置为 false 以禁用 "可视化(Visualize)" 按钮。

  • text(字符串)

页面显示的文本,它会显示在多方块结构下方。文本可以被设置样式

实体页面:


页面类型:entity

属性

  • entity(字符串,必需

实体的 ID。例如,要展示一只鸡,应该使用 "minecraft:chicken"。你也可以向实体附加 NBT 数据,方法和使用 ItemStack 字符串的方法相同。

  • scale(单精度浮点数)

实体显示的尺寸。默认为 1.0。低于 1.0 的尺寸会使实体比通常情况更小,高于 1.0 会变得更大。负值会把它颠倒过来。

  • offset(单精度浮点数)

实体显示的偏移补正。一些模组实体的渲染十分诡异,没办法正确地放进显示框里,你可以调整此项将其上下移动。(译注:向下为正,向上为负,正常情况下偏移值的绝对值不会超过1)

  • rotate(布尔值)

默认值 true。设置为 false 让实体不旋转。

  • default_rotation(单精度浮点数)

实体应该被渲染的旋转角度。只有当 "rotate" 设置为 false 时这一项才生效。默认值 为 -45。

  • name(字符串)

显示框上方显示的名字。如果填写空字符串或者未定义此项,会显示实体本身的名字。

  • text(字符串)

页面显示的文本,它会显示在实体下方。文本可以被设置样式

聚焦页面


页面类型:"spotlight"

属性:

  • item(字符串,必需

一个用于表示要聚焦显示的物品的 ItemStack 字符串

  • title(字符串)

显示在物品上方的自定义标题。如果这一项为空或者未定义此项,会使用物品名。

  • link_recipe(布尔值)

默认值为 false。设置为 true 将这个聚焦页标记为物品的 "配方页(recipe page)"。如果你这么做,当看向显示物品的页面时,你可以 shift 并单击物品以链入此页面。如果这个聚焦页介绍了如何用非常规方法制作这个物品,高度推荐将此项设为 true。

  • text(字符串)

页面显示的文本,它会显示在物品下方。文本可以被设置样式

链接页面


页面类型:link

**注意:**链接页只是特殊的文本页,也就是说它们和文本页几乎一样,只是底部有一个额外的链接按钮。它们也有文本页的所有属性,你也可以将章节的第一页设置为链接页。

属性

  • url(字符串,必需

点击按钮时打开的 URL。理论上来说任何链接都是支持的,但是请使用 HTTP/HTTPS 地址。

  • link_text(字符串,必需

显示在超链接按钮上的文本。

关联页面


页面类型:relations

属性

  • entries(字符串数组)

一个存放需要链接的章节的数组。数组中的元素用章节的 ID 表示,这和你从章节链入到类别 ID 的方法是相同的。

  • title(字符串)

页面的标题,显示在链接的上方。如果未定义或者为空,会显示 "相关章节(Related Chapters)"。

  • text(字符串)

页面显示的文本,它会显示在链接下方。文本可以被设置样式

任务页面

页面类型:quest

说明:

  • 任务完成时,任务页将会让所在的章节显示一个完成标记(checkmark,一个绿色的勾号)。
  • 显示了完成标记的章节将会显示在列表末尾,避免碍事。
  • 所以,为了正确地标记完成的章节,不要在一个章节中设置多个任务页
  • 如果你使用一个任务页,推荐你在章节中使用 "turnin"。

属性

  • trigger(字符串)

要完成的进度。你可以留空来让这个任务可以手动完成。上图左边为一个设置了 "trigger" 的任务,右面是没有设置的。

  • title(字符串)

页面的标题,显示在链接上方。如果未设置或为空,会显示 "目标(Objective)"。

  • text(字符串)

这个页面的链接下方要显示的文本,文本可以被设置样式

空白页面


页面类型:empty

属性

  • draw_filler(布尔值)

默认为 true。设置为 false 会显示一个彻底空白的页面,不会显示填充图案(译注:那个立方体框框)... 不管出于什么原因。