本文档由官方文档翻译而来

UI DOCUMENTATION Version: 1.12.0.28

脚本系统

用于 Minecraft 的自定义 UI 基于 HTML5。你可以在 HTML 文件内编写 JavaScript 脚本以监听和响应来自 UI 引擎的事件。这些事件可以被 UI 引擎自身触发，也可以从你的脚本中触发它们。为使用自定义 UI，包含自定义 UI 的资源包须要启用自定义 UI 功能。要做到这一点，只需要将 “experimental_custom_ui” 添加到包清单文件中的功能 (capabilities) 数组即可。你可以查看 Turn-Based RPG 演示，了解如何执行此操作的示例。

获取脚本引擎

为了在 UI 引擎和脚本引擎之间创建链接，你需要获取脚本引擎的实例 —— engine.on() 函数需要监听 “facet:updated:scripting” 事件，你需要存储返回值。接下来，你需要触发 “facet:request” 事件并传入一个包含 “scripting” 的向量。调用的顺序十分重要，如果你在注册监听器前触发了请求，你将无法捕获回调。

获取脚本引擎的示例

let scriptInterface = undefined;
engine.on(“facet:updated:scripting”, function(interface) {
  scriptInterface = interface;
});
engine.trigger(“facet:request”, [“scripting”]);

let scriptInterface = undefined;

engine.on(“facet:updated:scripting”, function(interface) {

scriptInterface = interface;

});

engine.trigger(“facet:request”, [“scripting”]);

引擎装订

on(EventIdentifier, Callback)

该函数用于从 UI 引擎中获取事件。这些事件最初可被客户端脚本使用 “send_ui_event” 事件发送，或是被游戏创建并由 UI 引擎传递。从脚本发送到该函数的数据必须是一个字符串。

参数

Name	Type	Description
EventIdentifier	String	指定函数将作出反应的事件
Callback	JavaScript Object	当事件发生时，该函数将会被调用

监听来自于客户端脚本的事件的示例

engine.trigger(“exampleEventIdentifier”, eventDataObject);

1	engine.trigger(“exampleEventIdentifier”, eventDataObject);

trigger(EventIdentifier, Arguments)

该函数用于向 UI 引擎发送事件。

属性

Name	Type	Description
EventIdentifier	String	指定函数将要作出反应的事件
Arguments	JavaScript Object	传递给回调的参数

发送一个事件到 UI 引擎的示例

engine.trigger("exampleEventIdentifier", eventDataObject);

1	engine.trigger("exampleEventIdentifier", eventDataObject);

脚本装订

triggerEvent(Data)

该函数将以所提供的数据触发客户端脚本中的 “minecraft:ui_event” 事件。

属性

Name	Type	Description
Data	String	该字符串将被发送到客户端脚本中的 “minecraft:ui_event” 事件

发送一个事件到客户端脚本的示例

scriptInterface.triggerEvent("SendThisDataToTheScript");

1	scriptInterface.triggerEvent("SendThisDataToTheScript");