xiaokun/netease-modsdk-wiki
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

2.6

Browse Source
This commit is contained in:
boybook
2025-12-01 20:59:16 +08:00
parent 12738a142c
commit 760c2dd9ad
5535 changed files with 21070 additions and 2021 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
docs/mcdocs/1-ModAPI/事件/世界.md
View File

@@ -10,7 +10,7 @@ sidebarDepth: 1
| [AchievementCompleteEvent](世界.md#achievementcompleteevent) | <span style="display:inline;color:#ff5555">服务端</span> | 玩家完成自定义成就时触发该事件 |
| [AddEntityClientEvent](世界.md#addentityclientevent) | <span style="display:inline;color:#7575f9">客户端</span> | 客户端侧创建新实体时触发 |
| [AddEntityServerEvent](世界.md#addentityserverevent) | <span style="display:inline;color:#ff5555">服务端</span> | 服务端侧创建新实体，或实体从存档加载时触发 |
| [AddPlayerAOIClientEvent](世界.md#addplayeraoiclientevent) | <span style="display:inline;color:#7575f9">客户端</span> | 玩家加入游戏或者其余玩家进入当前玩家视野时触发的事件，替换AddPlayerEvent |
| [AddPlayerAOIClientEvent](世界.md#addplayeraoiclientevent) | <span style="display:inline;color:#7575f9">客户端</span> | 玩家加入游戏时视野内存在其他玩家，或者其余玩家进入当前玩家视野时触发的事件，替换AddPlayerEvent |
| [AddPlayerCreatedClientEvent](世界.md#addplayercreatedclientevent) | <span style="display:inline;color:#7575f9">客户端</span> | 玩家进入当前玩家所在的区块AOI后，玩家皮肤数据异步加载完成后触发的事件 |
| [AddServerPlayerEvent](世界.md#addserverplayerevent) | <span style="display:inline;color:#ff5555">服务端</span> | 触发时机：玩家加入时触发该事件。 |
| [ChunkAcquireDiscardedClientEvent](世界.md#chunkacquirediscardedclientevent) | <span style="display:inline;color:#7575f9">客户端</span> | 触发时机：客户端区块即将被卸载时 |
@@ -148,7 +148,7 @@ sidebarDepth: 1
- 描述
玩家加入游戏或者其余玩家进入当前玩家视野时触发的事件，替换AddPlayerEvent
玩家加入游戏时视野内存在其他玩家，或者其余玩家进入当前玩家视野时触发的事件，替换AddPlayerEvent
- 参数
@@ -162,6 +162,7 @@ sidebarDepth: 1
- 备注
- 该事件触发只表明在服务端数据中接收到了新玩家，并不能代表此时玩家在客户端中可见，若想在玩家进入视野后立马调用玩家渲染相关接口，建议使用[AddPlayerCreatedClientEvent](#addplayercreatedclientevent)。
- 玩家加入游戏时视野内每存在一位其他玩家便触发一次该事件，若无其他玩家，则不触发
在零件中直接声明一个同名函数，即可完成监听，详情参考<a href="../../../mcguide/20-玩法开发/14-预设玩法编程/12-深入理解零件/0-零件开发.html#零件事件">零件事件</a>

20
docs/mcdocs/1-ModAPI/事件/事件索引表.md
View File

@@ -22,7 +22,7 @@ sidebarDepth: 1
| [AchievementCompleteEvent](世界.md#achievementcompleteevent) | <span style="display:inline;color:#ff5555">服务端</span> | 玩家完成自定义成就时触发该事件 |
| [AddEntityClientEvent](世界.md#addentityclientevent) | <span style="display:inline;color:#7575f9">客户端</span> | 客户端侧创建新实体时触发 |
| [AddEntityServerEvent](世界.md#addentityserverevent) | <span style="display:inline;color:#ff5555">服务端</span> | 服务端侧创建新实体，或实体从存档加载时触发 |
| [AddPlayerAOIClientEvent](世界.md#addplayeraoiclientevent) | <span style="display:inline;color:#7575f9">客户端</span> | 玩家加入游戏或者其余玩家进入当前玩家视野时触发的事件，替换AddPlayerEvent |
| [AddPlayerAOIClientEvent](世界.md#addplayeraoiclientevent) | <span style="display:inline;color:#7575f9">客户端</span> | 玩家加入游戏时视野内存在其他玩家，或者其余玩家进入当前玩家视野时触发的事件，替换AddPlayerEvent |
| [AddPlayerCreatedClientEvent](世界.md#addplayercreatedclientevent) | <span style="display:inline;color:#7575f9">客户端</span> | 玩家进入当前玩家所在的区块AOI后，玩家皮肤数据异步加载完成后触发的事件 |
| [AddServerPlayerEvent](世界.md#addserverplayerevent) | <span style="display:inline;color:#ff5555">服务端</span> | 触发时机：玩家加入时触发该事件。 |
| [ChunkAcquireDiscardedClientEvent](世界.md#chunkacquirediscardedclientevent) | <span style="display:inline;color:#7575f9">客户端</span> | 触发时机：客户端区块即将被卸载时 |
@@ -145,6 +145,8 @@ sidebarDepth: 1
| [PlayerHurtEvent](玩家.md#playerhurtevent) | <span style="display:inline;color:#ff5555">服务端</span> | 触发时机：当玩家受伤害前触发该事件。 |
| [PlayerInteractServerEvent](玩家.md#playerinteractserverevent) | <span style="display:inline;color:#ff5555">服务端</span> | 触发时机：玩家可以与实体交互时。如果是鼠标控制模式，则当准心对着实体时触发。如果是触屏模式，则触发时机与屏幕下方的交互按钮显示的时机相同。玩家真正与实体发生交互的事件见[PlayerDoInteractServerEvent](玩家.md#playerdointeractserverevent) |
| [PlayerNamedEntityServerEvent](玩家.md#playernamedentityserverevent) | <span style="display:inline;color:#ff5555">服务端</span> | 玩家用命名牌重命名实体时触发，例如玩家手持命名牌对羊修改名字、玩家手持命名牌对盔甲架修改名字。 |
| [PlayerPermissionChangeClientEvent](玩家.md#playerpermissionchangeclientevent) | <span style="display:inline;color:#7575f9">客户端</span> | 玩家权限变更事件 |
| [PlayerPermissionChangeServerEvent](玩家.md#playerpermissionchangeserverevent) | <span style="display:inline;color:#ff5555">服务端</span> | 玩家权限变更事件 |
| [PlayerRespawnEvent](玩家.md#playerrespawnevent) | <span style="display:inline;color:#ff5555">服务端</span> | 触发时机：玩家复活时触发该事件。 |
| [PlayerRespawnFinishServerEvent](玩家.md#playerrespawnfinishserverevent) | <span style="display:inline;color:#ff5555">服务端</span> | 触发时机：玩家复活完毕时触发 |
| [PlayerSleepServerEvent](玩家.md#playersleepserverevent) | <span style="display:inline;color:#ff5555">服务端</span> | 玩家使用床睡觉成功 |
@@ -154,6 +156,7 @@ sidebarDepth: 1
| [PlayerTrySleepServerEvent](玩家.md#playertrysleepserverevent) | <span style="display:inline;color:#ff5555">服务端</span> | 玩家尝试使用床睡觉 |
| [ServerPlayerGetExperienceOrbEvent](玩家.md#serverplayergetexperienceorbevent) | <span style="display:inline;color:#ff5555">服务端</span> | 触发时机：玩家获取经验球时触发的事件 |
| [StoreBuySuccServerEvent](玩家.md#storebuysuccserverevent) | <span style="display:inline;color:#ff5555">服务端</span> | 触发时机:玩家游戏内购买商品时服务端抛出的事件 |
| [UpdatePlayerSkinClientEvent](玩家.md#updateplayerskinclientevent) | <span style="display:inline;color:#7575f9">客户端</span> | 触发时机：玩家加入游戏或通过更衣室局内换肤后 同步皮肤信息至客户端后触发 |
## 方块
| 事件| <div style="width: 3em"></div> | 描述 |
@@ -219,8 +222,8 @@ sidebarDepth: 1
| [ActorUseItemClientEvent](物品.md#actoruseitemclientevent) | <span style="display:inline;color:#7575f9">客户端</span> | 触发时机：玩家使用物品时客户端抛出的事件（比较特殊不走该事件的例子：1）染料对有水的炼药锅使用；2）盔甲架装备盔甲）;3)喝牛奶 |
| [ActorUseItemServerEvent](物品.md#actoruseitemserverevent) | <span style="display:inline;color:#ff5555">服务端</span> | 触发时机：玩家使用物品生效之前服务端抛出的事件（比较特殊不走该事件的例子：1）染料对有水的炼药锅使用；2）盔甲架装备盔甲） |
| [AnvilCreateResultItemAfterClientEvent](物品.md#anvilcreateresultitemafterclientevent) | <span style="display:inline;color:#7575f9">客户端</span> | 玩家点击铁砧合成得到的物品时抛出的事件。 |
| [ClientItemTryUseEvent](物品.md#clientitemtryuseevent) | <span style="display:inline;color:#7575f9">客户端</span> | 玩家点击右键尝试使用物品时客户端抛出的事件，可以通过设置cancel为True取消使用物品。注：ClientItemTryUseEvent事件设置cancel时即可取消使用，无需服务端ServerItemTryUseEvent再次cancel，且服务端事件将不再触发。 |
| [ClientItemUseOnEvent](物品.md#clientitemuseonevent) | <span style="display:inline;color:#7575f9">客户端</span> | 玩家在对方块使用物品时客户端抛出的事件。注：事件设置ret = True 时即可取消使用，无需服务端再次设置ServerItemUseOnEvent取消，且服务端事件将不再触发。 |
| [ClientItemTryUseEvent](物品.md#clientitemtryuseevent) | <span style="display:inline;color:#7575f9">客户端</span> | 玩家点击右键尝试使用物品时客户端抛出的事件，可以通过设置cancel为True取消使用物品。 |
| [ClientItemUseOnEvent](物品.md#clientitemuseonevent) | <span style="display:inline;color:#7575f9">客户端</span> | 玩家在对方块使用物品时客户端抛出的事件。 |
| [ClientShapedRecipeTriggeredEvent](物品.md#clientshapedrecipetriggeredevent) | <span style="display:inline;color:#7575f9">客户端</span> | 玩家合成物品时触发 |
| [ContainerItemChangedServerEvent](物品.md#containeritemchangedserverevent) | <span style="display:inline;color:#ff5555">服务端</span> | 容器物品变化事件 |
| [CraftItemOutputChangeServerEvent](物品.md#craftitemoutputchangeserverevent) | <span style="display:inline;color:#ff5555">服务端</span> | 玩家从容器拿出生成物品时触发 |
@@ -230,6 +233,8 @@ sidebarDepth: 1
| [InventoryItemChangedClientEvent](物品.md#inventoryitemchangedclientevent) | <span style="display:inline;color:#7575f9">客户端</span> | 玩家背包物品变化时客户端抛出的事件。 |
| [InventoryItemChangedServerEvent](物品.md#inventoryitemchangedserverevent) | <span style="display:inline;color:#ff5555">服务端</span> | 玩家背包物品变化时服务端抛出的事件。 |
| [ItemDurabilityChangedServerEvent](物品.md#itemdurabilitychangedserverevent) | <span style="display:inline;color:#ff5555">服务端</span> | 物品耐久度变化事件 |
| [ItemPullOutCustomContainerServerEvent](物品.md#itempulloutcustomcontainerserverevent) | <span style="display:inline;color:#ff5555">服务端</span> | 漏出物品到漏斗时触发该事件 |
| [ItemPushInCustomContainerServerEvent](物品.md#itempushincustomcontainerserverevent) | <span style="display:inline;color:#ff5555">服务端</span> | 漏斗漏入物品时触发该事件 |
| [ItemReleaseUsingClientEvent](物品.md#itemreleaseusingclientevent) | <span style="display:inline;color:#7575f9">客户端</span> | 触发时机：释放正在使用的物品 |
| [ItemReleaseUsingServerEvent](物品.md#itemreleaseusingserverevent) | <span style="display:inline;color:#ff5555">服务端</span> | 触发时机：释放正在使用的物品时 |
| [ItemUseAfterServerEvent](物品.md#itemuseafterserverevent) | <span style="display:inline;color:#ff5555">服务端</span> | 玩家在使用物品之后服务端抛出的事件。 |
@@ -244,10 +249,15 @@ sidebarDepth: 1
| [OnPlayerBlockedByShieldBeforeServerEvent](物品.md#onplayerblockedbyshieldbeforeserverevent) | <span style="display:inline;color:#ff5555">服务端</span> | 触发时机：玩家使用盾牌抵挡伤害之前触发 |
| [PlayerDropItemServerEvent](物品.md#playerdropitemserverevent) | <span style="display:inline;color:#ff5555">服务端</span> | 触发时机：玩家丢弃物品时触发 |
| [PlayerPickupArrowServerEvent](物品.md#playerpickuparrowserverevent) | <span style="display:inline;color:#ff5555">服务端</span> | 玩家即将捡起抛射物时触发，包括使用"netease:pick_up"的自定义抛射物 |
| [PlayerTryAddCustomContainerItemClientEvent](物品.md#playertryaddcustomcontaineritemclientevent) | <span style="display:inline;color:#7575f9">客户端</span> | 玩家尝试将物品添加到自定义容器时触发该事件 |
| [PlayerTryAddCustomContainerItemServerEvent](物品.md#playertryaddcustomcontaineritemserverevent) | <span style="display:inline;color:#ff5555">服务端</span> | 玩家尝试将物品添加到自定义容器时触发该事件 |
| [PlayerTryDropItemClientEvent](物品.md#playertrydropitemclientevent) | <span style="display:inline;color:#7575f9">客户端</span> | 触发时机：玩家丢弃物品时触发 |
| [PlayerTryPutCustomContainerItemClientEvent](物品.md#playertryputcustomcontaineritemclientevent) | <span style="display:inline;color:#7575f9">客户端</span> | 玩家尝试将物品放入自定义容器时触发该事件 |
| [PlayerTryPutCustomContainerItemServerEvent](物品.md#playertryputcustomcontaineritemserverevent) | <span style="display:inline;color:#ff5555">服务端</span> | 玩家尝试将物品放入自定义容器时触发该事件 |
| [ServerItemTryUseEvent](物品.md#serveritemtryuseevent) | <span style="display:inline;color:#ff5555">服务端</span> | 玩家点击右键尝试使用物品时服务端抛出的事件。注：ClientItemTryUseEvent的cancel设置为True时，服务端事件不会被触发了。 |
| [ServerItemUseOnEvent](物品.md#serveritemuseonevent) | <span style="display:inline;color:#ff5555">服务端</span> | 玩家在对方块使用物品之前服务端抛出的事件。注：客户端事件ClientItemUseOnEvent设置ret设置为True时，服务端不再会接受到这个事件。 |
| [PlayerTryRemoveCustomContainerItemClientEvent](物品.md#playertryremovecustomcontaineritemclientevent) | <span style="display:inline;color:#7575f9">客户端</span> | 玩家尝试从自定义容器中移除物品时触发该事件 |
| [PlayerTryRemoveCustomContainerItemServerEvent](物品.md#playertryremovecustomcontaineritemserverevent) | <span style="display:inline;color:#ff5555">服务端</span> | 玩家尝试从自定义容器中移除物品时触发该事件 |
| [ServerItemTryUseEvent](物品.md#serveritemtryuseevent) | <span style="display:inline;color:#ff5555">服务端</span> | 玩家点击右键尝试使用物品时服务端抛出的事件。 |
| [ServerItemUseOnEvent](物品.md#serveritemuseonevent) | <span style="display:inline;color:#ff5555">服务端</span> | 玩家在对方块使用物品之前服务端抛出的事件。 |
| [ServerPlayerTryTouchEvent](物品.md#serverplayertrytouchevent) | <span style="display:inline;color:#ff5555">服务端</span> | 玩家即将捡起物品时触发 |
| [ShearsUseToBlockBeforeServerEvent](物品.md#shearsusetoblockbeforeserverevent) | <span style="display:inline;color:#ff5555">服务端</span> | 触发时机：实体手持剪刀对方块使用时，有剪刀特殊效果的方块会在服务端线程触发该事件 |
| [StartUsingItemClientEvent](物品.md#startusingitemclientevent) | <span style="display:inline;color:#7575f9">客户端</span> | 玩家使用物品（目前仅支持Bucket（奶桶）、Trident（三叉戟）、RangedWeapon（弓）、Food（食物）、Potion（药水）、Crossbow（弩））时抛出 |

7
docs/mcdocs/1-ModAPI/事件/方块.md
View File

@@ -215,7 +215,7 @@ sidebarDepth: 1
| fullName | str | 方块的identifier，包含命名空间及名称 |
| auxValue | int | 方块附加值 |
| brightness | int | 方块亮度 |
| dimensionId | int | 实体维度 |
| dimensionId | int | 方块所在维度 |
- 返回值
@@ -274,6 +274,7 @@ method in mod.server.component.blockInfoCompServer.BlockInfoComponentServer
- 备注
- 对于一些特殊的方块，注意要使用对应的方块Id参数（如砖块楼梯，监听的方块Id应该为minecraft:brick_block）
- 如果用骨粉改变了发光浆果，也会触发一次事件，它实际是从cave_vines变成了cave_vines_head_with_berries
- 示例
@@ -416,6 +417,9 @@ comp.ListenOnBlockRemoveEvent("minecraft:wheat", True)
无
- 备注
- 如果拦截与方块交互的逻辑，则不会给服务端发送对应的网络包。
在零件中直接声明一个同名函数，即可完成监听，详情参考<a href="../../../mcguide/20-玩法开发/14-预设玩法编程/12-深入理解零件/0-零件开发.html#零件事件">零件事件</a>
@@ -1699,6 +1703,7 @@ comp.UnRegisterOnStandOn("minecraft:redstone_ore")
无
- 备注
- 客户端对应事件ClientBlockUseEvent如果开启拦截开关，则服务端也不会收到对应事件，即ServerBlockUseEvent不会触发。
- 当对原生方块进行使用时，如堆肥桶等类似有 使用 功能的方块使用物品时，会触发该事件，而ServerItemUseOnEvent则不会被触发。对应的客户端事件同理。
- 部分工具对方块的使用效果，如锹犁地，不一定能通过该事件cancel，还需同时使用ItemUseOnServerEvent进行取消
目前已知有：

253
docs/mcdocs/1-ModAPI/事件/物品.md
View File

@@ -12,8 +12,8 @@ sidebarDepth: 1
| [ActorUseItemClientEvent](物品.md#actoruseitemclientevent) | <span style="display:inline;color:#7575f9">客户端</span> | 触发时机：玩家使用物品时客户端抛出的事件（比较特殊不走该事件的例子：1）染料对有水的炼药锅使用；2）盔甲架装备盔甲）;3)喝牛奶 |
| [ActorUseItemServerEvent](物品.md#actoruseitemserverevent) | <span style="display:inline;color:#ff5555">服务端</span> | 触发时机：玩家使用物品生效之前服务端抛出的事件（比较特殊不走该事件的例子：1）染料对有水的炼药锅使用；2）盔甲架装备盔甲） |
| [AnvilCreateResultItemAfterClientEvent](物品.md#anvilcreateresultitemafterclientevent) | <span style="display:inline;color:#7575f9">客户端</span> | 玩家点击铁砧合成得到的物品时抛出的事件。 |
| [ClientItemTryUseEvent](物品.md#clientitemtryuseevent) | <span style="display:inline;color:#7575f9">客户端</span> | 玩家点击右键尝试使用物品时客户端抛出的事件，可以通过设置cancel为True取消使用物品。注：ClientItemTryUseEvent事件设置cancel时即可取消使用，无需服务端ServerItemTryUseEvent再次cancel，且服务端事件将不再触发。 |
| [ClientItemUseOnEvent](物品.md#clientitemuseonevent) | <span style="display:inline;color:#7575f9">客户端</span> | 玩家在对方块使用物品时客户端抛出的事件。注：事件设置ret = True 时即可取消使用，无需服务端再次设置ServerItemUseOnEvent取消，且服务端事件将不再触发。 |
| [ClientItemTryUseEvent](物品.md#clientitemtryuseevent) | <span style="display:inline;color:#7575f9">客户端</span> | 玩家点击右键尝试使用物品时客户端抛出的事件，可以通过设置cancel为True取消使用物品。 |
| [ClientItemUseOnEvent](物品.md#clientitemuseonevent) | <span style="display:inline;color:#7575f9">客户端</span> | 玩家在对方块使用物品时客户端抛出的事件。 |
| [ClientShapedRecipeTriggeredEvent](物品.md#clientshapedrecipetriggeredevent) | <span style="display:inline;color:#7575f9">客户端</span> | 玩家合成物品时触发 |
| [ContainerItemChangedServerEvent](物品.md#containeritemchangedserverevent) | <span style="display:inline;color:#ff5555">服务端</span> | 容器物品变化事件 |
| [CraftItemOutputChangeServerEvent](物品.md#craftitemoutputchangeserverevent) | <span style="display:inline;color:#ff5555">服务端</span> | 玩家从容器拿出生成物品时触发 |
@@ -23,6 +23,8 @@ sidebarDepth: 1
| [InventoryItemChangedClientEvent](物品.md#inventoryitemchangedclientevent) | <span style="display:inline;color:#7575f9">客户端</span> | 玩家背包物品变化时客户端抛出的事件。 |
| [InventoryItemChangedServerEvent](物品.md#inventoryitemchangedserverevent) | <span style="display:inline;color:#ff5555">服务端</span> | 玩家背包物品变化时服务端抛出的事件。 |
| [ItemDurabilityChangedServerEvent](物品.md#itemdurabilitychangedserverevent) | <span style="display:inline;color:#ff5555">服务端</span> | 物品耐久度变化事件 |
| [ItemPullOutCustomContainerServerEvent](物品.md#itempulloutcustomcontainerserverevent) | <span style="display:inline;color:#ff5555">服务端</span> | 漏出物品到漏斗时触发该事件 |
| [ItemPushInCustomContainerServerEvent](物品.md#itempushincustomcontainerserverevent) | <span style="display:inline;color:#ff5555">服务端</span> | 漏斗漏入物品时触发该事件 |
| [ItemReleaseUsingClientEvent](物品.md#itemreleaseusingclientevent) | <span style="display:inline;color:#7575f9">客户端</span> | 触发时机：释放正在使用的物品 |
| [ItemReleaseUsingServerEvent](物品.md#itemreleaseusingserverevent) | <span style="display:inline;color:#ff5555">服务端</span> | 触发时机：释放正在使用的物品时 |
| [ItemUseAfterServerEvent](物品.md#itemuseafterserverevent) | <span style="display:inline;color:#ff5555">服务端</span> | 玩家在使用物品之后服务端抛出的事件。 |
@@ -37,10 +39,15 @@ sidebarDepth: 1
| [OnPlayerBlockedByShieldBeforeServerEvent](物品.md#onplayerblockedbyshieldbeforeserverevent) | <span style="display:inline;color:#ff5555">服务端</span> | 触发时机：玩家使用盾牌抵挡伤害之前触发 |
| [PlayerDropItemServerEvent](物品.md#playerdropitemserverevent) | <span style="display:inline;color:#ff5555">服务端</span> | 触发时机：玩家丢弃物品时触发 |
| [PlayerPickupArrowServerEvent](物品.md#playerpickuparrowserverevent) | <span style="display:inline;color:#ff5555">服务端</span> | 玩家即将捡起抛射物时触发，包括使用"netease:pick_up"的自定义抛射物 |
| [PlayerTryAddCustomContainerItemClientEvent](物品.md#playertryaddcustomcontaineritemclientevent) | <span style="display:inline;color:#7575f9">客户端</span> | 玩家尝试将物品添加到自定义容器时触发该事件 |
| [PlayerTryAddCustomContainerItemServerEvent](物品.md#playertryaddcustomcontaineritemserverevent) | <span style="display:inline;color:#ff5555">服务端</span> | 玩家尝试将物品添加到自定义容器时触发该事件 |
| [PlayerTryDropItemClientEvent](物品.md#playertrydropitemclientevent) | <span style="display:inline;color:#7575f9">客户端</span> | 触发时机：玩家丢弃物品时触发 |
| [PlayerTryPutCustomContainerItemClientEvent](物品.md#playertryputcustomcontaineritemclientevent) | <span style="display:inline;color:#7575f9">客户端</span> | 玩家尝试将物品放入自定义容器时触发该事件 |
| [PlayerTryPutCustomContainerItemServerEvent](物品.md#playertryputcustomcontaineritemserverevent) | <span style="display:inline;color:#ff5555">服务端</span> | 玩家尝试将物品放入自定义容器时触发该事件 |
| [ServerItemTryUseEvent](物品.md#serveritemtryuseevent) | <span style="display:inline;color:#ff5555">服务端</span> | 玩家点击右键尝试使用物品时服务端抛出的事件。注：ClientItemTryUseEvent的cancel设置为True时，服务端事件不会被触发了。 |
| [ServerItemUseOnEvent](物品.md#serveritemuseonevent) | <span style="display:inline;color:#ff5555">服务端</span> | 玩家在对方块使用物品之前服务端抛出的事件。注：客户端事件ClientItemUseOnEvent设置ret设置为True时，服务端不再会接受到这个事件。 |
| [PlayerTryRemoveCustomContainerItemClientEvent](物品.md#playertryremovecustomcontaineritemclientevent) | <span style="display:inline;color:#7575f9">客户端</span> | 玩家尝试从自定义容器中移除物品时触发该事件 |
| [PlayerTryRemoveCustomContainerItemServerEvent](物品.md#playertryremovecustomcontaineritemserverevent) | <span style="display:inline;color:#ff5555">服务端</span> | 玩家尝试从自定义容器中移除物品时触发该事件 |
| [ServerItemTryUseEvent](物品.md#serveritemtryuseevent) | <span style="display:inline;color:#ff5555">服务端</span> | 玩家点击右键尝试使用物品时服务端抛出的事件。 |
| [ServerItemUseOnEvent](物品.md#serveritemuseonevent) | <span style="display:inline;color:#ff5555">服务端</span> | 玩家在对方块使用物品之前服务端抛出的事件。 |
| [ServerPlayerTryTouchEvent](物品.md#serverplayertrytouchevent) | <span style="display:inline;color:#ff5555">服务端</span> | 玩家即将捡起物品时触发 |
| [ShearsUseToBlockBeforeServerEvent](物品.md#shearsusetoblockbeforeserverevent) | <span style="display:inline;color:#ff5555">服务端</span> | 触发时机：实体手持剪刀对方块使用时，有剪刀特殊效果的方块会在服务端线程触发该事件 |
| [StartUsingItemClientEvent](物品.md#startusingitemclientevent) | <span style="display:inline;color:#7575f9">客户端</span> | 玩家使用物品（目前仅支持Bucket（奶桶）、Trident（三叉戟）、RangedWeapon（弓）、Food（食物）、Potion（药水）、Crossbow（弩））时抛出 |
@@ -179,7 +186,7 @@ sidebarDepth: 1
- 描述
玩家点击右键尝试使用物品时客户端抛出的事件，可以通过设置cancel为True取消使用物品。注：ClientItemTryUseEvent事件设置cancel时即可取消使用，无需服务端ServerItemTryUseEvent再次cancel，且服务端事件将不再触发。
玩家点击右键尝试使用物品时客户端抛出的事件，可以通过设置cancel为True取消使用物品。
- 参数
@@ -194,6 +201,7 @@ sidebarDepth: 1
无
- 备注
- ClientItemTryUseEvent事件设置cancel时即可取消使用，无需服务端ServerItemTryUseEvent再次cancel，且服务端事件将不再触发。
- ServerItemTryUseEvent/ClientItemTryUseEvent不能取消对方块使用物品的行为，如使用生物蛋，使用桶倒出/收集，使用打火石点燃草等；如果想要取消这种行为，请使用ClientItemUseOnEvent和ServerItemUseOnEvent
在零件中直接声明一个同名函数，即可完成监听，详情参考<a href="../../../mcguide/20-玩法开发/14-预设玩法编程/12-深入理解零件/0-零件开发.html#零件事件">零件事件</a>
@@ -205,7 +213,7 @@ sidebarDepth: 1
- 描述
玩家在对方块使用物品时客户端抛出的事件。注：事件设置ret = True 时即可取消使用，无需服务端再次设置ServerItemUseOnEvent取消，且服务端事件将不再触发。
玩家在对方块使用物品时客户端抛出的事件。
- 参数
@@ -228,6 +236,9 @@ sidebarDepth: 1
无
- 备注
- 事件设置ret = True 时即可取消使用，无需服务端再次设置ServerItemUseOnEvent取消，且服务端事件将不再触发。
在零件中直接声明一个同名函数，即可完成监听，详情参考<a href="../../../mcguide/20-玩法开发/14-预设玩法编程/12-深入理解零件/0-零件开发.html#零件事件">零件事件</a>
@@ -521,6 +532,58 @@ def OnCraftItemOutputChangeServerEvent(self, args):
在零件中直接声明一个同名函数，即可完成监听，详情参考<a href="../../../mcguide/20-玩法开发/14-预设玩法编程/12-深入理解零件/0-零件开发.html#零件事件">零件事件</a>
## ItemPullOutCustomContainerServerEvent
<span style="display:inline;color:#ff5555">服务端</span>
- 描述
漏出物品到漏斗时触发该事件
- 参数
| 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
| :--- | :--- | :--- |
| itemDict | dict | 漏斗漏出物品的<a href="../../../mcguide/20-玩法开发/10-基本概念/1-我的世界基础概念.html#物品信息字典#物品信息字典">物品信息字典</a> |
| collectionName | str | 漏出物品的容器名称，目前仅支持netease_container |
| collectionIndex | int | 漏出物品的容器索引 |
| x | int | 容器方块x坐标 |
| y | int | 容器方块y坐标 |
| z | int | 容器方块z坐标 |
| cancel | bool | 是否取消该操作，默认为false，事件中改为true时拒绝此次漏出物品的操作 |
- 返回值
无
## ItemPushInCustomContainerServerEvent
<span style="display:inline;color:#ff5555">服务端</span>
- 描述
漏斗漏入物品时触发该事件
- 参数
| 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
| :--- | :--- | :--- |
| itemDict | dict | 漏斗漏入物品的<a href="../../../mcguide/20-玩法开发/10-基本概念/1-我的世界基础概念.html#物品信息字典#物品信息字典">物品信息字典</a> |
| collectionName | str | 目标容器名称，目前仅支持netease_container |
| collectionIndex | int | 目标容器索引 |
| x | int | 容器方块x坐标 |
| y | int | 容器方块y坐标 |
| z | int | 容器方块z坐标 |
| cancel | bool | 是否取消该操作，默认为false，事件中改为true时拒绝此次漏入物品的操作 |
- 返回值
无
## ItemReleaseUsingClientEvent
<span style="display:inline;color:#7575f9">客户端</span>
@@ -882,6 +945,68 @@ def OnCraftItemOutputChangeServerEvent(self, args):
在零件中直接声明一个同名函数，即可完成监听，详情参考<a href="../../../mcguide/20-玩法开发/14-预设玩法编程/12-深入理解零件/0-零件开发.html#零件事件">零件事件</a>
## PlayerTryAddCustomContainerItemClientEvent
<span style="display:inline;color:#7575f9">客户端</span>
- 描述
玩家尝试将物品添加到自定义容器时触发该事件
- 参数
| 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
| :--- | :--- | :--- |
| itemDict | dict | 尝试添加物品的<a href="../../../mcguide/20-玩法开发/10-基本概念/1-我的世界基础概念.html#物品信息字典#物品信息字典">物品信息字典</a> |
| collectionName | str | 放入容器名称，对应容器json中"custom_description"字段 |
| collectionType | str | 放入容器类型，目前仅支持netease_container和netease_ui_container |
| collectionIndex | int | 放入容器索引 |
| x | int | 容器方块x坐标 |
| y | int | 容器方块y坐标 |
| z | int | 容器方块z坐标 |
| cancel | bool | 是否取消该操作，默认为false，事件中改为true时拒绝此次放入自定义容器的操作 |
- 返回值
无
- 备注
- 容器内物品移动，合堆，分堆的操作会分多次事件触发并且顺序不定，编写逻辑时请勿依赖事件触发顺序
- cancel取消本次操作后不会触发对应服务端事件
## PlayerTryAddCustomContainerItemServerEvent
<span style="display:inline;color:#ff5555">服务端</span>
- 描述
玩家尝试将物品添加到自定义容器时触发该事件
- 参数
| 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
| :--- | :--- | :--- |
| itemDict | dict | 尝试添加物品的<a href="../../../mcguide/20-玩法开发/10-基本概念/1-我的世界基础概念.html#物品信息字典#物品信息字典">物品信息字典</a> |
| collectionName | str | 放入容器名称，对应容器json中"custom_description"字段 |
| collectionType | str | 放入容器类型，目前仅支持netease_container和netease_ui_container |
| collectionIndex | int | 放入容器索引 |
| playerId | str | 玩家id |
| x | int | 容器方块x坐标 |
| y | int | 容器方块y坐标 |
| z | int | 容器方块z坐标 |
- 返回值
无
- 备注
- 容器内物品移动，合堆，分堆的操作会分多次事件触发并且顺序不定，编写逻辑时请勿依赖事件触发顺序
在零件中直接声明一个同名函数，即可完成监听，详情参考<a href="../../../mcguide/20-玩法开发/14-预设玩法编程/12-深入理解零件/0-零件开发.html#零件事件">零件事件</a>
## PlayerTryDropItemClientEvent
<span style="display:inline;color:#7575f9">客户端</span>
@@ -905,6 +1030,39 @@ def OnCraftItemOutputChangeServerEvent(self, args):
在零件中直接声明一个同名函数，即可完成监听，详情参考<a href="../../../mcguide/20-玩法开发/14-预设玩法编程/12-深入理解零件/0-零件开发.html#零件事件">零件事件</a>
## PlayerTryPutCustomContainerItemClientEvent
<span style="display:inline;color:#7575f9">客户端</span>
- 描述
玩家尝试将物品放入自定义容器时触发该事件
- 参数
| 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
| :--- | :--- | :--- |
| itemDict | dict | 尝试放入物品的<a href="../../../mcguide/20-玩法开发/10-基本概念/1-我的世界基础概念.html#物品信息字典#物品信息字典">物品信息字典</a> |
| collectionName | str | 放入容器名称，对应容器json中"custom_description"字段 |
| collectionType | str | 放入容器类型，目前仅支持netease_container和netease_ui_container |
| collectionIndex | int | 放入容器索引 |
| x | int | 容器方块x坐标 |
| y | int | 容器方块y坐标 |
| z | int | 容器方块z坐标 |
| cancel | bool | 是否取消该操作，默认为false，事件中改为true时拒绝此次放入自定义容器的操作 |
- 返回值
无
- 备注
- 该事件只有目标槽位为空或交换物品时触发，如果目标槽位有相同物品时只会触发PlayerTryAddCustomContainerItemServerEvent事件
- PC存在shift键移动全部物品，放入同种物品时，可能会触发tryadd和tryput，请开发者注意适配
- 容器内物品移动，合堆，分堆的操作会分多次事件触发并且顺序不定，编写逻辑时请勿依赖事件触发顺序
- cancel取消本次操作后不会触发对应服务端事件
## PlayerTryPutCustomContainerItemServerEvent
<span style="display:inline;color:#ff5555">服务端</span>
@@ -918,18 +1076,87 @@ def OnCraftItemOutputChangeServerEvent(self, args):
| 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
| :--- | :--- | :--- |
| itemDict | dict | 尝试放入物品的<a href="../../../mcguide/20-玩法开发/10-基本概念/1-我的世界基础概念.html#物品信息字典#物品信息字典">物品信息字典</a> |
| collectionName | str | 放入容器名称，目前仅支持netease_container和netease_ui_container |
| collectionName | str | 放入容器名称，对应容器json中"custom_description"字段 |
| collectionType | str | 放入容器类型，目前仅支持netease_container和netease_ui_container |
| collectionIndex | int | 放入容器索引 |
| playerId | str | 玩家id |
| x | float | 容器方块x坐标 |
| y | float | 容器方块y坐标 |
| z | float | 容器方块z坐标 |
| x | int | 容器方块x坐标 |
| y | int | 容器方块y坐标 |
| z | int | 容器方块z坐标 |
| cancel | bool | 是否取消该操作，默认为false，事件中改为true时拒绝此次放入自定义容器的操作 |
- 返回值
无
- 备注
- 该事件只有目标槽位为空时触发，如果目标槽位有相同物品时只会触发PlayerTryAddCustomContainerItemServerEvent事件
- PC存在shift键移动全部物品，放入同种物品时，可能会触发tryadd和tryput，请开发者注意适配
- 容器内物品移动，合堆，分堆的操作会分多次事件触发并且顺序不定，编写逻辑时请勿依赖事件触发顺序
在零件中直接声明一个同名函数，即可完成监听，详情参考<a href="../../../mcguide/20-玩法开发/14-预设玩法编程/12-深入理解零件/0-零件开发.html#零件事件">零件事件</a>
## PlayerTryRemoveCustomContainerItemClientEvent
<span style="display:inline;color:#7575f9">客户端</span>
- 描述
玩家尝试从自定义容器中移除物品时触发该事件
- 参数
| 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
| :--- | :--- | :--- |
| itemDict | dict | 尝试移除物品的<a href="../../../mcguide/20-玩法开发/10-基本概念/1-我的世界基础概念.html#物品信息字典#物品信息字典">物品信息字典</a> |
| collectionName | str | 放入容器名称，对应容器json中"custom_description"字段 |
| collectionType | str | 放入容器类型，目前仅支持netease_container和netease_ui_container |
| collectionIndex | int | 目标容器索引 |
| x | int | 容器方块x坐标 |
| y | int | 容器方块y坐标 |
| z | int | 容器方块z坐标 |
| cancel | bool | 是否取消该操作，默认为false，事件中改为true时拒绝此次移除物品的操作 |
- 返回值
无
- 备注
- 该事件在关闭容器物品自动返回背包时也会触发，此时如果取消操作物品将会被留在容器中，容器被破坏物品也不会掉落（因为实际存储于玩家身上），当再次打开netease_ui_container容器时会显示。
- 容器内物品移动，合堆，分堆的操作会分多次事件触发并且顺序不定，编写逻辑时请勿依赖事件触发顺序
- cancel取消本次操作后不会触发对应服务端事件
## PlayerTryRemoveCustomContainerItemServerEvent
<span style="display:inline;color:#ff5555">服务端</span>
- 描述
玩家尝试从自定义容器中移除物品时触发该事件
- 参数
| 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
| :--- | :--- | :--- |
| itemDict | dict | 尝试移除物品的<a href="../../../mcguide/20-玩法开发/10-基本概念/1-我的世界基础概念.html#物品信息字典#物品信息字典">物品信息字典</a> |
| collectionName | str | 放入容器名称，对应容器json中"custom_description"字段 |
| collectionType | str | 放入容器类型，目前仅支持netease_container和netease_ui_container |
| collectionIndex | int | 目标容器索引 |
| playerId | str | 玩家id |
| x | int | 容器方块x坐标 |
| y | int | 容器方块y坐标 |
| z | int | 容器方块z坐标 |
- 返回值
无
- 备注
- 容器内物品移动，合堆，分堆的操作会分多次事件触发并且顺序不定，编写逻辑时请勿依赖事件触发顺序
在零件中直接声明一个同名函数，即可完成监听，详情参考<a href="../../../mcguide/20-玩法开发/14-预设玩法编程/12-深入理解零件/0-零件开发.html#零件事件">零件事件</a>
@@ -939,7 +1166,7 @@ def OnCraftItemOutputChangeServerEvent(self, args):
- 描述
玩家点击右键尝试使用物品时服务端抛出的事件。注：ClientItemTryUseEvent的cancel设置为True时，服务端事件不会被触发了。
玩家点击右键尝试使用物品时服务端抛出的事件。
- 参数
@@ -954,6 +1181,7 @@ def OnCraftItemOutputChangeServerEvent(self, args):
无
- 备注
- ClientItemTryUseEvent的cancel设置为True时，服务端事件不会被触发了。
- ServerItemTryUseEvent/ClientItemTryUseEvent不能取消对方块使用物品的行为，如使用生物蛋，使用桶倒出/收集，使用打火石点燃草等；如果想要取消这种行为，请使用ClientItemUseOnEvent和ServerItemUseOnEvent
在零件中直接声明一个同名函数，即可完成监听，详情参考<a href="../../../mcguide/20-玩法开发/14-预设玩法编程/12-深入理解零件/0-零件开发.html#零件事件">零件事件</a>
@@ -965,7 +1193,7 @@ def OnCraftItemOutputChangeServerEvent(self, args):
- 描述
玩家在对方块使用物品之前服务端抛出的事件。注：客户端事件ClientItemUseOnEvent设置ret设置为True时，服务端不再会接受到这个事件。
玩家在对方块使用物品之前服务端抛出的事件。
- 参数
@@ -990,6 +1218,7 @@ def OnCraftItemOutputChangeServerEvent(self, args):
无
- 备注
- 客户端事件ClientItemUseOnEvent设置ret设置为True时，服务端不再会接受到这个事件。
- 当对原生方块进行使用时，如堆肥桶等类似有 使用 功能的方块使用物品时，不会触发该事件。而当原生方块加入监听后，ServerBlockUseEvent会触发。当需要获取触发时使用的物品时，可以通过item组件（例如GetPlayerItem接口）获取手中持有的物品，对应的客户端事件同理。
在零件中直接声明一个同名函数，即可完成监听，详情参考<a href="../../../mcguide/20-玩法开发/14-预设玩法编程/12-深入理解零件/0-零件开发.html#零件事件">零件事件</a>

105
docs/mcdocs/1-ModAPI/事件/玩家.md
View File

@@ -38,6 +38,8 @@ sidebarDepth: 1
| [PlayerHurtEvent](玩家.md#playerhurtevent) | <span style="display:inline;color:#ff5555">服务端</span> | 触发时机：当玩家受伤害前触发该事件。 |
| [PlayerInteractServerEvent](玩家.md#playerinteractserverevent) | <span style="display:inline;color:#ff5555">服务端</span> | 触发时机：玩家可以与实体交互时。如果是鼠标控制模式，则当准心对着实体时触发。如果是触屏模式，则触发时机与屏幕下方的交互按钮显示的时机相同。玩家真正与实体发生交互的事件见[PlayerDoInteractServerEvent](#playerdointeractserverevent) |
| [PlayerNamedEntityServerEvent](玩家.md#playernamedentityserverevent) | <span style="display:inline;color:#ff5555">服务端</span> | 玩家用命名牌重命名实体时触发，例如玩家手持命名牌对羊修改名字、玩家手持命名牌对盔甲架修改名字。 |
| [PlayerPermissionChangeClientEvent](玩家.md#playerpermissionchangeclientevent) | <span style="display:inline;color:#7575f9">客户端</span> | 玩家权限变更事件 |
| [PlayerPermissionChangeServerEvent](玩家.md#playerpermissionchangeserverevent) | <span style="display:inline;color:#ff5555">服务端</span> | 玩家权限变更事件 |
| [PlayerRespawnEvent](玩家.md#playerrespawnevent) | <span style="display:inline;color:#ff5555">服务端</span> | 触发时机：玩家复活时触发该事件。 |
| [PlayerRespawnFinishServerEvent](玩家.md#playerrespawnfinishserverevent) | <span style="display:inline;color:#ff5555">服务端</span> | 触发时机：玩家复活完毕时触发 |
| [PlayerSleepServerEvent](玩家.md#playersleepserverevent) | <span style="display:inline;color:#ff5555">服务端</span> | 玩家使用床睡觉成功 |
@@ -47,6 +49,7 @@ sidebarDepth: 1
| [PlayerTrySleepServerEvent](玩家.md#playertrysleepserverevent) | <span style="display:inline;color:#ff5555">服务端</span> | 玩家尝试使用床睡觉 |
| [ServerPlayerGetExperienceOrbEvent](玩家.md#serverplayergetexperienceorbevent) | <span style="display:inline;color:#ff5555">服务端</span> | 触发时机：玩家获取经验球时触发的事件 |
| [StoreBuySuccServerEvent](玩家.md#storebuysuccserverevent) | <span style="display:inline;color:#ff5555">服务端</span> | 触发时机:玩家游戏内购买商品时服务端抛出的事件 |
| [UpdatePlayerSkinClientEvent](玩家.md#updateplayerskinclientevent) | <span style="display:inline;color:#7575f9">客户端</span> | 触发时机：玩家加入游戏或通过更衣室局内换肤后 同步皮肤信息至客户端后触发 |
# 玩家
## AddExpEvent
@@ -991,6 +994,84 @@ comp.ClosePlayerHitBlockDetection()
在零件中直接声明一个同名函数，即可完成监听，详情参考<a href="../../../mcguide/20-玩法开发/14-预设玩法编程/12-深入理解零件/0-零件开发.html#零件事件">零件事件</a>
## PlayerPermissionChangeClientEvent
<span style="display:inline;color:#7575f9">客户端</span>
- 描述
玩家权限变更事件
- 参数
| 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
| :--- | :--- | :--- |
| causePlayerId | str | 发起者id |
| playerId | str | 玩家id |
| oldPermission | dict | 变化前的权限字典 |
| newPermission | dict | 变化后的权限字典 |
| changeCause | int | 变化原因，详见Minecraft枚举值文档的[PermissionChangeCause](../枚举值/PermissionChangeCause.md) |
- 返回值
无
- 备注
- 具体权限说明：
| 权限字段 | 类型 | 说明 |
| --- | --- | --- |
| build | bool | 放置方块 |
| mine | bool | 采集方块 |
| doorsandswitches | bool | 使用门和开关 |
| opencontainers | bool | 打开容器 |
| attackplayers | bool | 攻击玩家 |
| attackmobs | bool | 攻击生物 |
| op | bool | 操作员命令 |
| teleport | bool | 使用传送 |
- 当PlayerPermissionChangeServerEvent事件返回"cancel"为True时，权限变动被取消，该事件不会触发。
在零件中直接声明一个同名函数，即可完成监听，详情参考<a href="../../../mcguide/20-玩法开发/14-预设玩法编程/12-深入理解零件/0-零件开发.html#零件事件">零件事件</a>
## PlayerPermissionChangeServerEvent
<span style="display:inline;color:#ff5555">服务端</span>
- 描述
玩家权限变更事件
- 参数
| 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
| :--- | :--- | :--- |
| causePlayerId | str | 发起者id |
| playerId | str | 玩家id |
| oldPermission | dict | 变化前的权限字典 |
| newPermission | dict | 变化后的权限字典 |
| changeCause | int | 变化原因，详见Minecraft枚举值文档的[PermissionChangeCause](../枚举值/PermissionChangeCause.md) |
| cancel | bool | 为true时，取消本次权限变更 |
- 返回值
无
- 备注
- 具体权限说明：
| 权限字段 | 类型 | 说明 |
| --- | --- | --- |
| build | bool | 放置方块 |
| mine | bool | 采集方块 |
| doorsandswitches | bool | 使用门和开关 |
| opencontainers | bool | 打开容器 |
| attackplayers | bool | 攻击玩家 |
| attackmobs | bool | 攻击生物 |
| op | bool | 操作员命令 |
| teleport | bool | 使用传送 |
在零件中直接声明一个同名函数，即可完成监听，详情参考<a href="../../../mcguide/20-玩法开发/14-预设玩法编程/12-深入理解零件/0-零件开发.html#零件事件">零件事件</a>
## PlayerRespawnEvent
<span style="display:inline;color:#ff5555">服务端</span>
@@ -1209,3 +1290,27 @@ def OnStoreBuySucc(self, args):
在零件中直接声明一个同名函数，即可完成监听，详情参考<a href="../../../mcguide/20-玩法开发/14-预设玩法编程/12-深入理解零件/0-零件开发.html#零件事件">零件事件</a>
## UpdatePlayerSkinClientEvent
<span style="display:inline;color:#7575f9">客户端</span>
- 描述
触发时机：玩家加入游戏或通过更衣室局内换肤后 同步皮肤信息至客户端后触发
- 参数
| 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
| :--- | :--- | :--- |
| playerId | str | 更换皮肤的玩家id |
- 返回值
无
- 备注
- 此事件配合 IsOfficialSkin IsHighLevelOfficialSkin IsHighLevelMultiJointOfficialSkin 接口 用于获取玩家的皮肤信息
在零件中直接声明一个同名函数，即可完成监听，详情参考<a href="../../../mcguide/20-玩法开发/14-预设玩法编程/12-深入理解零件/0-零件开发.html#零件事件">零件事件</a>