跳到主要内容

玩家

适用版本:中国版 3.10。仅中国版可用。

本文主要记录玩家相关的事件,共 45 个。监听方式见事件工作机制。

网易官方文档

AddExpEvent​

服务端
该接口只能在服务端脚本(mod.server.extraServerApi)中调用。

触发时机:当玩家增加经验时触发该事件。

def OnAddExpEvent(self, args: Dict[str, Any]) -> None: ...
  • args["id"]: str,玩家 id。
  • args["addExp"]: int,增加的经验值。

在零件中直接声明一个同名函数,即可完成监听,详情参考零件事件。


AddLevelEvent​

服务端
该接口只能在服务端脚本(mod.server.extraServerApi)中调用。

触发时机:当玩家升级时触发该事件。

def OnAddLevelEvent(self, args: Dict[str, Any]) -> None: ...
  • args["id"]: str,玩家 id。
  • args["addLevel"]: int,增加的等级值。
  • args["newLevel"]: int,新的等级。

在零件中直接声明一个同名函数,即可完成监听,详情参考零件事件。


CameraMotionStartClientEvent​

客户端
该接口只能在客户端脚本(mod.client.extraClientApi)中调用。

相机运动器开始事件。相机添加运动器后,运动器开始运行时触发。

def OnCameraMotionStartClientEvent(self, args: Dict[str, Any]) -> None: ...
  • args["motionId"]: int,运动器 id。

CameraMotionStopClientEvent​

客户端
该接口只能在客户端脚本(mod.client.extraClientApi)中调用。

相机运动器停止事件。相机添加运动器并开始运行后,运动器自动停止时触发。

def OnCameraMotionStopClientEvent(self, args: Dict[str, Any]) -> None: ...
  • args["motionId"]: int,运动器 id。
  • args["remove"]: bool,是否移除该运动器,设置为 False 则保留,默认为 True,即运动器停止后自动移除。

备注


ChangeLevelUpCostServerEvent​

服务端
该接口只能在服务端脚本(mod.server.extraServerApi)中调用。

触发时机:获取玩家下一个等级升级经验时,用于重载玩家的升级经验,每个等级在重置之前都只会触发一次。

def OnChangeLevelUpCostServerEvent(self, args: Dict[str, Any]) -> None: ...
  • args["level"]: int,玩家当前等级。
  • args["levelUpCostExp"]: int,当前等级升级到下个等级需要的经验值,当设置升级经验小于 1 时会被强制调整到 1。
  • args["changed"]: bool,设置为 True,重载玩家升级经验才会生效。
服务端
该接口只能在服务端脚本(mod.server.extraServerApi)中调用。
def OnChangeLevelUpCostServerEvent(self, args: Dict[str, Any]) -> None: ...

服务端

该接口只能在服务端脚本(mod.server.extraServerApi)中调用。
PlayerCompServer

获取组件:serverApi.GetEngineCompFactory().CreatePlayer(playerId)

接口用于重置升级经验。使用 ChangeLevelUpCostServerEvent 事件设置升级经验后,升级经验无法调整。需要调整升级经验时,可使用该接口。使用步骤如下:1、使用 ClearDefineLevelUpconst,2、在升级抛出 ChangeLevelUpCostServerEvent 事件后重新设置经验。

def OnChangeLevelUpCostServerEvent(self, args: Dict[str, Any]) -> None: ...
  • args["level"]: int,指定清理的等级,加入传入的数值小于 0,则清理所有等级的升级经验值缓存。

返回值:bool,是否清理成功。


DimensionChangeClientEvent​

客户端
该接口只能在客户端脚本(mod.client.extraClientApi)中调用。

玩家维度改变时客户端抛出。

def OnDimensionChangeClientEvent(self, args: Dict[str, Any]) -> None: ...
  • args["playerId"]: str,玩家实体 id。
  • args["fromDimensionId"]: int,维度改变前的维度。
  • args["toDimensionId"]: int,维度改变后的维度。
  • args["fromX"]: float,改变前的位置 x。
  • args["fromY"]: float,改变前的位置 Y。
  • args["fromZ"]: float,改变前的位置 Z。
  • args["toX"]: float,改变后的位置 x。
  • args["toY"]: float,改变后的位置 Y。
  • args["toZ"]: float,改变后的位置 Z。

备注

  • 当通过传送门从末地回到主世界时,toY 值为 32767,其他情况一般会比设置值高 1.62。

在零件中直接声明一个同名函数,即可完成监听,详情参考零件事件。


DimensionChangeFinishClientEvent​

客户端
该接口只能在客户端脚本(mod.client.extraClientApi)中调用。

玩家维度改变完成后客户端抛出。

