跳转到主要内容

Floodgate API

Floodgate 提供了一套 API,用于扩展可实现的功能,并允许服务器获取基岩版客户端的信息。它也允许其他插件访问 Cumulus

本页介绍 FloodgateApi 类。 有关 API 其他部分的更多信息,请查看侧边栏。

访问 Floodgate API

有关如何在项目中引入 Floodgate API,请参见此处

Floodgate API 在 Floodgate 2.0 中发生了变化。最重要的变化是 API 方法不再是静态方法,而是基于实例调用,如下所示。

FloodgateApi 类是 API 的基础类,你需要通过它访问 API 的任何部分。 要访问它,只需调用:

FloodgateApi.getInstance();

拿到实例后,你就可以访问所有方法。 请查阅 API 模块中的文档,了解每个可用方法及其说明。 大多数 API 方法都有简要说明

备注

如需完整、详细的文档,请查看 Javadocs

以下列出几个方法,帮助你快速上手:

FloodgateApi#isFloodgatePlayer(UUID)
用于检查给定 UUID 的在线玩家是否为基岩版玩家。

FloodgateApi#getPlayer(UUID)
用于获取某个在线玩家的 FloodgatePlayer 实例。 点击此处了解有关 FloodgatePlayer 类的更多信息。

注意:使用 getPlayerisFloodgatePlayer 方法时,不需要等到基岩版玩家完全上线。 你甚至可以在预登录事件中使用它们。

FloodgateApi#getPlayerLink()
用于获取 Floodgate 检查已绑定账号时使用的 PlayerLink 实例。 点击此处了解有关 PlayerLink 类的更多信息。

FloodgateApi#sendForm(UUID, Form(Builder))
用于向指定 UUID 的基岩版玩家发送表单。 点击此处了解有关表单的更多信息。

在后端服务器上使用 API

使用代理时,如果想在后端 Spigot 服务器上成功使用 API,必须在代理端 Floodgate 配置中将 send-floodgate-data 设置为 true,并确保所有 Floodgate 实例使用相同的 key.pem 文件。