KillServer API -- Events

KillServer 创建了一些新的事件用以监听服务器的运行状态. 对于 MCDR 内置的一些生命周期事件本插件继续沿用, 并补充了不少生命周期中的其他事件, 它们都是 ServerEvent 的实例

class kill_server.ServerEvent(event_id: str)[源代码]

基类：PluginEvent

服务器事件, 包括服务端控制等

id

事件 ID

Type:: str

__init__(event_id: str) → None[源代码]: 创建一个服务器控制事件

classmethod is_server_event(e: PluginEvent) → bool[源代码]: 判断该事件是否为一个服务器控制事件

备注

包括 MCDR 内置的和本插件定义的

下面是 KillServer 创建的所有事件和 MCDR 服务端控制事件的集合类, 在使用时, 推荐使用此类或直接使用事件 ID

class kill_server.ServerEvents[源代码]

基类：object

装有全部服务器生命周期/控制事件的常量类

该类包含 MCDR 内置的服务器生命周期事件和本插件定义的全部服务器控制事件. 所有的 MCDR 内置声明周期事件均为 MCDREvent 实例, 所有的自定义事件均为 ServerEvent 实例.

参见

MCDR 官方文档:

SERVER_PRE_STARTING: MCDREvent = MCDREvent(id='mcdr.server_start_pre', default_method_name='on_server_start_pre')

服务器准备启动

事件 ID:: mcdr.server_start_pre
回调参数:: PluginServerInterface

参见

https://docs.mcdreforged.com/zh-cn/latest/plugin_dev/event.html#server-start-pre

SERVER_STARTING: MCDREvent = MCDREvent(id='mcdr.server_start', default_method_name='on_server_start')

服务器正在启动

事件 ID:: mcdr.server_start
回调参数:: PluginServerInterface

参见

https://docs.mcdreforged.com/zh-cn/latest/plugin_dev/event.html#server-start

SERVER_STARTED: MCDREvent = MCDREvent(id='mcdr.server_startup', default_method_name='on_server_startup')

服务器已启动

事件 ID:: mcdr.server_startup
回调参数:: PluginServerInterface

参见

https://docs.mcdreforged.com/zh-cn/latest/plugin_dev/event.html#server-startup

SERVER_STOPPING: ServerEvent = ServerEvent(id='kill_server.server_stopping')

服务器正在停止

事件 ID:: kill_server.server_stopping
回调参数:: PluginServerInterface

PLUGIN_STOPPING_SERVER: ServerEvent = ServerEvent(id='kill_server.plugin_stopping_server')

服务器正在被插件/MCDR命令关闭

当且仅当 ServerInterface.stop() 调用时触发

事件 ID:: kill_server.plugin_stopping_server
回调参数:: PluginServerInterface

PLUGIN_KILLING_SERVER: ServerEvent = ServerEvent(id='kill_server.plugin_killing_server')

服务器正在被插件/MCDR命令强制关闭

当且仅当 ServerInterface.kill() 调用时触发

事件 ID:: kill_server.plugin_killing_server
回调参数:: PluginServerInterface

SERVER_STOPPED: MCDREvent = MCDREvent(id='mcdr.server_stop', default_method_name='on_server_stop')

服务器已停止

事件 ID:: mcdr.server_stop
回调参数:: PluginServerInterface, int

参见

https://docs.mcdreforged.com/zh-cn/latest/plugin_dev/event.html#server-stop

WORLD_SAVED: ServerEvent = ServerEvent(id='kill_server.world_saved')

世界已保存

事件 ID:: kill_server.world_saved
回调参数:: PluginServerInterface