def OnDimensionChangeFinishClientEvent(self, args: Dict[str, Any]) -> None: ...
  • args["playerId"]: str,玩家实体 id。
  • args["fromDimensionId"]: int,维度改变前的维度。
  • args["toDimensionId"]: int,维度改变后的维度。
  • args["toPos"]: Tuple[float, float, float],改变后的位置 x,y,z,其中 y 值为脚底加上角色的身高值。

备注

  • 当通过传送门从末地回到主世界时,toPos 的 y 值为 32767,其他情况一般会比设置值高 1.62。

在零件中直接声明一个同名函数,即可完成监听,详情参考零件事件。


DimensionChangeFinishServerEvent​

服务端
该接口只能在服务端脚本(mod.server.extraServerApi)中调用。

玩家维度改变完成后服务端抛出。

def OnDimensionChangeFinishServerEvent(self, args: Dict[str, Any]) -> None: ...
  • args["playerId"]: str,玩家实体 id。
  • args["fromDimensionId"]: int,维度改变前的维度。
  • args["toDimensionId"]: int,维度改变后的维度。
  • args["toPos"]: Tuple[float, float, float],改变后的位置 x,y,z,其中 y 值为脚底加上角色的身高值。

备注

  • 当通过传送门从末地回到主世界时,toPos 的 y 值为 32767,其他情况一般会比设置值高 1.62。

在零件中直接声明一个同名函数,即可完成监听,详情参考零件事件。


DimensionChangeServerEvent​

服务端
该接口只能在服务端脚本(mod.server.extraServerApi)中调用。

玩家维度改变时服务端抛出。

def OnDimensionChangeServerEvent(self, args: Dict[str, Any]) -> None: ...
  • args["playerId"]: str,玩家实体 id。
  • args["fromDimensionId"]: int,维度改变前的维度。
  • args["toDimensionId"]: int,维度改变后的维度。
  • args["fromX"]: float,改变前的位置 x。
  • args["fromY"]: float,改变前的位置 Y。
  • args["fromZ"]: float,改变前的位置 Z。
  • args["toX"]: float,改变后的位置 x。
  • args["toY"]: float,改变后的位置 Y。
  • args["toZ"]: float,改变后的位置 Z。

备注

  • 当通过传送门从末地回到主世界时,toY 值为 32767,其他情况一般会比设置值高 1.62。

在零件中直接声明一个同名函数,即可完成监听,详情参考零件事件。


ExtinguishFireClientEvent​

客户端
该接口只能在客户端脚本(mod.client.extraClientApi)中调用。

玩家扑灭火焰时触发。下雨,倒水等方式熄灭火焰不会触发。

def OnExtinguishFireClientEvent(self, args: Dict[str, Any]) -> None: ...
  • args["pos"]: Tuple[float, float, float],火焰方块的坐标。
  • args["playerId"]: str,玩家 id。
  • args["cancel"]: bool,修改为 True 时,可阻止玩家扑灭火焰。需要与 ExtinguishFireServerEvent 一起修改。

在零件中直接声明一个同名函数,即可完成监听,详情参考零件事件。


ExtinguishFireServerEvent​

服务端
该接口只能在服务端脚本(mod.server.extraServerApi)中调用。

玩家扑灭火焰时触发。下雨,倒水等方式熄灭火焰不会触发。

def OnExtinguishFireServerEvent(self, args: Dict[str, Any]) -> None: ...
  • args["pos"]: Tuple[float, float, float],火焰方块的坐标。
  • args["playerId"]: str,玩家 id。
  • args["cancel"]: bool,修改为 True 时,可阻止玩家扑灭火焰。需要与 ExtinguishFireClientEvent 一起修改。

在零件中直接声明一个同名函数,即可完成监听,详情参考零件事件。


GameTypeChangedClientEvent​

客户端
该接口只能在客户端脚本(mod.client.extraClientApi)中调用。

个人游戏模式发生变化时客户端触发。

def OnGameTypeChangedClientEvent(self, args: Dict[str, Any]) -> None: ...
  • args["playerId"]: str,玩家 Id。
  • args["oldGameType"]: int,切换前的游戏模式。
  • args["newGameType"]: int,切换后的游戏模式。

备注

  • 游戏模式:GetMinecraftEnum().GameType.*:Survival,Creative,Adventure 分别为 0~2 默认游戏模式发生变化时最后反映在个人游戏模式之上。

在零件中直接声明一个同名函数,即可完成监听,详情参考零件事件。


GameTypeChangedServerEvent​

服务端
该接口只能在服务端脚本(mod.server.extraServerApi)中调用。

当默认游戏模式或个人游戏模式发生变化时服务端触发,如果个人游戏模式不为默认时,修改默认游戏模式也会同时修改个人游戏模式,此时会触发两次该事件。

