PassengerAPI

插件

· 作者 maximjsx

修复乘客兼容性问题 | 管理你自己的实体乘客

0 本站下载 0 关注 更新于 1 年前

需要前置:PacketEvents

最新 1.5.1 · 1.21.8 · Paper / Purpur

一键开服(送7天)

为什么使用 PassengerAPI?

它解决了不同插件通过向玩家发送数据包并将实体设置为乘客时可能产生的兼容性问题。
这可能导致冲突和意外行为,例如其他插件设置的先前乘客被卸载。

例如,这使得这些插件能够自动相互兼容:

  • Better Chat Bubbles
  • ProdigyCape
  • VanillaMinimaps
  • PlayerMounts

该插件开箱即用!
只需将其放入你的 plugins 文件夹并重启服务器即可。
(需要 Packet Events)

展示

视频说明
正如你在视频中看到的那样:

如果没有 PassengerAPI,聊天气泡和披风无法同时作为乘客设置!

原因是它们是两个不同的插件,各自发送自己的乘客数据包。

如果你是开发者,还可以使用此 API 添加/访问/移除乘客!

(大多数兼容性问题应该会自动修复,但……)

例如,如果你想在不杀死实体的情况下从实体上移除一个乘客,这将非常有用。

命令:

权限 passengerapi.commands

/passengerapi debug 
/passengerapi reload

注意
当你处于调试模式且手中拿着一个方块时 你将在聊天中获得额外的调试信息。

配置:

# 除非你完全确定自己在做什么,否则不要修改此文件中的任何内容!

AutoPassengerDetection:
  SetPassengerPacket: true
  EntityDestroyPacket: true

入门指南

  1. 将 PassengerAPI 作为仅编译依赖项添加到你的插件中。

Gradle:

repositories {
    mavenCentral()
    maven { url 'https://jitpack.io' }
}

dependencies {
    implementation 'com.github.max1mde:PassengerAPI:1.0.1'
}

(Maven: )

  1. 在你的 plugin.yml 文件中添加以下行:
depend:
- PassengerAPI

同时为你的服务器添加插件 Packet Events,这是本插件所必需的!

用法

获取 PassengerActions 实例

要访问 PassengerAPI 功能,你需要获取 PassengerActions 实例:

PassengerActions passengerActions = PassengerAPI.getAPI(yourPluginInstance);

将 yourPluginInstance 替换为你插件主类的实例。
(例如,如果你在类中使用它,可以使用 this)

管理乘客

以下是一些如何使用 PassengerActions 接口的示例:

请记住,你只能检索和移除你通过 addPassenger... 方法在此处设置的乘客。
例外: 当使用“全局”方法如 getGlobalPassengers 时。

// 添加单个乘客
passengerActions.addPassenger(targetEntityId, passengerEntityId);

// 添加多个乘客
passengerActions.addPassengers(targetEntityId, Set.of(passenger1Id, passenger2Id, ...));

// 移除单个乘客
passengerActions.removePassenger(targetEntityId, passengerEntityId);

// 移除多个乘客
passengerActions.removePassengers(targetEntityId, Set.of(passenger1Id, passenger2Id, ...));

// 移除目标实体的所有乘客
passengerActions.removeAllPassengers(targetEntityId);

// 获取目标实体的所有乘客
Set<Integer> passengers = passengerActions.getPassengers(targetEntityId);

// 移除全局乘客(所有插件设置的乘客)
passengerActions.removeGlobalPassengers(targetEntityId, Set.of(passenger1Id, passenger2Id, ...));

// 移除目标实体的所有全局乘客(所有插件设置的乘客)
passengerActions.removeAllGlobalPassengers(targetEntityId);

// 获取目标实体的所有全局乘客(所有插件设置的乘客)
Set<Integer> globalPassengers = passengerActions.getGlobalPassengers(targetEntityId);

注意
所有实体都通过其实体 ID 进行标识(而非 UUID)。

监听事件

PassengerAPI 还提供了你可以监听并相应处理的事件:

@EventHandler
public void onAddPassenger(AddPassengerEvent event) {
    // 尝试添加这些乘客的插件名称
    String pluginName = event.getPluginName();
    int targetEntity = event.getTargetEntityID();
    Set<Integer> passengers = event.getPassengerList();
    // 对这些属性执行操作
}

@EventHandler
public void onRemovePassenger(RemovePassengerEvent event) {
    // 尝试移除这些乘客的插件名称
    String pluginName = event.getPluginName();
    int targetEntity = event.getTargetEntityID();
    Set<Integer> removedPassengers = event.getPassengerList();
    // 对这些属性执行操作
}

@EventHandler
public void onPassengerPacket(PassengerPacketEvent event) {
    int targetEntity = event.getTargetEntityID();
    Set<Integer> passengers = event.getPassengerList();
    // 哪些玩家应该接收数据包(你可以修改该列表)
    List<Player> receivers = event.getPacketReceivers();
    // 对这些属性执行操作
}

别忘了注册你的事件类

欢迎在 GitHub 上进行贡献!

你是这个资源的作者?登录后可认领此资源。

评论 0

0.0
暂无评分
5 星
0
4 星
0
3 星
0
2 星
0
1 星
0
我的评分

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源