简介
foundry-firehose
是一个开源的 npm 包,旨在提供从 Foundry VTT 游戏框架捕获事件并将它们转发到其他应用程序的能力。该包适用于需要捕获游戏事件并在应用程序中处理的开发人员。在本教程中,我们将学习如何使用 foundry-firehose
包。
安装
使用 npm 安装 foundry-firehose
包。
npm install --save foundry-firehose
使用
foundry-firehose
使你能够从一个基于 Node.js 的应用程序中订阅 Foundry VTT 游戏事件。你只需要创建一个新的 FireHose
对象并在构造函数中传入有关其如何连接到 Foundry VTT 的参数。一旦创建了 FireHose
对象,你就可以使用 subscribe
方法来捕获事件并在应用程序中处理它们。
-- -------------------- ---- ------- ----- -------- - --------------------------- ----- ------- - - ----- ------------ ----- ------ --------- ---------- - ----- -------- - --- ----------------- --------------------------------- ------ -- - -------------------- ---- -------------- ----------------- --
在这个例子中,我们创建了一个 options
对象,其中包含了有关如何连接到 Foundry VTT 的信息。我们将这个对象传递给了 FireHose
的构造函数,并创建了 firehose
对象。我们之后使用 subscribe
方法来订阅 chatMessage
事件,并在处理事件时输出了消息。
事件
foundry-firehose
支持多个事件,并允许你订阅并处理这些事件。下面是一些常见的事件:
chatMessage
- 当有玩家在聊天中发送消息时触发。diceRoll
- 当有玩家在游戏中掷骰子时触发。onReady
- 当 Foundry VTT 准备好运行时触发。
在本教程中,我们将看到如何使用 chatMessage
和 diceRoll
事件。
订阅 chatMessage 事件
下面的代码演示了如何订阅 chatMessage
事件。它将从聊天中获取所有消息并将其记录到控制台上。
-- -------------------- ---- ------- ----- -------- - --------------------------- ----- ------- - - ----- ------------ ----- ------ --------- ---------- - ----- -------- - --- ----------------- --------------------------------- ------ -- - -------------------- ---- -------------- ----------------- --
在这个例子中,我们创建了一个新的 FireHose
对象并订阅了 chatMessage
事件。在事件处理程序中,我们简单地输出了消息的别名和内容。
订阅 diceRoll 事件
下面的代码演示了如何订阅 diceRoll
事件。它将从游戏中获取所有骰子掷出的数字并将其记录到控制台上。
-- -------------------- ---- ------- ----- -------- - --------------------------- ----- ------- - - ----- ------------ ----- ------ --------- ---------- - ----- -------- - --- ----------------- ------------------------------ ------ -- - -------------------------- ------ - ---------------- --
在这个例子中,我们创建了一个新的 FireHose
对象并订阅了 diceRoll
事件。在事件处理程序中,我们简单地输出了掷骰子玩家的别名和他们掷出的数字。
结论
foundry-firehose
是一个非常有用的 npm 包,可以让你轻松地捕获 Foundry VTT 游戏事件并在应用程序中进行处理。从本教程中,你已经学习了如何安装和使用 foundry-firehose
包,以及如何订阅常见的游戏事件。现在,你可以使用 foundry-firehose
来构建更加智能的 Foundry VTT 应用程序。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60055eb381e8991b448dc587