def OnGameTypeChangedServerEvent(self, args: Dict[str, Any]) -> None: ...
  • args["playerId"]: str,玩家 Id,SetDefaultGameType接口改变游戏模式时该参数为空字符串。
  • args["oldGameType"]: int,切换前的游戏模式。
  • args["newGameType"]: int,切换后的游戏模式。

备注

  • 游戏模式:GetMinecraftEnum().GameType.*:Survival,Creative,Adventure 分别为 0~2,Spectator 为 6 默认游戏模式发生变化时最后反映在个人游戏模式之上。注意:避免在该事件中调用修改 ability 相关的接口,比如 ChangePlayerFlyState 等接口,如确实需要,可加定时器延后调用。

在零件中直接声明一个同名函数,即可完成监听,详情参考零件事件。


MountTamingEvent​

服务端
该接口只能在服务端脚本(mod.server.extraServerApi)中调用。

玩家通过骑乘驯服生物后触发该事件。

def OnMountTamingEvent(self, args: Dict[str, Any]) -> None: ...
  • args["eid"]: str,生物 id。
  • args["pid"]: str,玩家 id。

备注

  • 该事件是检测 minecraft:tamemount 行为包组件,即玩家通过不断骑乘生物,使其冒出爱心时触发。

OnLocalPlayerActionClientEvent​

客户端
该接口只能在客户端脚本(mod.client.extraClientApi)中调用。

玩家动作事件,当本地玩家开始/停止某些动作时触发该事件。

def OnOnLocalPlayerActionClientEvent(self, args: Dict[str, Any]) -> None: ...
  • args["actionType"]: int,动作事件枚举,详见 Minecraft 枚举值文档的PlayerActionType。

OnLocalPlayerStartJumpClientEvent​

客户端
该接口只能在客户端脚本(mod.client.extraClientApi)中调用。

本地玩家开始跳跃时触发。

def OnOnLocalPlayerStartJumpClientEvent(self, args: Dict[str, Any]) -> None: ...

OnPlayerActionServerEvent​

服务端
该接口只能在服务端脚本(mod.server.extraServerApi)中调用。

玩家动作事件,当玩家开始/停止某些动作时触发该事件。

def OnOnPlayerActionServerEvent(self, args: Dict[str, Any]) -> None: ...
  • args["playerId"]: str,玩家 id。
  • args["actionType"]: int,动作事件枚举,详见 Minecraft 枚举值文档的PlayerActionType。

在零件中直接声明一个同名函数,即可完成监听,详情参考零件事件。


OnPlayerHitBlockClientEvent​

客户端
该接口只能在客户端脚本(mod.client.extraClientApi)中调用。

触发时机:通过 OpenPlayerHitBlockDetection 打开方块碰撞检测后,当玩家碰撞到方块时触发该事件。玩家着地时会触发 OnGroundClientEvent,而不是该事件。客户端和服务端分别作碰撞检测,可能两个事件返回的结果略有差异。

def OnOnPlayerHitBlockClientEvent(self, args: Dict[str, Any]) -> None: ...
  • args["playerId"]: str,碰撞到方块的玩家 Id。
  • args["posX"]: int,碰撞方块 x 坐标。
  • args["posY"]: int,碰撞方块 y 坐标。
  • args["posZ"]: int,碰撞方块 z 坐标。
  • args["blockId"]: str,碰撞方块的 identifier。
  • args["auxValue"]: int,碰撞方块的附加值。

在零件中直接声明一个同名函数,即可完成监听,详情参考零件事件。

客户端
该接口只能在客户端脚本(mod.client.extraClientApi)中调用。
def OnOnPlayerHitBlockClientEvent(self, args: Dict[str, Any]) -> None: ...

客户端

该接口只能在客户端脚本(mod.client.extraClientApi)中调用。
PlayerCompClient

获取组件:clientApi.GetEngineCompFactory().CreatePlayer(entityId)

开启碰撞方块的检测,开启后碰撞时会触发 OnPlayerHitBlockClientEvent 事件。

def OnOnPlayerHitBlockClientEvent(self, args: Dict[str, Any]) -> None: ...
  • args["precision"]: float,碰撞检测精度,参数需要在区间[0, 1),值越小,表示碰撞检测精度越高(可以理解为轻轻碰一下就能触发)。

返回值:bool,是否设置成功。

备注

  • 注:该碰撞检测会屏蔽草、空气、火、高草四种方块。

客户端

该接口只能在客户端脚本(mod.client.extraClientApi)中调用。
PlayerCompClient

获取组件:clientApi.GetEngineCompFactory().CreatePlayer(entityId)

关闭碰撞方块的检测,关闭后将不会触发 OnPlayerHitBlockClientEvent 事件。

def OnOnPlayerHitBlockClientEvent(self, args: Dict[str, Any]) -> None: ...

