插件主体部分

创建插件完成后， 可以开始编写插件主类。

Step 1： 导入相关库

先导入插件所需的相关库。

from tooldelta import plugin_entry, Plugin, ToolDelta, Player, Chat, FrameExit
from tooldelta.constants import PacketIDs

Step 2： 编写插件主类

然后开始编写插件主类：

先编写插件基本信息：插件名，作者名，版本号。

class NewPlugin(Plugin):
    name = "插件名" # 必须设置插件名
    author = "作者名" # 作者名, 可选
    version = (0, 0, 1) # 插件版本号, 可选, 是一个三元整数元组

Step 3： 编写插件初始化方法

然后编写 __init__ 方法用于在读取插件时初始化插件类实例：

    def __init__(self, frame: ToolDelta):
        super().__init__(frame)
        # 如果你的插件需要读取配置文件
        # 那就在这里编写插件配置文件的读取
        # ...

Step 4：编写和注册回调事件

编写相应的事件回调：

    def on_preload(self):
        # 在此写获取插件API (self.GetPluginAPI) 方法
        # 例如:
        # 插件API接口 = self.GetPluginAPI("插件API名")
        pass

    def on_active(self):
        # 会在 ToolDelta 初始化成功 (成功接入服务器) 后执行
        print("已与游戏建立连接")
        # 发送一条 Minecraft 指令 在游戏里说 hello
        self.game_ctrl.sendcmd("/say hello everybody! tooldelta is ok!")

    def on_chat(self, chat: Chat):
        # 在玩家发言后执行
        player = chat.player
        msg = chat.msg
        player.show(f"你刚刚说: {msg}")

    def on_player_join(self, player: Player):
        # 在玩家加入后执行
        self.game_ctrl.say_to("@a", f"§a§l Hi, @{player.name}")

    def on_player_leave(self, player: Player):
        # 在玩家退出游戏时执行
        self.game_ctrl.say_to("@a", f"§a§l Bye, @{player.name}")

    def on_frame_exit(self, evt: FrameExit):
        print(f"框架退出或插件重载 状态码={evt.signal} 原因={evt.reason}")

    def on_pkt_text(self, packet: dict):
        # 接收游戏数据包
        # 接收到 Text 数据包后执行
        print(packet)

我们回到 __init__ 方法，
将这些监听回调方法注入到框架主类中：

    def __init__(self, frame: ToolDelta):
        super().__init__(frame)
        self.ListenPreload(self.on_preload)
        self.ListenActive(self.on_active)
        self.ListenPlayerJoin(self.on_player_join)
        self.ListenPlayerLeave(self.on_player_leave)
        self.ListenChat(self.on_chat)
        self.ListenPacket(PacketIDs.TEXT, self.on_pkt_text)
        self.ListenFrameExit(self.on_frame_exit)

对于事件监听方法，下方列出了它们的功能和使用方法：

监听方法	回调类型	触发条件
ListenPreload	() -> None	插件读取完成、进入租赁服前
ListenActive	() -> None	进入租赁服，初始化完成时
ListenPlayerJoin	(Player) -> None	玩家加入
ListenPlayerLeave	(Player) -> None	玩家退出
ListenPlayerChat	(Chat) -> None	玩家发送聊天栏消息
ListenFrameExit	(FrameExit) -> None	系统退出/重载
ListenPacket	(dict) -> bool	监听游戏数据包，返回代表是否拦截

回调参数类型：

• Chat：

  成员	类型	说明
  player	Player	玩家实例对象
  msg	str	消息内容

• Player：

  成员	类型	说明
  name	str	玩家名
  ...		详细介绍

• FrameExit：

  成员	类型	说明
  signal	int	退出原因ID
  reason	str	退出原因

Step 5：创建插件执行入口

entry = plugin_entry(MyPlugin)

完成！

至此，插件框架已经完成了！让我们回顾一下整体代码：

from tooldelta import plugin_entry, Plugin, ToolDelta, Player, Chat, FrameExit
from tooldelta.constants import PacketIDs

class NewPlugin(Plugin):
    name = "插件名" # 必须设置插件名
    author = "作者名" # 作者名, 可选
    version = (0, 0, 1) # 插件版本号, 可选, 是一个三元整数元组

    def __init__(self, frame: ToolDelta):
        super().__init__(frame)
        self.ListenPreload(self.on_preload)
        self.ListenActive(self.on_active)
        self.ListenPlayerJoin(self.on_player_join)
        self.ListenPlayerLeave(self.on_player_leave)
        self.ListenChat(self.on_chat)
        self.ListenPacket(PacketIDs.TEXT, self.on_pkt_text)
        self.ListenFrameExit(self.on_frame_exit)

    def on_preload(self):
        # 在此写获取插件API (self.GetPluginAPI) 方法
        # 例如:
        # 插件API接口 = self.GetPluginAPI("插件API名")
        pass

    def on_active(self):
        # 会在 ToolDelta 初始化成功 (成功接入服务器) 后执行
        print("已与游戏建立连接")
        # 发送一条 Minecraft 指令 在游戏里说 hello
        self.game_ctrl.sendcmd("/say hello everybody! tooldelta is ok!")

    def on_chat(self, chat: Chat):
        # 在玩家发言后执行
        player = chat.player
        msg = chat.msg
        player.show(f"你刚刚说: {msg}")

    def on_player_join(self, player: Player):
        # 在玩家加入后执行
        self.game_ctrl.say_to("@a", f"§a§l Hi, @{player.name}")

    def on_player_leave(self, player: Player):
        # 在玩家退出游戏时执行
        self.game_ctrl.say_to("@a", f"§a§l Bye, @{player.name}")

    def on_frame_exit(self, evt: FrameExit):
        print(f"框架退出或插件重载 状态码={evt.signal} 原因={evt.reason}")

    def on_pkt_text(self, packet: dict):
        # 接收游戏数据包
        # 接收到 Text 数据包后执行
        print(packet)

entry = plugin_entry(MyPlugin)