返回值:bool,是否设置成功。


OnPlayerHitBlockServerEvent​

服务端
该接口只能在服务端脚本(mod.server.extraServerApi)中调用。

触发时机:通过 OpenPlayerHitBlockDetection 打开方块碰撞检测后,当玩家碰撞到方块时触发该事件。监听玩家着地请使用客户端的 OnGroundClientEvent。客户端和服务端分别作碰撞检测,可能两个事件返回的略有差异。

def OnOnPlayerHitBlockServerEvent(self, args: Dict[str, Any]) -> None: ...
  • args["playerId"]: str,碰撞到方块的玩家 Id。
  • args["posX"]: int,碰撞方块 x 坐标。
  • args["posY"]: int,碰撞方块 y 坐标。
  • args["posZ"]: int,碰撞方块 z 坐标。
  • args["blockId"]: str,碰撞方块的 identifier。
  • args["auxValue"]: int,碰撞方块的附加值。
  • args["dimensionId"]: int,维度 id。

在零件中直接声明一个同名函数,即可完成监听,详情参考零件事件。

服务端
该接口只能在服务端脚本(mod.server.extraServerApi)中调用。
def OnOnPlayerHitBlockServerEvent(self, args: Dict[str, Any]) -> None: ...

服务端

该接口只能在服务端脚本(mod.server.extraServerApi)中调用。
PlayerCompServer

获取组件:serverApi.GetEngineCompFactory().CreatePlayer(playerId)

开启碰撞方块的检测,开启后碰撞时会触发 OnPlayerHitBlockServerEvent 事件。

def OnOnPlayerHitBlockServerEvent(self, args: Dict[str, Any]) -> None: ...
  • args["precision"]: float,碰撞检测精度,参数需要在区间[0, 1),值越小,表示碰撞检测精度越高(可以理解为轻轻碰一下就能触发)。

返回值:bool,是否设置成功。

备注

  • 注:该碰撞检测会屏蔽草、空气、火、高草四种方块。

服务端

该接口只能在服务端脚本(mod.server.extraServerApi)中调用。
PlayerCompServer

获取组件:serverApi.GetEngineCompFactory().CreatePlayer(playerId)

关闭碰撞方块的检测,关闭后将不会触发 OnPlayerHitBlockServerEvent 事件。

def OnOnPlayerHitBlockServerEvent(self, args: Dict[str, Any]) -> None: ...

返回值:bool,是否设置成功。


PerspChangeClientEvent​

客户端
该接口只能在客户端脚本(mod.client.extraClientApi)中调用。

视角切换时会触发的事件。

def OnPerspChangeClientEvent(self, args: Dict[str, Any]) -> None: ...
  • args["from"]: int,切换前的视角。
  • args["to"]: int,切换后的视角。

备注

  • 视角数字代表含义 0: 第一人称 1: 第三人称背面 2: 第三人称正面。

PlayerAttackEntityEvent​

服务端
该接口只能在服务端脚本(mod.server.extraServerApi)中调用。

触发时机:当玩家攻击时触发该事件。

def OnPlayerAttackEntityEvent(self, args: Dict[str, Any]) -> None: ...
  • args["playerId"]: str,玩家 id。
  • args["victimId"]: str,受击者 id。
  • args["damage"]: float,伤害值:引擎传过来的值是 0 允许脚本层修改为其他数。
  • args["isValid"]: int,脚本是否设置伤害值:1 表示是;0 表示否。
  • args["cancel"]: bool,是否取消该次攻击,默认不取消。
  • args["isKnockBack"]: bool,是否支持击退效果,默认支持,当不支持时将屏蔽武器击退附魔效果。
  • args["isCrit"]: bool,本次攻击是否产生暴击,不支持修改。

在零件中直接声明一个同名函数,即可完成监听,详情参考零件事件。

客户端
该接口只能在客户端脚本(mod.client.extraClientApi)中调用。

触发时机:当本地玩家攻击时触发该事件。

def OnPlayerAttackEntityEvent(self, args: Dict[str, Any]) -> None: ...
  • args["playerId"]: str,玩家 id。
  • args["victimId"]: str,受击者 id。
  • args["damage"]: float,客户端收到的是真实伤害值,且修改无效。
  • args["isCrit"]: bool,本次攻击是否产生暴击,不支持修改。

在零件中直接声明一个同名函数,即可完成监听,详情参考零件事件。


PlayerCheatSpinAttackServerEvent​

服务端
该接口只能在服务端脚本(mod.server.extraServerApi)中调用。

触发时机:玩家开始/结束快速旋转攻击并且不符合发送快速旋转攻击条件时触发(装备激流附魔的三叉戟、在水中或雨中,且未骑乘)。

def OnPlayerCheatSpinAttackServerEvent(self, args: Dict[str, Any]) -> None: ...
  • args["playerId"]: str,玩家的 entityId。
  • args["isStart"]: bool,True 时代表开始快速旋转攻击;False 时代表结束快速旋转攻击。

备注

  • 假如没有自定义类似三叉戟/激流附魔的物品,那么触发此事件说明此有很大可能此玩家使用了【杀戮光环】外挂。

仅 Apollo 可用

在零件中直接声明一个同名函数,即可完成监听,详情参考零件事件。


PlayerDieEvent​

服务端
该接口只能在服务端脚本(mod.server.extraServerApi)中调用。

触发时机:当玩家死亡时触发该事件。

def OnPlayerDieEvent(self, args: Dict[str, Any]) -> None: ...
  • args["id"]: str,玩家 id。
  • args["attacker"]: str,伤害来源 id。
  • args["customTag"]: str,使用Hurt 接口传入的自定义伤害类型。
  • args["cause"]: str,伤害来源,详见 Minecraft 枚举值文档的ActorDamageCause。

在零件中直接声明一个同名函数,即可完成监听,详情参考零件事件。


PlayerDoInteractServerEvent​

服务端
该接口只能在服务端脚本(mod.server.extraServerApi)中调用。

玩家与有 minecraft:interact 组件的生物交互时触发该事件,例如玩家手持空桶对牛挤奶、玩家手持打火石点燃苦力怕。

def OnPlayerDoInteractServerEvent(self, args: Dict[str, Any]) -> None: ...
  • args["playerId"]: str,玩家 id。
  • args["itemDict"]: Dict[str, Any],交互时使用物品的物品信息字典。
  • args["interactEntityId"]: str,交互的生物 entityId。

在零件中直接声明一个同名函数,即可完成监听,详情参考零件事件。


PlayerEatFoodServerEvent​

服务端
该接口只能在服务端脚本(mod.server.extraServerApi)中调用。

触发时机:玩家吃下食物时触发。

def OnPlayerEatFoodServerEvent(self, args: Dict[str, Any]) -> None: ...
  • args["playerId"]: str,玩家 Id。
  • args["itemDict"]: Dict[str, Any],食物物品的物品信息字典。
  • args["hunger"]: int,食物增加的饥饿值,可修改。
  • args["nutrition"]: float,食物的营养价值,回复饱和度 = 食物增加的饥饿值 * 食物的营养价值 * 2,饱和度最大不超过当前饥饿值,可修改。

备注

  • 由于牛奶本身并没有饱食度的概念,因此,当喝牛奶触发该事件时,饥饿度、营养价值字段无效并始终为 0。

在零件中直接声明一个同名函数,即可完成监听,详情参考零件事件。


PlayerFeedEntityServerEvent​

服务端
该接口只能在服务端脚本(mod.server.extraServerApi)中调用。

玩家喂养生物时触发,例如玩家手持小麦喂养牛、玩家手持胡萝卜喂养幼年猪。

def OnPlayerFeedEntityServerEvent(self, args: Dict[str, Any]) -> None: ...
  • args["playerId"]: str,主动喂养生物的玩家的唯一 ID。
  • args["entityId"]: str,被喂养生物的唯一 ID。
  • args["itemDict"]: Dict[str, Any],当前玩家手持物品的物品信息字典。
  • args["cancel"]: bool,是否取消触发,默认为 False,若设为 True,可阻止触发后续的生物喂养逻辑。

备注

  • 1.对于幼年生物,用对应的物品喂养后就可以触发事件,例如用小麦喂养幼年牛、用生鲑鱼喂养幼年猫;2.对于成年生物,用对应的物品喂养后,该生物要进入“求爱模式”(持续散发红心粒子),才可以触发事件。特殊的成年生物列举如下:a.可骑乘生物,例如马,玩家要驯服马后,再给它喂养食物(例如金苹果、金萝卜),才可以触发事件;已驯服的马受伤后,用金苹果喂养时会治疗马,不触发事件,马的血量回满时,再喂养金苹果,才会触发事件;b.可驯服生物,例如狼,玩家要用骨头驯服狼后,再给它喂养肉类物品(例如熟猪排),才可以触发事件;c.需要在特定环境下才能繁殖的生物,例如熊猫,玩家用竹子喂养熊猫时,熊猫的 5 格内至少要有 8 根竹子,喂养后才可以触发事件。3.该事件中如需调用使用手持物相关的接口,如 PlayerUseItemToEntity 或其他设置物品数量的接口,会导致接口正常调用但是物品数量计算异常,建议通过 timer 延迟调用。

在零件中直接声明一个同名函数,即可完成监听,详情参考零件事件。


PlayerFishingAfterServerEvent​

服务端
该接口只能在服务端脚本(mod.server.extraServerApi)中调用。

玩家钓鱼成功收杆后触发,在钓鱼掉落物生成后触发。

def OnPlayerFishingAfterServerEvent(self, args: Dict[str, Any]) -> None: ...
  • args["playerId"]: str,钓鱼的玩家 id。
  • args["hookEntity"]: str,鱼钩实体 id。
  • args["itemDict"]: Dict[str, Any],玩家手持鱼竿的物品信息字典。
  • args["itemList"]: List[Dict[str, Any]],钓鱼获得的物品信息字典列表(只读)。
  • args["itemEntityIdList"]: List[str],钓鱼生成的掉落物实体 id 列表,与 itemList 一一对应。

备注

  • 此事件在掉落物实体生成后触发,可通过 itemEntityIdList 获取生成的掉落物实体 id 进行后续操作。

在零件中直接声明一个同名函数,即可完成监听,详情参考零件事件。


PlayerFishingServerEvent​

服务端
该接口只能在服务端脚本(mod.server.extraServerApi)中调用。

玩家钓鱼成功收杆时触发,在钓鱼掉落物生成前触发。

def OnPlayerFishingServerEvent(self, args: Dict[str, Any]) -> None: ...
  • args["playerId"]: str,钓鱼的玩家 id。
  • args["hookEntity"]: str,鱼钩实体 id。
  • args["itemDict"]: Dict[str, Any],玩家手持鱼竿的物品信息字典。
  • args["itemList"]: List[Dict[str, Any]],钓鱼获得的物品信息字典列表,支持修改。修改后需将 itemChange 设置为 True。
  • args["itemChange"]: bool,是否修改了 itemList,默认为 False。当修改了 itemList 时需要设置为 True 才能生效。
  • args["cancel"]: bool,是否取消钓鱼成功,设置为 True 时不会生成掉落物。

备注

  • 设置 cancel 为 True 时,不会生成掉落物,也不会触发 PlayerFishingAfterServerEvent 事件。
  • 修改 itemList 后必须设置 itemChange 为 True,否则修改不会生效。

在零件中直接声明一个同名函数,即可完成监听,详情参考零件事件。


PlayerHungerChangeServerEvent​

服务端
该接口只能在服务端脚本(mod.server.extraServerApi)中调用。

玩家饥饿度变化时触发该事件。

def OnPlayerHungerChangeServerEvent(self, args: Dict[str, Any]) -> None: ...
  • args["playerId"]: str,玩家 id。
  • args["hungerBefore"]: float,变化前的饥饿度。
  • args["hunger"]: float,变化后的饥饿度。
  • args["cancel"]: bool,是否取消饥饿度变化。

备注

  • 当通过 setplayerhunger 接口设置饥饿度时,不会触发服务端对应的事件。
  • 当通过/hunger 等指令设置饥饿度设置时,hunger 字段值可能会超过最大饥饿度。

在零件中直接声明一个同名函数,即可完成监听,详情参考零件事件。


PlayerHurtEvent​

服务端
该接口只能在服务端脚本(mod.server.extraServerApi)中调用。

触发时机:当玩家受伤害前触发该事件。

def OnPlayerHurtEvent(self, args: Dict[str, Any]) -> None: ...
  • args["id"]: str,受击玩家 id。
  • args["attacker"]: str,伤害来源实体 id,若没有实体攻击,例如高空坠落,id 为-1。
  • args["customTag"]: str,使用Hurt 接口传入的自定义伤害类型。
  • args["cause"]: str,伤害来源,详见 Minecraft 枚举值文档的ActorDamageCause。

在零件中直接声明一个同名函数,即可完成监听,详情参考零件事件。


PlayerInteractServerEvent​

服务端
该接口只能在服务端脚本(mod.server.extraServerApi)中调用。

触发时机:玩家可以与实体交互时。如果是鼠标控制模式,则当准心对着实体时触发。如果是触屏模式,则触发时机与屏幕下方的交互按钮显示的时机相同。玩家真正与实体发生交互的事件见 PlayerDoInteractServerEvent。

def OnPlayerInteractServerEvent(self, args: Dict[str, Any]) -> None: ...
  • args["cancel"]: bool,是否取消触发,默认为 False,若设为 True,可阻止触发后续的实体交互事件。
  • args["playerId"]: str,主动与实体互动的玩家的唯一 ID。
  • args["itemDict"]: Dict[str, Any],当前玩家手持物品的物品信息字典。
  • args["victimId"]: str,被动的实体的唯一 ID。

在零件中直接声明一个同名函数,即可完成监听,详情参考零件事件。


PlayerNamedEntityServerEvent​

服务端
该接口只能在服务端脚本(mod.server.extraServerApi)中调用。

玩家用命名牌重命名实体时触发,例如玩家手持命名牌对羊修改名字、玩家手持命名牌对盔甲架修改名字。

def OnPlayerNamedEntityServerEvent(self, args: Dict[str, Any]) -> None: ...
  • args["playerId"]: str,主动命名实体的玩家的唯一 ID。
  • args["entityId"]: str,被命名实体的唯一 ID。
  • args["preName"]: str,实体当前的名字。
  • args["afterName"]: str,实体重命名后的名字。
  • args["cancel"]: bool,是否取消触发,默认为 False,若设为 True,可阻止触发后续的实体命名逻辑。

在零件中直接声明一个同名函数,即可完成监听,详情参考零件事件。


PlayerPermissionChangeClientEvent​

客户端
该接口只能在客户端脚本(mod.client.extraClientApi)中调用。

玩家权限变更事件。

def OnPlayerPermissionChangeClientEvent(self, args: Dict[str, Any]) -> None: ...
  • args["causePlayerId"]: str,发起者 id。
  • args["playerId"]: str,玩家 id。
  • args["oldPermission"]: Dict[str, Any],变化前的权限字典。
  • args["newPermission"]: Dict[str, Any],变化后的权限字典。
  • args["changeCause"]: int,变化原因,详见 Minecraft 枚举值文档的PermissionChangeCause。

备注

  • 具体权限说明:
权限字段类型说明
buildbool放置方块
minebool采集方块
doorsandswitchesbool使用门和开关
opencontainersbool打开容器
attackplayersbool攻击玩家
attackmobsbool攻击生物
opbool操作员命令
teleportbool使用传送
  • 当 PlayerPermissionChangeServerEvent 事件返回"cancel"为 True 时,权限变动被取消,该事件不会触发。
  • 如果进入游戏的玩家权限为“成员”时,不会触发此事件。

在零件中直接声明一个同名函数,即可完成监听,详情参考零件事件。


PlayerPermissionChangeServerEvent​

服务端
该接口只能在服务端脚本(mod.server.extraServerApi)中调用。

玩家权限变更事件。

def OnPlayerPermissionChangeServerEvent(self, args: Dict[str, Any]) -> None: ...
  • args["causePlayerId"]: str,发起者 id。
  • args["playerId"]: str,玩家 id。
  • args["oldPermission"]: Dict[str, Any],变化前的权限字典。
  • args["newPermission"]: Dict[str, Any],变化后的权限字典。
  • args["changeCause"]: int,变化原因,详见 Minecraft 枚举值文档的PermissionChangeCause。
  • args["cancel"]: bool,为 true 时,取消本次权限变更。

备注

  • 具体权限说明:
权限字段类型说明
buildbool放置方块
minebool采集方块
doorsandswitchesbool使用门和开关
opencontainersbool打开容器
attackplayersbool攻击玩家
attackmobsbool攻击生物
opbool操作员命令
teleportbool使用传送

在零件中直接声明一个同名函数,即可完成监听,详情参考零件事件。


PlayerRespawnEvent​

服务端
该接口只能在服务端脚本(mod.server.extraServerApi)中调用。

触发时机:玩家复活时触发该事件。

def OnPlayerRespawnEvent(self, args: Dict[str, Any]) -> None: ...
  • args["id"]: str,玩家 id。

备注

  • 该事件为玩家点击重生按钮时触发,但是触发时玩家可能尚未完成复活,此时请勿对玩家进行切维度或设置生命值等操作 一般情况下推荐使用 PlayerRespawnFinishServerEvent。

在零件中直接声明一个同名函数,即可完成监听,详情参考零件事件。


PlayerRespawnFinishServerEvent​

服务端
该接口只能在服务端脚本(mod.server.extraServerApi)中调用。

触发时机:玩家复活完毕时触发。

def OnPlayerRespawnFinishServerEvent(self, args: Dict[str, Any]) -> None: ...
  • args["playerId"]: str,玩家 id。

备注

  • 该事件触发时玩家已重生完毕,可以安全使用切维度等操作。
  • 通过末地传送门回到主世界时也算重生,同样也会触发该事件。

在零件中直接声明一个同名函数,即可完成监听,详情参考零件事件。


PlayerSleepServerEvent​

服务端
该接口只能在服务端脚本(mod.server.extraServerApi)中调用。

玩家使用床睡觉成功。

def OnPlayerSleepServerEvent(self, args: Dict[str, Any]) -> None: ...
  • args["playerId"]: str,玩家 id。
  • args["fullName"]: str,方块 id。
  • args["auxData"]: int,方块附加值。
  • args["dimensionid"]: int,维度 id。
  • args["x"]: int,方块 x 坐标。
  • args["y"]: int,方块 y 坐标。
  • args["z"]: int,方块 z 坐标。

在零件中直接声明一个同名函数,即可完成监听,详情参考零件事件。


PlayerSpinAttackServerEvent​

服务端
该接口只能在服务端脚本(mod.server.extraServerApi)中调用。

触发时机:玩家开始/结束快速旋转攻击时触发。

def OnPlayerSpinAttackServerEvent(self, args: Dict[str, Any]) -> None: ...
  • args["playerId"]: str,玩家的 entityId。
  • args["isInWaterOrRain"]: bool,是否在水中或雨中。
  • args["isRiding"]: bool,是否骑乘状态。
  • args["isStart"]: bool,True 时代表开始快速旋转攻击;False 时代表结束快速旋转攻击。

仅 Apollo 可用

在零件中直接声明一个同名函数,即可完成监听,详情参考零件事件。


PlayerStartFishingServerEvent​

服务端
该接口只能在服务端脚本(mod.server.extraServerApi)中调用。

玩家开始钓鱼,生成鱼钩时在服务端触发。

def OnPlayerStartFishingServerEvent(self, args: Dict[str, Any]) -> None: ...
  • args["playerId"]: str,钓鱼成功的玩家 id。
  • args["hookEntity"]: str,鱼钩实体 id。
  • args["itemDict"]: Dict[str, Any],玩家手持鱼竿的物品信息字典。
  • args["cancel"]: bool,是否取消,设置为 True 时会取消生成鱼漂。

备注

  • 此事件在鱼钩实体生成后触发,设置 cancel 为 True 可取消本次抛竿操作。

在零件中直接声明一个同名函数,即可完成监听,详情参考零件事件。


PlayerStopSleepServerEvent​

服务端
该接口只能在服务端脚本(mod.server.extraServerApi)中调用。

玩家停止睡觉。

def OnPlayerStopSleepServerEvent(self, args: Dict[str, Any]) -> None: ...
  • args["playerId"]: str,玩家 id。
  • args["fullName"]: str,方块 id。
  • args["auxData"]: int,方块附加值。
  • args["dimensionid"]: int,维度 id。
  • args["x"]: int,方块 x 坐标。
  • args["y"]: int,方块 y 坐标。
  • args["z"]: int,方块 z 坐标。

在零件中直接声明一个同名函数,即可完成监听,详情参考零件事件。


PlayerTeleportEvent​

服务端
该接口只能在服务端脚本(mod.server.extraServerApi)中调用。

触发时机:当玩家传送时触发该事件,如:玩家使用末影珍珠或 tp 指令时。

def OnPlayerTeleportEvent(self, args: Dict[str, Any]) -> None: ...
  • args["id"]: str,玩家 id。

在零件中直接声明一个同名函数,即可完成监听,详情参考零件事件。


PlayerTrySleepServerEvent​

服务端
该接口只能在服务端脚本(mod.server.extraServerApi)中调用。

玩家尝试使用床睡觉。

def OnPlayerTrySleepServerEvent(self, args: Dict[str, Any]) -> None: ...
  • args["playerId"]: str,玩家 id。
  • args["cancel"]: bool,是否取消(开发者传入)。

在零件中直接声明一个同名函数,即可完成监听,详情参考零件事件。


ServerPlayerGetExperienceOrbEvent​

服务端
该接口只能在服务端脚本(mod.server.extraServerApi)中调用。

触发时机:玩家获取经验球时触发的事件。

def OnServerPlayerGetExperienceOrbEvent(self, args: Dict[str, Any]) -> None: ...
  • args["playerId"]: str,玩家 id。
  • args["experienceValue"]: int,经验球经验值。
  • args["cancel"]: bool,是否取消(开发者传入)。

备注

  • cancel 值设为 True 时,捡起的经验球不会增加经验值,但是经验球一样会消失。

在零件中直接声明一个同名函数,即可完成监听,详情参考零件事件。


StoreBuySuccServerEvent​

服务端
该接口只能在服务端脚本(mod.server.extraServerApi)中调用。

触发时机:玩家游戏内购买商品时服务端抛出的事件。

def OnStoreBuySuccServerEvent(self, args: Dict[str, Any]) -> None: ...
  • args["playerId"]: str,购买商品的玩家实体 id。

在零件中直接声明一个同名函数,即可完成监听,详情参考零件事件。


UpdatePlayerSkinClientEvent​

客户端
该接口只能在客户端脚本(mod.client.extraClientApi)中调用。

触发时机:玩家加入游戏或通过更衣室局内换肤后 同步皮肤信息至客户端后触发。

def OnUpdatePlayerSkinClientEvent(self, args: Dict[str, Any]) -> None: ...
  • args["playerId"]: str,更换皮肤的玩家 id。

备注

在零件中直接声明一个同名函数,即可完成监听,详情参考零件事件。