From 12738a142cc270be97015c581bdb4962926fce25 Mon Sep 17 00:00:00 2001 From: boybook Date: Fri, 27 Jun 2025 23:59:47 +0800 Subject: [PATCH] =?UTF-8?q?=E6=9B=B4=E6=96=B03.4API?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/mcdocs/1-ModAPI/config.json | 4 +- docs/mcdocs/1-ModAPI/events.json | 177 ++++++++-- docs/mcdocs/1-ModAPI/interface.json | 327 ++++++++++++++++-- docs/mcdocs/1-ModAPI/事件/UI.md | 6 +- docs/mcdocs/1-ModAPI/事件/世界.md | 37 +- docs/mcdocs/1-ModAPI/事件/事件索引表.md | 14 +- docs/mcdocs/1-ModAPI/事件/实体.md | 4 +- docs/mcdocs/1-ModAPI/事件/方块.md | 15 +- docs/mcdocs/1-ModAPI/事件/物品.md | 47 ++- docs/mcdocs/1-ModAPI/接口/Api索引表.md | 30 +- docs/mcdocs/1-ModAPI/接口/世界/地图.md | 14 +- docs/mcdocs/1-ModAPI/接口/世界/实体管理.md | 7 +- docs/mcdocs/1-ModAPI/接口/世界/方块管理.md | 2 +- docs/mcdocs/1-ModAPI/接口/世界/消息.md | 2 +- docs/mcdocs/1-ModAPI/接口/世界/索引.md | 6 +- docs/mcdocs/1-ModAPI/接口/原生UI.md | 4 +- docs/mcdocs/1-ModAPI/接口/实体/属性.md | 8 +- docs/mcdocs/1-ModAPI/接口/实体/渲染.md | 8 + docs/mcdocs/1-ModAPI/接口/实体/索引.md | 6 +- docs/mcdocs/1-ModAPI/接口/实体/行为.md | 2 +- docs/mcdocs/1-ModAPI/接口/方块/方块实体.md | 6 +- docs/mcdocs/1-ModAPI/接口/模型.md | 4 +- docs/mcdocs/1-ModAPI/接口/物品.md | 12 +- docs/mcdocs/1-ModAPI/接口/特效/粒子.md | 2 +- docs/mcdocs/1-ModAPI/接口/玩家/属性.md | 62 ++++ docs/mcdocs/1-ModAPI/接口/玩家/摄像机.md | 12 +- docs/mcdocs/1-ModAPI/接口/玩家/渲染.md | 7 +- docs/mcdocs/1-ModAPI/接口/玩家/索引.md | 8 +- docs/mcdocs/1-ModAPI/接口/玩家/行为.md | 5 +- docs/mcdocs/1-ModAPI/接口/自定义UI/UI控件.md | 69 +++- docs/mcdocs/1-ModAPI/接口/自定义UI/索引.md | 2 + docs/mcdocs/1-ModAPI/接口/通用/工具.md | 60 ++++ docs/mcdocs/1-ModAPI/接口/通用/数学.md | 64 ++++ docs/mcdocs/1-ModAPI/接口/通用/索引.md | 4 + docs/mcdocs/1-ModAPI/更新信息/3.3.md | 15 +- docs/mcdocs/1-ModAPI/更新信息/3.4.md | 93 +++++ .../1-ModAPI/枚举值/ActorDamageCause.md | 3 +- docs/mcdocs/1-ModAPI/枚举值/AniCheatMove.md | 1 - .../1-ModAPI/枚举值/AniCheatMoveRewind.md | 1 - .../枚举值/AniCheatMoveUnSupportRewind.md | 19 - docs/mcdocs/1-ModAPI/枚举值/AttrType.md | 4 +- docs/mcdocs/1-ModAPI/枚举值/ColorCode.md | 2 +- docs/mcdocs/1-ModAPI/枚举值/EffectType.md | 6 + .../mcdocs/1-ModAPI/枚举值/EnchantSlotType.md | 1 + docs/mcdocs/1-ModAPI/枚举值/EnchantType.md | 8 +- docs/mcdocs/1-ModAPI/枚举值/EntityType.md | 9 +- .../1-ModAPI/枚举值/ItemUseMethodEnum.md | 1 + .../mcdocs/1-ModAPI/枚举值/OpenContainerId.md | 2 + docs/mcdocs/1-ModAPI/枚举值/OriginGUIName.md | 3 +- .../1-ModAPI/枚举值/StructureFeatureType.md | 3 +- docs/mcdocs/1-ModAPI/枚举值/索引.md | 133 ++++--- docs/mcdocs/2-Apollo/0-Apollo更新信息.md | 97 ++++++ 52 files changed, 1146 insertions(+), 292 deletions(-) create mode 100644 docs/mcdocs/1-ModAPI/更新信息/3.4.md delete mode 100644 docs/mcdocs/1-ModAPI/枚举值/AniCheatMoveUnSupportRewind.md diff --git a/docs/mcdocs/1-ModAPI/config.json b/docs/mcdocs/1-ModAPI/config.json index 7cd2c5b1..1b9501db 100644 --- a/docs/mcdocs/1-ModAPI/config.json +++ b/docs/mcdocs/1-ModAPI/config.json @@ -170,7 +170,6 @@ "/mcdocs/1-ModAPI/枚举值/AniCheatConsts", "/mcdocs/1-ModAPI/枚举值/AniCheatMove", "/mcdocs/1-ModAPI/枚举值/AniCheatMoveRewind", - "/mcdocs/1-ModAPI/枚举值/AniCheatMoveUnSupportRewind", "/mcdocs/1-ModAPI/枚举值/AnimationModeType", "/mcdocs/1-ModAPI/枚举值/ArmorSlotType", "/mcdocs/1-ModAPI/枚举值/AttrType", @@ -237,10 +236,11 @@ }, { "children": [ + "/mcdocs/1-ModAPI/更新信息/3.4", "/mcdocs/1-ModAPI/更新信息/3.3" ], "title": "更新信息" } ], - "title": "ModAPI-beta" + "title": "ModAPI" } \ No newline at end of file diff --git a/docs/mcdocs/1-ModAPI/events.json b/docs/mcdocs/1-ModAPI/events.json index ef656240..8fa75b28 100644 --- a/docs/mcdocs/1-ModAPI/events.json +++ b/docs/mcdocs/1-ModAPI/events.json @@ -2985,7 +2985,7 @@ { "name": "ServerItemTryUseEvent", "path": "server.serverEvent", - "desc": "玩家点击右键尝试使用物品时服务端抛出的事件。注：如果需要取消物品的使用需要同时在ClientItemTryUseEvent和ServerItemTryUseEvent中将cancel设置为True才能正确取消。", + "desc": "玩家点击右键尝试使用物品时服务端抛出的事件。注：ClientItemTryUseEvent的cancel设置为True时，服务端事件不会被触发了。", "doc_class_path": [ "物品" ], @@ -3028,6 +3028,12 @@ "operation": "调整", "version": "2.10", "author": "xsf" + }, + { + "comment": "ClientItemTryUseEvent的cancel设置为True时，服务端事件不会被触发了。", + "operation": "调整", + "version": "3.4", + "author": "bl" } ], "side": "服务端" @@ -3035,7 +3041,7 @@ { "name": "ServerItemUseOnEvent", "path": "server.serverEvent", - "desc": "玩家在对方块使用物品之前服务端抛出的事件。注：如果需要取消物品的使用需要同时在ClientItemUseOnEvent和ServerItemUseOnEvent中将ret设置为True才能正确取消。", + "desc": "玩家在对方块使用物品之前服务端抛出的事件。注：客户端事件ClientItemUseOnEvent设置ret设置为True时，服务端不再会接受到这个事件。", "doc_class_path": [ "物品" ], @@ -3122,6 +3128,12 @@ "operation": "调整", "version": "1.21", "author": "czh" + }, + { + "comment": "客户端事件ClientItemUseOnEvent设置ret设置为True时，服务端不再会接受到这个事件。", + "operation": "调整", + "version": "3.4", + "author": "bl" } ], "side": "服务端" @@ -4167,6 +4179,16 @@ "param_name": "dimension", "param_type": "int" }, + { + "param_comment": "区块的x坐标，对应方块X坐标区间为[x * 16, x * 16 + 15]", + "param_name": "chunkPosX", + "param_type": "int" + }, + { + "param_comment": "区块的z坐标，对应方块Z坐标区间为[z * 16, z * 16 + 15]", + "param_name": "chunkPosZ", + "param_type": "int" + }, { "param_comment": "该区块中的自定义方块实体列表，通常是由自定义特征生成的自定义方块，没有自定义方块实体时该值为None", "param_name": "blockEntityData", @@ -4177,7 +4199,14 @@ "return_type": "", "return_comment": "" }, - "state": [], + "state": [ + { + "comment": "新增chunkPosX,chunkPosZ", + "operation": "新增", + "version": "3.4", + "author": "qiuyukun" + } + ], "side": "服务端" }, { @@ -4918,6 +4947,11 @@ "param_name": "newStrength", "param_type": "int" }, + { + "param_comment": "变化前的红石信号量", + "param_name": "oldStrength", + "param_type": "int" + }, { "param_comment": "维度", "param_name": "dimensionId", @@ -4934,6 +4968,12 @@ "operation": "调整", "version": "1.21", "author": "gzhuabo" + }, + { + "comment": "新增变化前的红石信号量参数", + "operation": "调整", + "version": "3.4", + "author": "qiuyukun" } ], "side": "服务端" @@ -6949,7 +6989,7 @@ "param_type": "str" }, { - "param_comment": "玩家放入物品的EnchantSlotType", + "param_comment": "玩家放入物品的[EnchantSlotType](../枚举值/EnchantSlotType.md)", "param_name": "slotType", "param_type": "int" }, @@ -7030,7 +7070,7 @@ { "name": "HealthChangeBeforeServerEvent", "path": "server.serverEvent", - "desc": "生物生命值发生变化之前触发", + "desc": "生物生命值或最大生命值发生变化之前触发", "doc_class_path": [ "实体" ], @@ -7981,6 +8021,69 @@ } ], "side": "服务端" + }, + { + "name": "PlayerTryPutCustomContainerItemServerEvent", + "path": "server.serverEvent", + "desc": "玩家尝试将物品放入自定义容器时触发该事件", + "doc_class_path": [ + "物品" + ], + "param": [ + { + "param_comment": "尝试放入物品的物品信息字典", + "param_name": "itemDict", + "param_type": "dict" + }, + { + "param_comment": "放入容器名称，目前仅支持netease_container和netease_ui_container", + "param_name": "collectionName", + "param_type": "str" + }, + { + "param_comment": "放入容器索引", + "param_name": "collectionIndex", + "param_type": "int" + }, + { + "param_comment": "玩家id", + "param_name": "playerId", + "param_type": "str" + }, + { + "param_comment": "容器方块x坐标", + "param_name": "x", + "param_type": "float" + }, + { + "param_comment": "容器方块y坐标", + "param_name": "y", + "param_type": "float" + }, + { + "param_comment": "容器方块z坐标", + "param_name": "z", + "param_type": "float" + }, + { + "param_comment": "是否取消该操作，默认为false，事件中改为true时拒绝此次放入自定义容器的操作", + "param_name": "cancel", + "param_type": "bool" + } + ], + "return": { + "return_type": "", + "return_comment": "" + }, + "state": [ + { + "comment": "玩家尝试将物品放入自定义容器时触发该事件", + "operation": "新增", + "version": "3.4", + "author": "lidi" + } + ], + "side": "服务端" } ], "client.clientEvent": [ @@ -8709,7 +8812,7 @@ { "name": "ClientItemTryUseEvent", "path": "client.clientEvent", - "desc": "玩家点击右键尝试使用物品时客户端抛出的事件，可以通过设置cancel为True取消使用物品。注：如果需要取消物品的使用需要同时在ClientItemTryUseEvent和ServerItemTryUseEvent中将cancel设置为True才能正确取消。", + "desc": "玩家点击右键尝试使用物品时客户端抛出的事件，可以通过设置cancel为True取消使用物品。注：ClientItemTryUseEvent事件设置cancel时即可取消使用，无需服务端ServerItemTryUseEvent再次cancel，且服务端事件将不再触发。", "doc_class_path": [ "物品" ], @@ -8740,6 +8843,12 @@ "operation": "调整", "version": "1.20", "author": "czh" + }, + { + "comment": "ClientItemTryUseEvent事件设置cancel为True时,不会再给服务端同步物品使用网络包。", + "operation": "调整", + "version": "3.4", + "author": "bl" } ], "side": "客户端" @@ -8747,7 +8856,7 @@ { "name": "ClientItemUseOnEvent", "path": "client.clientEvent", - "desc": "玩家在对方块使用物品时客户端抛出的事件。注：如果需要取消物品的使用需要同时在ClientItemUseOnEvent和ServerItemUseOnEvent中将ret设置为True才能正确取消。", + "desc": "玩家在对方块使用物品时客户端抛出的事件。注：事件设置ret = True 时即可取消使用，无需服务端再次设置ServerItemUseOnEvent取消，且服务端事件将不再触发。", "doc_class_path": [ "物品" ], @@ -8829,6 +8938,12 @@ "operation": "调整", "version": "1.21", "author": "czh" + }, + { + "comment": "ClientItemUseOnEvent事件设置ret为True时，不会再给服务端同步物品使用网络包。", + "operation": "调整", + "version": "3.4", + "author": "bl" } ], "side": "客户端" @@ -8870,7 +8985,7 @@ ], "param": [ { - "param_comment": "点击的物品槽的编号，编号对应位置详见[物品栏]", + "param_comment": "点击的物品槽的编号，编号对应位置详见[物品栏]", "param_name": "slotIndex", "param_type": "int" } @@ -8934,28 +9049,6 @@ "state": [], "side": "客户端" }, - { - "name": "PrimaryClientSyncSkinClientEvent", - "path": "client.clientEvent", - "desc": "主客户端自己更换了皮肤触发", - "doc_class_path": [ - "世界" - ], - "param": [], - "return": { - "return_type": "", - "return_comment": "" - }, - "state": [ - { - "comment": "主客户端自己更换了皮肤触发", - "operation": "新增", - "version": "2.12", - "author": "bl" - } - ], - "side": "客户端" - }, { "name": "OnKeyPressInGame", "path": "client.clientEvent", @@ -9965,6 +10058,12 @@ "operation": "调整", "version": "3.2", "author": "lrz" + }, + { + "comment": "当拦截交互逻辑时，不再会给服务端发送网络包，", + "operation": "调整", + "version": "3.4", + "author": "bl" } ], "side": "客户端" @@ -10780,7 +10879,7 @@ { "name": "GridComponentSizeChangedClientEvent", "path": "client.clientEvent", - "desc": "触发时机：UI grid组件里格子数目发生变化时触发", + "desc": "UI grid控件里格子重新排列时触发", "doc_class_path": [ "UI" ], @@ -11843,6 +11942,16 @@ "param_comment": "方块坐标", "param_name": "blockPos", "param_type": "tuple(float,float,float)" + }, + { + "param_comment": "方块的identifier，包含命名空间及名称", + "param_name": "blockName", + "param_type": "str" + }, + { + "param_comment": "方块附加值", + "param_name": "auxData", + "param_type": "int" } ], "return": { @@ -11855,6 +11964,12 @@ "operation": "新增", "version": "3.3", "author": "xgb" + }, + { + "comment": "新增blockName与auxData参数", + "operation": "调整", + "version": "3.4", + "author": "xgb" } ], "side": "客户端" diff --git a/docs/mcdocs/1-ModAPI/interface.json b/docs/mcdocs/1-ModAPI/interface.json index 0d0143af..8fa02ab2 100644 --- a/docs/mcdocs/1-ModAPI/interface.json +++ b/docs/mcdocs/1-ModAPI/interface.json @@ -600,7 +600,7 @@ "param_type": "str" }, { - "param_comment": "文本的内容，可以支持[样式代码](https://minecraft-zh.gamepedia.com/%E6%A0%B7%E5%BC%8F%E4%BB%A3%E7%A0%81)（§可以设置文字的颜色、格式等，该种用法更加灵活多变）", + "param_comment": "文本的内容，可以支持[样式代码](https://zh.minecraft.wiki/w/%E6%A0%BC%E5%BC%8F%E5%8C%96%E4%BB%A3%E7%A0%81)（§可以设置文字的颜色、格式等，该种用法更加灵活多变）", "param_name": "text", "param_type": "str" }, @@ -682,7 +682,7 @@ "param_type": "tuple(float,float)" }, { - "param_comment": "文本的内容，可以支持[样式代码](https://minecraft-zh.gamepedia.com/%E6%A0%B7%E5%BC%8F%E4%BB%A3%E7%A0%81)（§可以设置文字的颜色、格式等，该种用法更加灵活多变）", + "param_comment": "文本的内容，可以支持[样式代码](https://zh.minecraft.wiki/w/%E6%A0%BC%E5%BC%8F%E5%8C%96%E4%BB%A3%E7%A0%81)（§可以设置文字的颜色、格式等，该种用法更加灵活多变）", "param_name": "text", "param_type": "str" }, @@ -1207,7 +1207,7 @@ { "name": "SetPersistent", "path": "server.component.attrCompServer.AttrCompServer", - "desc": "设置实体不会因为离玩家太远而被[清除](https://minecraft.fandom.com/zh/wiki/%E7%94%9F%E6%88%90#.E5.9F.BA.E5.B2.A9.E7.89.88_2)", + "desc": "设置实体不会因为离玩家太远而被[清除](https://zh.minecraft.wiki/w/%E7%94%9F%E6%88%90#%E6%B8%85%E9%99%A4)", "doc_class_path": [ "实体/属性" ], @@ -1224,7 +1224,7 @@ }, "state": [ { - "comment": "设置实体不会因为离玩家太远而被[清除](https://minecraft.fandom.com/zh/wiki/%E7%94%9F%E6%88%90#.E5.9F.BA.E5.B2.A9.E7.89.88_2)", + "comment": "设置实体不会因为离玩家太远而被[清除](https://zh.minecraft.wiki/w/%E7%94%9F%E6%88%90#%E6%B8%85%E9%99%A4)", "operation": "新增", "version": "2.0", "author": "czh" @@ -3528,6 +3528,52 @@ } ], "side": "客户端" + }, + { + "name": "GetPropertyBag", + "path": "client.ui.controls.baseUIControl.BaseUIControl", + "desc": "获取PropertyBag", + "doc_class_path": [], + "param": [], + "return": { + "return_type": "str", + "return_comment": "PropertyBag" + }, + "state": [ + { + "comment": "获取PropertyBag", + "operation": "新增", + "version": "3.4", + "author": "qiuyukun" + } + ], + "side": "客户端" + }, + { + "name": "SetPropertyBag", + "path": "client.ui.controls.baseUIControl.BaseUIControl", + "desc": "设置PropertyBag,将使用字典中的每个值来覆盖原本PropertyBag中的值", + "doc_class_path": [], + "param": [ + { + "param_comment": "需要设置的属性字典，字典键值对的值仅支持设置字符串、数字、布尔值类型，其余类型会导致设置失败", + "param_name": "params", + "param_type": "dict" + } + ], + "return": { + "return_type": "bool", + "return_comment": "是否设置成功" + }, + "state": [ + { + "comment": "设置PropertyBag", + "operation": "新增", + "version": "3.4", + "author": "qiuyukun" + } + ], + "side": "客户端" } ], "server.component.blockStateCompServer.BlockStateComponentServer": [ @@ -5824,11 +5870,6 @@ "特效/粒子" ], "param": [ - { - "param_comment": "如果实体是由CreateClientEntityByTypeStr接口创建的,则需要传入True.默认为False", - "param_name": "isClientEntity", - "param_type": "bool" - }, { "param_comment": "绑定的entity的ID", "param_name": "bindEntityId", @@ -5848,6 +5889,11 @@ "param_comment": "默认不开启，开启后可以使特效的旋转角度准确设置为参照玩家的相对角度", "param_name": "correction", "param_type": "bool" + }, + { + "param_comment": "如果实体是由CreateClientEntityByTypeStr接口创建的,则需要传入True.默认为False", + "param_name": "isClientEntity", + "param_type": "bool" } ], "return": { @@ -7570,7 +7616,7 @@ { "name": "HideSwimGui", "path": "client.extraClientApi", - "desc": "隐藏游戏中的浮潜按钮。隐藏后点击相应位置不会响应。仅影响十字键操作下的浮潜按钮，摇杆模式上浮=跳跃，下潜=潜行，需要通过HideJumpGui和HideSneakGui来隐藏", + "desc": "隐藏游戏中的浮潜按钮。隐藏后点击相应位置不会响应。", "doc_class_path": [ "原生UI" ], @@ -7591,6 +7637,12 @@ "operation": "调整", "version": "3.2", "author": "lidi" + }, + { + "comment": "修改接口描述, 隐藏潜伏按钮", + "operation": "调整", + "version": "3.4", + "author": "jiaoshe" } ], "side": "客户端" @@ -9954,6 +10006,56 @@ } ], "side": "客户端" + }, + { + "name": "GetIntPos", + "path": "client.extraClientApi", + "desc": "获取坐标所在方块的位置，即浮点数坐标向下取整后的整数坐标。", + "doc_class_path": [ + "通用/数学" + ], + "param": [ + { + "param_comment": "坐标元组", + "param_name": "pos", + "param_type": "tuple(float,float,float)" + } + ], + "return": { + "return_type": "tuple(int,int,int)", + "return_comment": "坐标所在方块的位置" + }, + "state": [ + { + "comment": "获取坐标所在方块的位置", + "operation": "新增", + "version": "3.4", + "author": "lrz" + } + ], + "side": "客户端" + }, + { + "name": "GetHostPlayerId", + "path": "client.extraClientApi", + "desc": "获取房主的entityId", + "doc_class_path": [ + "通用/工具" + ], + "param": [], + "return": { + "return_type": "str", + "return_comment": "房主的entityId,若房主未加入则返回None" + }, + "state": [ + { + "comment": "获取房主的entityId", + "operation": "新增", + "version": "3.4", + "author": "lrz" + } + ], + "side": "客户端" } ], "server.component.weatherCompServer.WeatherComponentServer": [ @@ -10470,12 +10572,12 @@ "param": [ { "param_comment": "贴图键", - "param_name": "geometryKey", + "param_name": "textureKey", "param_type": "str" }, { "param_comment": "贴图路径", - "param_name": "geometryName", + "param_name": "textureName", "param_type": "str" } ], @@ -12096,6 +12198,11 @@ "param_comment": "渲染参数类型，可选类型有\"textures\",\"geometry\",\"materials\",\"animations\",\"render_controllers\",\"particle_effects\",\"sound_effects\"", "param_name": "paramTypeStr", "param_type": "str" + }, + { + "param_comment": "是否获取详细值，默认为False。该参数对render_controllers无效", + "param_name": "getValue", + "param_type": "bool" } ], "return": { @@ -12108,6 +12215,12 @@ "operation": "新增", "version": "2.7", "author": "wangdingdong" + }, + { + "comment": "修复返回数据", + "operation": "调整", + "version": "3.4", + "author": "lrz" } ], "side": "客户端" @@ -12873,16 +12986,23 @@ "param_type": "tuple(float,float,float)" }, { - "param_comment": "摄像机的角度（俯仰角及偏航角）", + "param_comment": "摄像机的角度（俯仰角,偏航角,横滚角）", "param_name": "lockRot", - "param_type": "tuple(float,float)" + "param_type": "tuple(float,float,float)" } ], "return": { "return_type": "bool", "return_comment": "设置是否成功" }, - "state": [], + "state": [ + { + "comment": "lockRot支持roll旋转", + "operation": "调整", + "version": "3.4", + "author": "qiuyukun" + } + ], "side": "客户端" }, { @@ -13484,12 +13604,12 @@ { "param_comment": "相机到达targetPos时的朝向，受参数relativeCoord影响，默认为None，表示使用调用[StartCameraMotion](#StartCameraMotion)时的朝向。", "param_name": "targetRot", - "param_type": "tuple(float,float)" + "param_type": "tuple(float,float,float)" }, { "param_comment": "相机到达startPos时的朝向，受参数relativeCoord影响，默认为None，表示使用调用[StartCameraMotion](#StartCameraMotion)时的朝向。", "param_name": "startRot", - "param_type": "tuple(float,float)" + "param_type": "tuple(float,float,float)" }, { "param_comment": "是否使用运动中的速度方向作为朝向，默认为False，若为True，则参数targetRot和startRot无效", @@ -13524,6 +13644,12 @@ "operation": "调整", "version": "2.10", "author": "xusifan" + }, + { + "comment": "targetRot和startRot支持roll旋转", + "operation": "调整", + "version": "3.4", + "author": "qiuyukun" } ], "side": "客户端" @@ -18329,7 +18455,7 @@ { "name": "PlaceFeature", "path": "server.component.gameCompServer.GameComponentServer", - "desc": "放置特征，与[/placefeature指令](https://minecraft.fandom.com/zh/wiki/%E5%91%BD%E4%BB%A4/placefeature)相似", + "desc": "放置特征，与[/placefeature指令](https://zh.minecraft.wiki/w/%E5%91%BD%E4%BB%A4/placefeature)相似", "doc_class_path": [ "世界/地图" ], @@ -19313,7 +19439,7 @@ "param_type": "bool" }, { - "param_comment": "是否给相邻的方块触发[方块更新](https://minecraft.fandom.com/zh/wiki/%E6%96%B9%E5%9D%97%E6%9B%B4%E6%96%B0?variant=zh)以及BlockNeighborChangedServerEvent事件。默认为True触发。若选择不触发可节省约30%的性能消耗。", + "param_comment": "是否给相邻的方块触发[方块更新](https://zh.minecraft.wiki/w/%E6%96%B9%E5%9D%97%E6%9B%B4%E6%96%B0)以及BlockNeighborChangedServerEvent事件。默认为True触发。若选择不触发可节省约30%的性能消耗。", "param_name": "updateNeighbors", "param_type": "bool" } @@ -20236,7 +20362,7 @@ "param_type": "float" }, { - "param_comment": "[时运等级](https://minecraft-zh.gamepedia.com/时运)，默认为0", + "param_comment": "[时运等级](https://zh.minecraft.wiki/w/时运)，默认为0", "param_name": "bonusLootLevel", "param_type": "int" }, @@ -20249,6 +20375,11 @@ "param_comment": "是否允许随机采集，默认为True，如果为False，掉落概率probability无效", "param_name": "allowRandomness", "param_type": "bool" + }, + { + "param_comment": "是否生成经验球，默认都不生成，设成True时按原版采集逻辑进行经验球掉落，如矿石类方块会产生随机数量的经验球", + "param_name": "spawnOrb", + "param_type": "bool" } ], "return": { @@ -20273,6 +20404,12 @@ "operation": "调整", "version": "1.22", "author": "gzhuabo" + }, + { + "comment": "新增是否生成经验球参数，默认为False，设成True时按原版采集逻辑进行经验球掉落，如矿石类方块会产生随机数量的经验球", + "operation": "调整", + "version": "3.4", + "author": "xgb" } ], "side": "服务端" @@ -22298,7 +22435,7 @@ "param_type": "str" }, { - "param_comment": "颜色样式代码字符串，可参考wiki[样式代码](https://minecraft-zh.gamepedia.com/%E6%A0%B7%E5%BC%8F%E4%BB%A3%E7%A0%81)，默认为白色", + "param_comment": "颜色样式代码字符串，可参考wiki[样式代码](https://zh.minecraft.wiki/w/%E6%A0%BC%E5%BC%8F%E5%8C%96%E4%BB%A3%E7%A0%81)，默认为白色", "param_name": "color", "param_type": "str" } @@ -23049,18 +23186,18 @@ { "name": "IsOnLadder", "path": "client.component.playerCompClient.PlayerCompClient", - "desc": "获取玩家是否与梯子/藤蔓有交叉", + "desc": "获取玩家是否在梯子/藤蔓上", "doc_class_path": [ "玩家/行为" ], "param": [], "return": { "return_type": "bool", - "return_comment": "是否与梯子/藤蔓有交叉" + "return_comment": "是否在梯子/藤蔓上" }, "state": [ { - "comment": "获取玩家是否与梯子/藤蔓有交叉", + "comment": "获取玩家是否在梯子/藤蔓上", "operation": "新增", "version": "3.3", "author": "lrz" @@ -23071,18 +23208,18 @@ { "name": "IsInScaffolding", "path": "client.component.playerCompClient.PlayerCompClient", - "desc": "获取玩家是否与脚手架有交叉", + "desc": "获取玩家是否在脚手架中", "doc_class_path": [ "玩家/行为" ], "param": [], "return": { "return_type": "bool", - "return_comment": "是否与脚手架有交叉" + "return_comment": "是否在脚手架中" }, "state": [ { - "comment": "获取玩家是否与脚手架有交叉", + "comment": "获取玩家是否在脚手架中", "operation": "新增", "version": "3.3", "author": "lrz" @@ -23128,6 +23265,56 @@ "state": [], "side": "服务端" }, + { + "name": "GetPlayerCurrentExhaustionValue", + "path": "server.component.playerCompServer.PlayerCompServer", + "desc": "获取玩家foodExhaustionLevel的当前消耗度。详见消耗度介绍", + "doc_class_path": [ + "玩家/属性" + ], + "param": [], + "return": { + "return_type": "float", + "return_comment": "玩家foodExhaustionLevel的当前消耗度," + }, + "state": [ + { + "comment": "获取玩家当前消耗度", + "operation": "新增", + "version": "3.4", + "author": "qiuyukun" + } + ], + "side": "服务端" + }, + { + "name": "SetPlayerCurrentExhaustionValue", + "path": "server.component.playerCompServer.PlayerCompServer", + "desc": "设置玩家foodExhaustionLevel的当前消耗度。详见消耗度介绍", + "doc_class_path": [ + "玩家/属性" + ], + "param": [ + { + "param_comment": "当前消耗度", + "param_name": "value", + "param_type": "float" + } + ], + "return": { + "return_type": "bool", + "return_comment": "是否设置成功" + }, + "state": [ + { + "comment": "设置玩家当前消耗度", + "operation": "新增", + "version": "3.4", + "author": "qiuyukun" + } + ], + "side": "服务端" + }, { "name": "GetPlayerMaxExhaustionValue", "path": "server.component.playerCompServer.PlayerCompServer", @@ -25788,7 +25975,7 @@ { "name": "SetLeashHolder", "path": "server.component.entityDefinitionsCompServer.EntityDefinitionsCompServer", - "desc": "为实体添加牵引者，与原版拴绳的作用相同，详见基岩版栓绳介绍", + "desc": "为实体添加牵引者，与原版拴绳的作用相同，详见基岩版栓绳介绍", "doc_class_path": [ "实体/行为" ], @@ -25942,7 +26129,7 @@ { "param_comment": "xyz值", "param_name": "pos", - "param_type": "tuple(int,int,int)" + "param_type": "tuple(float,float,float)" } ], "return": { @@ -25961,6 +26148,12 @@ "operation": "调整", "version": "1.20", "author": "jishaobin" + }, + { + "comment": "修改文档类型描述", + "operation": "调整", + "version": "3.4", + "author": "bailei" } ], "side": "服务端" @@ -26632,7 +26825,7 @@ { "name": "SetEntityScale", "path": "server.component.scaleCompServer.ScaleComponentServer", - "desc": "设置实体的放缩比例大小，设置比例过大会导致游戏卡顿，建议控制在20倍以内", + "desc": "设置实体的放缩比例大小，设置比例过大会导致游戏卡顿，建议控制在20倍以内。实体的scale的立方乘以包围盒的体积不可超过32768", "doc_class_path": [ "模型" ], @@ -27354,7 +27547,7 @@ ], "param": [ { - "param_comment": "贴图路径，以textures\\models为当前路径的相对路径", + "param_comment": "贴图路径，以textures/models为当前路径的相对路径", "param_name": "skin", "param_type": "str" } @@ -30163,6 +30356,56 @@ } ], "side": "服务端" + }, + { + "name": "GetIntPos", + "path": "server.extraServerApi", + "desc": "获取坐标所在方块的位置，即浮点数坐标向下取整后的整数坐标。", + "doc_class_path": [ + "通用/数学" + ], + "param": [ + { + "param_comment": "坐标元组", + "param_name": "pos", + "param_type": "tuple(float,float,float)" + } + ], + "return": { + "return_type": "tuple(int,int,int)", + "return_comment": "坐标所在方块的位置" + }, + "state": [ + { + "comment": "获取坐标所在方块的位置", + "operation": "新增", + "version": "3.4", + "author": "lrz" + } + ], + "side": "服务端" + }, + { + "name": "GetHostPlayerId", + "path": "server.extraServerApi", + "desc": "获取房主的entityId", + "doc_class_path": [ + "通用/工具" + ], + "param": [], + "return": { + "return_type": "str", + "return_comment": "房主的entityId,若房主未加入则返回None" + }, + "state": [ + { + "comment": "获取房主的entityId", + "operation": "新增", + "version": "3.4", + "author": "lrz" + } + ], + "side": "服务端" } ], "server.component.blockUseEventWhiteListCompServer.BlockUseEventWhiteListComponentServer": [ @@ -31411,6 +31654,12 @@ "operation": "调整", "version": "3.2", "author": "xgb" + }, + { + "comment": "新增字段，enchant_slot_type", + "operation": "调整", + "version": "3.4", + "author": "qiuyukun" } ], "side": "服务端" @@ -33148,7 +33397,7 @@ { "name": "LocateStructureFeature", "path": "server.component.featureCompServer.FeatureCompServer", - "desc": "与[/locate指令](https://minecraft-zh.gamepedia.com/%E5%91%BD%E4%BB%A4/locate)相似，用于定位原版的部分结构，如海底神殿、末地城等。", + "desc": "与[/locate指令](https://zh.minecraft.wiki/w/%E5%91%BD%E4%BB%A4/locate)相似，用于定位原版的部分结构，如海底神殿、末地城等。", "doc_class_path": [ "世界/地图" ], @@ -33197,7 +33446,7 @@ { "name": "LocateNeteaseFeatureRule", "path": "server.component.featureCompServer.FeatureCompServer", - "desc": "与[/locate指令](https://minecraft-zh.gamepedia.com/%E5%91%BD%E4%BB%A4/locate)相似，用于定位网易自定义特征规则", + "desc": "与[/locate指令](https://zh.minecraft.wiki/w/%E5%91%BD%E4%BB%A4/locate)相似，用于定位网易自定义特征规则", "doc_class_path": [ "世界/地图" ], @@ -36596,6 +36845,12 @@ "operation": "调整", "version": "3.2", "author": "xgb" + }, + { + "comment": "新增字段，enchant_slot_type", + "operation": "调整", + "version": "3.4", + "author": "qiuyukun" } ], "side": "客户端" @@ -37354,7 +37609,7 @@ "param_type": "tuple(float,float,float)" }, { - "param_comment": "爆炸威力，具体含义可参考[wiki](https://minecraft-zh.gamepedia.com/%E7%88%86%E7%82%B8)对爆炸的解释", + "param_comment": "爆炸威力，具体含义可参考[wiki](https://zh.minecraft.wiki/w/%E7%88%86%E7%82%B8)对爆炸的解释", "param_name": "radius", "param_type": "int" }, @@ -38701,7 +38956,7 @@ { "name": "SetSize", "path": "server.component.collisionBoxCompServer.CollisionBoxComponentServer", - "desc": "设置实体的包围盒", + "desc": "设置实体的包围盒。设置过大会导致游戏卡顿。实体的scale的立方乘以包围盒的体积不可超过32768", "doc_class_path": [ "实体/属性" ], @@ -40299,7 +40554,7 @@ "doc_class_path": [], "param": [ { - "param_comment": "文本的内容，可以支持[样式代码](https://minecraft-zh.gamepedia.com/%E6%A0%B7%E5%BC%8F%E4%BB%A3%E7%A0%81)（§可以设置文字的颜色、格式等，该种用法更加灵活多变）", + "param_comment": "文本的内容，可以支持[样式代码](https://zh.minecraft.wiki/w/%E6%A0%BC%E5%BC%8F%E5%8C%96%E4%BB%A3%E7%A0%81)（§可以设置文字的颜色、格式等，该种用法更加灵活多变）", "param_name": "text", "param_type": "str" }, diff --git a/docs/mcdocs/1-ModAPI/事件/UI.md b/docs/mcdocs/1-ModAPI/事件/UI.md index d6e6711f..d83ff485 100644 --- a/docs/mcdocs/1-ModAPI/事件/UI.md +++ b/docs/mcdocs/1-ModAPI/事件/UI.md @@ -13,7 +13,7 @@ sidebarDepth: 1 | [ClientPlayerInventoryCloseEvent](UI.md#clientplayerinventorycloseevent) | 客户端 | 关闭物品背包界面时触发 | | [ClientPlayerInventoryOpenEvent](UI.md#clientplayerinventoryopenevent) | 客户端 | 打开物品背包界面时触发 | | [CloseNeteaseShopEvent](UI.md#closeneteaseshopevent) | 客户端 | 关闭商城界面时触发，包括脚本商城和Apollo插件商城 | -| [GridComponentSizeChangedClientEvent](UI.md#gridcomponentsizechangedclientevent) | 客户端 | 触发时机：UI grid组件里格子数目发生变化时触发 | +| [GridComponentSizeChangedClientEvent](UI.md#gridcomponentsizechangedclientevent) | 客户端 | UI grid控件里格子重新排列时触发 | | [HudButtonChangedClientEvent](UI.md#hudbuttonchangedclientevent) | 客户端 | 当原生HUD按钮位置或大小发生改变时触发，例如玩家使用了自定义控件功能会触发，可在该事件中修改mod按钮的位置防止重叠 | | [OnItemSlotButtonClickedEvent](UI.md#onitemslotbuttonclickedevent) | 客户端 | 点击快捷栏、背包栏、盔甲栏、副手栏的物品槽时触发 | | [PlayerChatButtonClickClientEvent](UI.md#playerchatbuttonclickclientevent) | 客户端 | 玩家点击聊天按钮或回车键触发呼出聊天窗口时客户端抛出的事件 | @@ -152,7 +152,7 @@ sidebarDepth: 1 - 描述 - 触发时机：UI grid组件里格子数目发生变化时触发 + UI grid控件里格子重新排列时触发 - 参数 @@ -206,7 +206,7 @@ sidebarDepth: 1 | 参数名 |
数据类型
| 说明 | | :--- | :--- | :--- | - | slotIndex | int | 点击的物品槽的编号，编号对应位置详见[物品栏] | + | slotIndex | int | 点击的物品槽的编号，编号对应位置详见[物品栏] | - 返回值 diff --git a/docs/mcdocs/1-ModAPI/事件/世界.md b/docs/mcdocs/1-ModAPI/事件/世界.md index a866350a..cab5851d 100644 --- a/docs/mcdocs/1-ModAPI/事件/世界.md +++ b/docs/mcdocs/1-ModAPI/事件/世界.md @@ -44,7 +44,6 @@ sidebarDepth: 1 | [PlayerIntendLeaveServerEvent](世界.md#playerintendleaveserverevent) | 服务端 | 触发时机：即将删除玩家时触发该事件，此时可以通过各种API获取玩家的当前状态。 | | [PlayerJoinMessageEvent](世界.md#playerjoinmessageevent) | 服务端 | 触发时机：准备显示“xxx加入游戏”的玩家登录提示文字时服务端抛出的事件。 | | [PlayerLeftMessageServerEvent](世界.md#playerleftmessageserverevent) | 服务端 | 触发时机：准备显示“xxx离开游戏”的玩家离开提示文字时服务端抛出的事件。 | -| [PrimaryClientSyncSkinClientEvent](世界.md#primaryclientsyncskinclientevent) | 客户端 | 主客户端自己更换了皮肤触发 | | [RemoveEntityClientEvent](世界.md#removeentityclientevent) | 客户端 | 客户端侧实体被移除时触发 | | [RemovePlayerAOIClientEvent](世界.md#removeplayeraoiclientevent) | 客户端 | 玩家离开当前玩家视野时触发的事件 | | [ServerChatEvent](世界.md#serverchatevent) | 服务端 | 玩家发送聊天信息时触发 | @@ -244,7 +243,7 @@ sidebarDepth: 1 无 - 备注 - - 区块卸载：游戏只会加载玩家周围的区块，玩家移动到别的区域时，原来所在区域的区块会被卸载，参考[区块介绍](https://minecraft-zh.gamepedia.com/%E5%8C%BA%E5%9D%97) + - 区块卸载：游戏只会加载玩家周围的区块，玩家移动到别的区域时，原来所在区域的区块会被卸载，参考[区块介绍](https://zh.minecraft.wiki/w/%E5%8C%BA%E5%9D%97) @@ -271,7 +270,7 @@ sidebarDepth: 1 无 - 备注 - - 区块卸载：游戏只会加载玩家周围的区块，玩家移动到别的区域时，原来所在区域的区块会被卸载，参考[区块介绍](https://minecraft-zh.gamepedia.com/%E5%8C%BA%E5%9D%97) + - 区块卸载：游戏只会加载玩家周围的区块，玩家移动到别的区域时，原来所在区域的区块会被卸载，参考[区块介绍](https://zh.minecraft.wiki/w/%E5%8C%BA%E5%9D%97) @@ -288,6 +287,8 @@ sidebarDepth: 1 | 参数名 |
数据类型
| 说明 | | :--- | :--- | :--- | | dimension | int | 该区块所在的维度 | + | chunkPosX | int | 区块的x坐标，对应方块X坐标区间为[x * 16, x * 16 + 15] | + | chunkPosZ | int | 区块的z坐标，对应方块Z坐标区间为[z * 16, z * 16 + 15] | | blockEntityData | [{"blockName":str,"posX":int,"posY":int,"posZ":int}...]/None | 该区块中的自定义方块实体列表，通常是由自定义特征生成的自定义方块，没有自定义方块实体时该值为None | - 返回值 @@ -444,11 +445,11 @@ sidebarDepth: 1 |pos|tuple|含有三个float的坐标，如(-0.93, 81.25, -5.67)| |target|tuple|含有对应的所有目标entityId，如('-139816907912', '-263852559602')| |entity|dict|含有实体名称，如{'entityType': 'minecraft:cow'}| - |effect|dict|含有状态效果名称和对应的[EffectType](../枚举值/EffectType.md)枚举，如`{'name': 'absorption', 'id': 22}`| - |dimension|dict|含有维度名称和对应数字id，如`{'name': 'nether', 'id': 1}`| - |biome|dict|含有生物群系名称和对应的[BiomeType](../枚举值/BiomeType.md)枚举，如`{'name': 'bamboo_jungle', 'biomeType': 48}`| - |structure|dict|含有结构名称和对应的[StructureFeatureType](../枚举值/StructureFeatureType.md)枚举，如`{'name': 'ancient_city', 'structureType': 15}`| - |enchant|dict|含有附魔名称和对应的[EnchantType](../枚举值/EnchantType.md)枚举，如`{'identifier': 'knockback', 'type': 12}`| + |effect|dict|含有状态效果名称和对应的[EffectType](../枚举值/EffectType.md)枚举，如{'name': 'absorption', 'id': 22}| + |dimension|dict|含有维度名称和对应数字id，如{'name': 'nether', 'id': 1}| + |biome|dict|含有生物群系名称和对应的[BiomeType](../枚举值/BiomeType.md)枚举，如{'name': 'bamboo_jungle', 'biomeType': 48}| + |structure|dict|含有结构名称和对应的[StructureFeatureType](../枚举值/StructureFeatureType.md)枚举，如{'name': 'ancient_city', 'structureType': 15}| + |enchant|dict|含有附魔名称和对应的[EnchantType](../枚举值/EnchantType.md)枚举，如{'identifier': 'knockback', 'type': 12}| @@ -495,7 +496,7 @@ sidebarDepth: 1 无 - 备注 - - 触发情景：实体从场景中被删除，例如：生物死亡，生物被[清除](https://minecraft.fandom.com/zh/wiki/%E7%94%9F%E6%88%90#.E6.B8.85.E9.99.A4)，玩家退出游戏，船/盔甲架被破坏，掉落物/经验球被捡起或清除 + - 触发情景：实体从场景中被删除，例如：生物死亡，生物被[清除](https://zh.minecraft.wiki/w/%E7%94%9F%E6%88%90#%E6%B8%85%E9%99%A4)，玩家退出游戏，船/盔甲架被破坏，掉落物/经验球被捡起或清除 - 当生物随区块卸载时，不会触发该事件，而是ChunkAcquireDiscardedServerEvent事件 - 关于生物的清除：当生物离玩家大于wiki所说的距离，并且还在玩家的模拟距离内时，会被清除。也就是说，如果玩家瞬间传送到远处，原处的生物马上离开了模拟距离，并不会被清除 - 玩家退出游戏时，EntityRemoveEvent，DelServerPlayerEvent按顺序依次触发 @@ -1195,24 +1196,6 @@ comp.ClearAllNeteaseFeatureWhiteList() 在零件中直接声明一个同名函数，即可完成监听，详情参考零件事件 -## PrimaryClientSyncSkinClientEvent - -客户端 - -- 描述 - - 主客户端自己更换了皮肤触发 - -- 参数 - - 无 - -- 返回值 - - 无 - - - ## RemoveEntityClientEvent 客户端 diff --git a/docs/mcdocs/1-ModAPI/事件/事件索引表.md b/docs/mcdocs/1-ModAPI/事件/事件索引表.md index 14c8cf9f..afcf0cc8 100644 --- a/docs/mcdocs/1-ModAPI/事件/事件索引表.md +++ b/docs/mcdocs/1-ModAPI/事件/事件索引表.md @@ -56,7 +56,6 @@ sidebarDepth: 1 | [PlayerIntendLeaveServerEvent](世界.md#playerintendleaveserverevent) | 服务端 | 触发时机：即将删除玩家时触发该事件，此时可以通过各种API获取玩家的当前状态。 | | [PlayerJoinMessageEvent](世界.md#playerjoinmessageevent) | 服务端 | 触发时机：准备显示“xxx加入游戏”的玩家登录提示文字时服务端抛出的事件。 | | [PlayerLeftMessageServerEvent](世界.md#playerleftmessageserverevent) | 服务端 | 触发时机：准备显示“xxx离开游戏”的玩家离开提示文字时服务端抛出的事件。 | -| [PrimaryClientSyncSkinClientEvent](世界.md#primaryclientsyncskinclientevent) | 客户端 | 主客户端自己更换了皮肤触发 | | [RemoveEntityClientEvent](世界.md#removeentityclientevent) | 客户端 | 客户端侧实体被移除时触发 | | [RemovePlayerAOIClientEvent](世界.md#removeplayeraoiclientevent) | 客户端 | 玩家离开当前玩家视野时触发的事件 | | [ServerChatEvent](世界.md#serverchatevent) | 服务端 | 玩家发送聊天信息时触发 | @@ -89,7 +88,7 @@ sidebarDepth: 1 | [EntityStopRidingEvent](实体.md#entitystopridingevent) | 服务端 | 触发时机：当实体停止骑乘时 | | [EntityStopRidingEvent](实体.md#entitystopridingevent) | 客户端 | 触发时机：当实体停止骑乘时 | | [EntityTickServerEvent](实体.md#entitytickserverevent) | 服务端 | 实体tick时触发。该事件为20帧每秒。需要使用AddEntityTickEventWhiteList添加触发该事件的实体类型白名单。 | -| [HealthChangeBeforeServerEvent](实体.md#healthchangebeforeserverevent) | 服务端 | 生物生命值发生变化之前触发 | +| [HealthChangeBeforeServerEvent](实体.md#healthchangebeforeserverevent) | 服务端 | 生物生命值或最大生命值发生变化之前触发 | | [HealthChangeClientEvent](实体.md#healthchangeclientevent) | 客户端 | 生物生命值发生变化时触发 | | [HealthChangeServerEvent](实体.md#healthchangeserverevent) | 服务端 | 生物生命值发生变化时触发 | | [LeaveEntityClientEvent](实体.md#leaveentityclientevent) | 客户端 | 玩家远离生物时触发 | @@ -220,8 +219,8 @@ sidebarDepth: 1 | [ActorUseItemClientEvent](物品.md#actoruseitemclientevent) | 客户端 | 触发时机：玩家使用物品时客户端抛出的事件（比较特殊不走该事件的例子：1）染料对有水的炼药锅使用；2）盔甲架装备盔甲）;3)喝牛奶 | | [ActorUseItemServerEvent](物品.md#actoruseitemserverevent) | 服务端 | 触发时机：玩家使用物品生效之前服务端抛出的事件（比较特殊不走该事件的例子：1）染料对有水的炼药锅使用；2）盔甲架装备盔甲） | | [AnvilCreateResultItemAfterClientEvent](物品.md#anvilcreateresultitemafterclientevent) | 客户端 | 玩家点击铁砧合成得到的物品时抛出的事件。 | -| [ClientItemTryUseEvent](物品.md#clientitemtryuseevent) | 客户端 | 玩家点击右键尝试使用物品时客户端抛出的事件，可以通过设置cancel为True取消使用物品。注：如果需要取消物品的使用需要同时在ClientItemTryUseEvent和ServerItemTryUseEvent中将cancel设置为True才能正确取消。 | -| [ClientItemUseOnEvent](物品.md#clientitemuseonevent) | 客户端 | 玩家在对方块使用物品时客户端抛出的事件。注：如果需要取消物品的使用需要同时在ClientItemUseOnEvent和ServerItemUseOnEvent中将ret设置为True才能正确取消。 | +| [ClientItemTryUseEvent](物品.md#clientitemtryuseevent) | 客户端 | 玩家点击右键尝试使用物品时客户端抛出的事件，可以通过设置cancel为True取消使用物品。注：ClientItemTryUseEvent事件设置cancel时即可取消使用，无需服务端ServerItemTryUseEvent再次cancel，且服务端事件将不再触发。 | +| [ClientItemUseOnEvent](物品.md#clientitemuseonevent) | 客户端 | 玩家在对方块使用物品时客户端抛出的事件。注：事件设置ret = True 时即可取消使用，无需服务端再次设置ServerItemUseOnEvent取消，且服务端事件将不再触发。 | | [ClientShapedRecipeTriggeredEvent](物品.md#clientshapedrecipetriggeredevent) | 客户端 | 玩家合成物品时触发 | | [ContainerItemChangedServerEvent](物品.md#containeritemchangedserverevent) | 服务端 | 容器物品变化事件 | | [CraftItemOutputChangeServerEvent](物品.md#craftitemoutputchangeserverevent) | 服务端 | 玩家从容器拿出生成物品时触发 | @@ -246,8 +245,9 @@ sidebarDepth: 1 | [PlayerDropItemServerEvent](物品.md#playerdropitemserverevent) | 服务端 | 触发时机：玩家丢弃物品时触发 | | [PlayerPickupArrowServerEvent](物品.md#playerpickuparrowserverevent) | 服务端 | 玩家即将捡起抛射物时触发，包括使用"netease:pick_up"的自定义抛射物 | | [PlayerTryDropItemClientEvent](物品.md#playertrydropitemclientevent) | 客户端 | 触发时机：玩家丢弃物品时触发 | -| [ServerItemTryUseEvent](物品.md#serveritemtryuseevent) | 服务端 | 玩家点击右键尝试使用物品时服务端抛出的事件。注：如果需要取消物品的使用需要同时在ClientItemTryUseEvent和ServerItemTryUseEvent中将cancel设置为True才能正确取消。 | -| [ServerItemUseOnEvent](物品.md#serveritemuseonevent) | 服务端 | 玩家在对方块使用物品之前服务端抛出的事件。注：如果需要取消物品的使用需要同时在ClientItemUseOnEvent和ServerItemUseOnEvent中将ret设置为True才能正确取消。 | +| [PlayerTryPutCustomContainerItemServerEvent](物品.md#playertryputcustomcontaineritemserverevent) | 服务端 | 玩家尝试将物品放入自定义容器时触发该事件 | +| [ServerItemTryUseEvent](物品.md#serveritemtryuseevent) | 服务端 | 玩家点击右键尝试使用物品时服务端抛出的事件。注：ClientItemTryUseEvent的cancel设置为True时，服务端事件不会被触发了。 | +| [ServerItemUseOnEvent](物品.md#serveritemuseonevent) | 服务端 | 玩家在对方块使用物品之前服务端抛出的事件。注：客户端事件ClientItemUseOnEvent设置ret设置为True时，服务端不再会接受到这个事件。 | | [ServerPlayerTryTouchEvent](物品.md#serverplayertrytouchevent) | 服务端 | 玩家即将捡起物品时触发 | | [ShearsUseToBlockBeforeServerEvent](物品.md#shearsusetoblockbeforeserverevent) | 服务端 | 触发时机：实体手持剪刀对方块使用时，有剪刀特殊效果的方块会在服务端线程触发该事件 | | [StartUsingItemClientEvent](物品.md#startusingitemclientevent) | 客户端 | 玩家使用物品（目前仅支持Bucket（奶桶）、Trident（三叉戟）、RangedWeapon（弓）、Food（食物）、Potion（药水）、Crossbow（弩））时抛出 | @@ -276,7 +276,7 @@ sidebarDepth: 1 | [ClientPlayerInventoryCloseEvent](UI.md#clientplayerinventorycloseevent) | 客户端 | 关闭物品背包界面时触发 | | [ClientPlayerInventoryOpenEvent](UI.md#clientplayerinventoryopenevent) | 客户端 | 打开物品背包界面时触发 | | [CloseNeteaseShopEvent](UI.md#closeneteaseshopevent) | 客户端 | 关闭商城界面时触发，包括脚本商城和Apollo插件商城 | -| [GridComponentSizeChangedClientEvent](UI.md#gridcomponentsizechangedclientevent) | 客户端 | 触发时机：UI grid组件里格子数目发生变化时触发 | +| [GridComponentSizeChangedClientEvent](UI.md#gridcomponentsizechangedclientevent) | 客户端 | UI grid控件里格子重新排列时触发 | | [HudButtonChangedClientEvent](UI.md#hudbuttonchangedclientevent) | 客户端 | 当原生HUD按钮位置或大小发生改变时触发，例如玩家使用了自定义控件功能会触发，可在该事件中修改mod按钮的位置防止重叠 | | [OnItemSlotButtonClickedEvent](UI.md#onitemslotbuttonclickedevent) | 客户端 | 点击快捷栏、背包栏、盔甲栏、副手栏的物品槽时触发 | | [PlayerChatButtonClickClientEvent](UI.md#playerchatbuttonclickclientevent) | 客户端 | 玩家点击聊天按钮或回车键触发呼出聊天窗口时客户端抛出的事件 | diff --git a/docs/mcdocs/1-ModAPI/事件/实体.md b/docs/mcdocs/1-ModAPI/事件/实体.md index 92f1d87b..8a3460cf 100644 --- a/docs/mcdocs/1-ModAPI/事件/实体.md +++ b/docs/mcdocs/1-ModAPI/事件/实体.md @@ -28,7 +28,7 @@ sidebarDepth: 1 | [EntityStopRidingEvent](实体.md#entitystopridingevent) | 服务端 | 触发时机：当实体停止骑乘时 | | [EntityStopRidingEvent](实体.md#entitystopridingevent) | 客户端 | 触发时机：当实体停止骑乘时 | | [EntityTickServerEvent](实体.md#entitytickserverevent) | 服务端 | 实体tick时触发。该事件为20帧每秒。需要使用AddEntityTickEventWhiteList添加触发该事件的实体类型白名单。 | -| [HealthChangeBeforeServerEvent](实体.md#healthchangebeforeserverevent) | 服务端 | 生物生命值发生变化之前触发 | +| [HealthChangeBeforeServerEvent](实体.md#healthchangebeforeserverevent) | 服务端 | 生物生命值或最大生命值发生变化之前触发 | | [HealthChangeClientEvent](实体.md#healthchangeclientevent) | 客户端 | 生物生命值发生变化时触发 | | [HealthChangeServerEvent](实体.md#healthchangeserverevent) | 服务端 | 生物生命值发生变化时触发 | | [LeaveEntityClientEvent](实体.md#leaveentityclientevent) | 客户端 | 玩家远离生物时触发 | @@ -662,7 +662,7 @@ serverApi.AddEntityTickEventWhiteList('minecraft:cow') - 描述 - 生物生命值发生变化之前触发 + 生物生命值或最大生命值发生变化之前触发 - 参数 diff --git a/docs/mcdocs/1-ModAPI/事件/方块.md b/docs/mcdocs/1-ModAPI/事件/方块.md index e01925e4..7c0411dd 100644 --- a/docs/mcdocs/1-ModAPI/事件/方块.md +++ b/docs/mcdocs/1-ModAPI/事件/方块.md @@ -74,6 +74,8 @@ sidebarDepth: 1 | 参数名 |
数据类型
| 说明 | | :--- | :--- | :--- | | blockPos | tuple(float,float,float) | 方块坐标 | + | blockName | str | 方块的identifier，包含命名空间及名称 | + | auxData | int | 方块附加值 | - 返回值 @@ -351,6 +353,7 @@ comp.ListenOnBlockRemoveEvent("minecraft:wheat", True) | blockName | str | 方块的identifier，包含命名空间及名称 | | auxValue | int | 方块附加值 | | newStrength | int | 变化后的红石信号量 | + | oldStrength | int | 变化前的红石信号量 | | dimensionId | int | 维度 | - 返回值 @@ -413,9 +416,6 @@ comp.ListenOnBlockRemoveEvent("minecraft:wheat", True) 无 -- 备注 - - 有的方块是在ServerBlockUseEvent中设置cancel生效，但是有部分方块是在ClientBlockUseEvent中设置cancel才生效，如有需求建议在两个事件中同时设置cancel以保证生效。 - 在零件中直接声明一个同名函数，即可完成监听，详情参考零件事件 @@ -449,7 +449,7 @@ import mod.client.extraClientApi as clientApi comp = clientApi.GetEngineCompFactory().CreateBlockUseEventWhiteList(clientApi.GetLevelId()) comp.AddBlockItemListenForUseEvent("minecraft:nether_brick_stairs:2") # 注意blockName格式为namespace:name:auxvalue，如果不填auxvalue，则默认为所有auxvalue -# auxValue详细值详见官方wiki，如https://minecraft-zh.gamepedia.com/楼梯 中的‘方块数据值’ +# auxValue详细值详见官方wiki，如https://zh.minecraft.wiki/w/楼梯 中的‘方块数据值’ ``` @@ -482,7 +482,7 @@ import mod.client.extraClientApi as clientApi comp = clientApi.GetEngineCompFactory().CreateBlockUseEventWhiteList(clientApi.GetLevelId()) comp.RemoveBlockItemListenForUseEvent("minecraft:nether_brick_stairs:2") # 注意blockName格式为namespace:name:auxvalue，如果不填auxvalue，则默认为所有auxvalue -# auxValue详细值详见官方wiki，如https://minecraft-zh.gamepedia.com/楼梯 中的‘方块数据值’ +# auxValue详细值详见官方wiki，如https://zh.minecraft.wiki/w/楼梯 中的‘方块数据值’ ``` @@ -1700,7 +1700,6 @@ comp.UnRegisterOnStandOn("minecraft:redstone_ore") - 备注 - 当对原生方块进行使用时，如堆肥桶等类似有 使用 功能的方块使用物品时，会触发该事件，而ServerItemUseOnEvent则不会被触发。对应的客户端事件同理。 - - 有的方块是在ServerBlockUseEvent中设置cancel生效，但是有部分方块是在ClientBlockUseEvent中设置cancel才生效，如有需求建议在两个事件中同时设置cancel以保证生效。 - 部分工具对方块的使用效果，如锹犁地，不一定能通过该事件cancel，还需同时使用ItemUseOnServerEvent进行取消 目前已知有： 锹犁地相关的方块：草地、泥土、砂土、菌丝体、灰化土、缠根泥土，均需同时通过ServerBlockUseEvent和ItemUseOnServerEvent进行取消 @@ -1738,7 +1737,7 @@ import mod.server.extraServerApi as serverApi comp = serverApi.GetEngineCompFactory().CreateBlockUseEventWhiteList(levelId) comp.AddBlockItemListenForUseEvent("minecraft:nether_brick_stairs:2") # 注意blockName格式为namespace:name:auxvalue，如果不填auxvalue，则默认为所有auxvalue -# auxValue详细值详见官方wiki，如https://minecraft-zh.gamepedia.com/楼梯 中的‘方块数据值’ +# auxValue详细值详见官方wiki，如https://zh.minecraft.wiki/w/楼梯 中的‘方块数据值’ ``` @@ -1771,7 +1770,7 @@ import mod.server.extraServerApi as serverApi comp = serverApi.GetEngineCompFactory().CreateBlockUseEventWhiteList(levelId) comp.RemoveBlockItemListenForUseEvent("minecraft:nether_brick_stairs:2") # 注意blockName格式为namespace:name:auxvalue，如果不填auxvalue，则默认为所有auxvalue -# auxValue详细值详见官方wiki，如https://minecraft-zh.gamepedia.com/楼梯 中的‘方块数据值’ +# auxValue详细值详见官方wiki，如https://zh.minecraft.wiki/w/楼梯 中的‘方块数据值’ ``` diff --git a/docs/mcdocs/1-ModAPI/事件/物品.md b/docs/mcdocs/1-ModAPI/事件/物品.md index 2c295a02..5f73b023 100644 --- a/docs/mcdocs/1-ModAPI/事件/物品.md +++ b/docs/mcdocs/1-ModAPI/事件/物品.md @@ -12,8 +12,8 @@ sidebarDepth: 1 | [ActorUseItemClientEvent](物品.md#actoruseitemclientevent) | 客户端 | 触发时机：玩家使用物品时客户端抛出的事件（比较特殊不走该事件的例子：1）染料对有水的炼药锅使用；2）盔甲架装备盔甲）;3)喝牛奶 | | [ActorUseItemServerEvent](物品.md#actoruseitemserverevent) | 服务端 | 触发时机：玩家使用物品生效之前服务端抛出的事件（比较特殊不走该事件的例子：1）染料对有水的炼药锅使用；2）盔甲架装备盔甲） | | [AnvilCreateResultItemAfterClientEvent](物品.md#anvilcreateresultitemafterclientevent) | 客户端 | 玩家点击铁砧合成得到的物品时抛出的事件。 | -| [ClientItemTryUseEvent](物品.md#clientitemtryuseevent) | 客户端 | 玩家点击右键尝试使用物品时客户端抛出的事件，可以通过设置cancel为True取消使用物品。注：如果需要取消物品的使用需要同时在ClientItemTryUseEvent和ServerItemTryUseEvent中将cancel设置为True才能正确取消。 | -| [ClientItemUseOnEvent](物品.md#clientitemuseonevent) | 客户端 | 玩家在对方块使用物品时客户端抛出的事件。注：如果需要取消物品的使用需要同时在ClientItemUseOnEvent和ServerItemUseOnEvent中将ret设置为True才能正确取消。 | +| [ClientItemTryUseEvent](物品.md#clientitemtryuseevent) | 客户端 | 玩家点击右键尝试使用物品时客户端抛出的事件，可以通过设置cancel为True取消使用物品。注：ClientItemTryUseEvent事件设置cancel时即可取消使用，无需服务端ServerItemTryUseEvent再次cancel，且服务端事件将不再触发。 | +| [ClientItemUseOnEvent](物品.md#clientitemuseonevent) | 客户端 | 玩家在对方块使用物品时客户端抛出的事件。注：事件设置ret = True 时即可取消使用，无需服务端再次设置ServerItemUseOnEvent取消，且服务端事件将不再触发。 | | [ClientShapedRecipeTriggeredEvent](物品.md#clientshapedrecipetriggeredevent) | 客户端 | 玩家合成物品时触发 | | [ContainerItemChangedServerEvent](物品.md#containeritemchangedserverevent) | 服务端 | 容器物品变化事件 | | [CraftItemOutputChangeServerEvent](物品.md#craftitemoutputchangeserverevent) | 服务端 | 玩家从容器拿出生成物品时触发 | @@ -38,8 +38,9 @@ sidebarDepth: 1 | [PlayerDropItemServerEvent](物品.md#playerdropitemserverevent) | 服务端 | 触发时机：玩家丢弃物品时触发 | | [PlayerPickupArrowServerEvent](物品.md#playerpickuparrowserverevent) | 服务端 | 玩家即将捡起抛射物时触发，包括使用"netease:pick_up"的自定义抛射物 | | [PlayerTryDropItemClientEvent](物品.md#playertrydropitemclientevent) | 客户端 | 触发时机：玩家丢弃物品时触发 | -| [ServerItemTryUseEvent](物品.md#serveritemtryuseevent) | 服务端 | 玩家点击右键尝试使用物品时服务端抛出的事件。注：如果需要取消物品的使用需要同时在ClientItemTryUseEvent和ServerItemTryUseEvent中将cancel设置为True才能正确取消。 | -| [ServerItemUseOnEvent](物品.md#serveritemuseonevent) | 服务端 | 玩家在对方块使用物品之前服务端抛出的事件。注：如果需要取消物品的使用需要同时在ClientItemUseOnEvent和ServerItemUseOnEvent中将ret设置为True才能正确取消。 | +| [PlayerTryPutCustomContainerItemServerEvent](物品.md#playertryputcustomcontaineritemserverevent) | 服务端 | 玩家尝试将物品放入自定义容器时触发该事件 | +| [ServerItemTryUseEvent](物品.md#serveritemtryuseevent) | 服务端 | 玩家点击右键尝试使用物品时服务端抛出的事件。注：ClientItemTryUseEvent的cancel设置为True时，服务端事件不会被触发了。 | +| [ServerItemUseOnEvent](物品.md#serveritemuseonevent) | 服务端 | 玩家在对方块使用物品之前服务端抛出的事件。注：客户端事件ClientItemUseOnEvent设置ret设置为True时，服务端不再会接受到这个事件。 | | [ServerPlayerTryTouchEvent](物品.md#serverplayertrytouchevent) | 服务端 | 玩家即将捡起物品时触发 | | [ShearsUseToBlockBeforeServerEvent](物品.md#shearsusetoblockbeforeserverevent) | 服务端 | 触发时机：实体手持剪刀对方块使用时，有剪刀特殊效果的方块会在服务端线程触发该事件 | | [StartUsingItemClientEvent](物品.md#startusingitemclientevent) | 客户端 | 玩家使用物品（目前仅支持Bucket（奶桶）、Trident（三叉戟）、RangedWeapon（弓）、Food（食物）、Potion（药水）、Crossbow（弩））时抛出 | @@ -178,7 +179,7 @@ sidebarDepth: 1 - 描述 - 玩家点击右键尝试使用物品时客户端抛出的事件，可以通过设置cancel为True取消使用物品。注：如果需要取消物品的使用需要同时在ClientItemTryUseEvent和ServerItemTryUseEvent中将cancel设置为True才能正确取消。 + 玩家点击右键尝试使用物品时客户端抛出的事件，可以通过设置cancel为True取消使用物品。注：ClientItemTryUseEvent事件设置cancel时即可取消使用，无需服务端ServerItemTryUseEvent再次cancel，且服务端事件将不再触发。 - 参数 @@ -204,7 +205,7 @@ sidebarDepth: 1 - 描述 - 玩家在对方块使用物品时客户端抛出的事件。注：如果需要取消物品的使用需要同时在ClientItemUseOnEvent和ServerItemUseOnEvent中将ret设置为True才能正确取消。 + 玩家在对方块使用物品时客户端抛出的事件。注：事件设置ret = True 时即可取消使用，无需服务端再次设置ServerItemUseOnEvent取消，且服务端事件将不再触发。 - 参数 @@ -690,7 +691,7 @@ def OnCraftItemOutputChangeServerEvent(self, args): | 参数名 |
数据类型
| 说明 | | :--- | :--- | :--- | | playerId | str | 玩家id，参数类型为str | - | slotType | int | 玩家放入物品的EnchantSlotType | + | slotType | int | 玩家放入物品的[EnchantSlotType](../枚举值/EnchantSlotType.md) | | options | list | 附魔台选项 | | change | bool | 传入True时，附魔台选项会被新传入的options覆盖 | @@ -904,13 +905,41 @@ def OnCraftItemOutputChangeServerEvent(self, args): 在零件中直接声明一个同名函数，即可完成监听，详情参考零件事件 +## PlayerTryPutCustomContainerItemServerEvent + +服务端 + +- 描述 + + 玩家尝试将物品放入自定义容器时触发该事件 + +- 参数 + + | 参数名 |
数据类型
| 说明 | + | :--- | :--- | :--- | + | itemDict | dict | 尝试放入物品的物品信息字典 | + | collectionName | str | 放入容器名称，目前仅支持netease_container和netease_ui_container | + | collectionIndex | int | 放入容器索引 | + | playerId | str | 玩家id | + | x | float | 容器方块x坐标 | + | y | float | 容器方块y坐标 | + | z | float | 容器方块z坐标 | + | cancel | bool | 是否取消该操作，默认为false，事件中改为true时拒绝此次放入自定义容器的操作 | + +- 返回值 + + 无 + +在零件中直接声明一个同名函数，即可完成监听，详情参考零件事件 + + ## ServerItemTryUseEvent 服务端 - 描述 - 玩家点击右键尝试使用物品时服务端抛出的事件。注：如果需要取消物品的使用需要同时在ClientItemTryUseEvent和ServerItemTryUseEvent中将cancel设置为True才能正确取消。 + 玩家点击右键尝试使用物品时服务端抛出的事件。注：ClientItemTryUseEvent的cancel设置为True时，服务端事件不会被触发了。 - 参数 @@ -936,7 +965,7 @@ def OnCraftItemOutputChangeServerEvent(self, args): - 描述 - 玩家在对方块使用物品之前服务端抛出的事件。注：如果需要取消物品的使用需要同时在ClientItemUseOnEvent和ServerItemUseOnEvent中将ret设置为True才能正确取消。 + 玩家在对方块使用物品之前服务端抛出的事件。注：客户端事件ClientItemUseOnEvent设置ret设置为True时，服务端不再会接受到这个事件。 - 参数 diff --git a/docs/mcdocs/1-ModAPI/接口/Api索引表.md b/docs/mcdocs/1-ModAPI/接口/Api索引表.md index 454796d0..261bf81c 100644 --- a/docs/mcdocs/1-ModAPI/接口/Api索引表.md +++ b/docs/mcdocs/1-ModAPI/接口/Api索引表.md @@ -189,6 +189,8 @@ sidebarDepth: 1 | --- | --- | --- | | [GetDirFromRot](通用/数学.md#getdirfromrot) | 服务端 | 通过旋转角度获取朝向 | | [GetDirFromRot](通用/数学.md#getdirfromrot) | 客户端 | 通过旋转角度获取朝向 | +| [GetIntPos](通用/数学.md#getintpos) | 服务端 | 获取坐标所在方块的位置，即浮点数坐标向下取整后的整数坐标。 | +| [GetIntPos](通用/数学.md#getintpos) | 客户端 | 获取坐标所在方块的位置，即浮点数坐标向下取整后的整数坐标。 | | [GetLocalPosFromWorld](通用/数学.md#getlocalposfromworld) | 服务端 | 获取基于实体的世界坐标对应的局部坐标 | | [GetLocalPosFromWorld](通用/数学.md#getlocalposfromworld) | 客户端 | 获取基于实体的世界坐标对应的局部坐标 | | [GetRotFromDir](通用/数学.md#getrotfromdir) | 服务端 | 通过朝向获取旋转角度 | @@ -212,6 +214,8 @@ sidebarDepth: 1 | [GetChinese](通用/工具.md#getchinese) | 客户端 | 获取langStr对应的中文，可参考PC开发包中\handheld\localization\handheld\data\resource_packs\vanilla\texts\zh_CN.lang | | [GetClipboardContent](通用/工具.md#getclipboardcontent) | 客户端 | 获取系统剪贴板内容 | | [GetFps](通用/工具.md#getfps) | 客户端 | 获取fps | +| [GetHostPlayerId](通用/工具.md#gethostplayerid) | 服务端 | 获取房主的entityId | +| [GetHostPlayerId](通用/工具.md#gethostplayerid) | 客户端 | 获取房主的entityId | | [GetMinecraftEnum](通用/工具.md#getminecraftenum) | 服务端 | 用于获取[枚举值文档](通用/../../枚举值/索引.md)中的枚举值 | | [GetMinecraftEnum](通用/工具.md#getminecraftenum) | 客户端 | 用于获取[枚举值文档](通用/../../枚举值/索引.md)中的枚举值 | | [GetModConfigJson](通用/工具.md#getmodconfigjson) | 客户端 | 以字典形式返回指定路径的json格式配置文件的内容，文件必须放置在资源包的/modconfigs目录下 | @@ -296,13 +300,13 @@ sidebarDepth: 1 | [GetStructureSize](世界/地图.md#getstructuresize) | 服务端 | 获取结构体的长宽高 | | [IsChunkGenerated](世界/地图.md#ischunkgenerated) | 服务端 | 获取某个区块是否生成过。 | | [IsSlimeChunk](世界/地图.md#isslimechunk) | 服务端 | 获取某个区块是否是史莱姆区块。 | -| [LocateNeteaseFeatureRule](世界/地图.md#locateneteasefeaturerule) | 服务端 | 与[/locate指令](https://minecraft-zh.gamepedia.com/%E5%91%BD%E4%BB%A4/locate)相似，用于定位网易自定义特征规则 | -| [LocateStructureFeature](世界/地图.md#locatestructurefeature) | 服务端 | 与[/locate指令](https://minecraft-zh.gamepedia.com/%E5%91%BD%E4%BB%A4/locate)相似，用于定位原版的部分结构，如海底神殿、末地城等。 | +| [LocateNeteaseFeatureRule](世界/地图.md#locateneteasefeaturerule) | 服务端 | 与[/locate指令](https://zh.minecraft.wiki/w/%E5%91%BD%E4%BB%A4/locate)相似，用于定位网易自定义特征规则 | +| [LocateStructureFeature](世界/地图.md#locatestructurefeature) | 服务端 | 与[/locate指令](https://zh.minecraft.wiki/w/%E5%91%BD%E4%BB%A4/locate)相似，用于定位原版的部分结构，如海底神殿、末地城等。 | | [MayPlace](世界/地图.md#mayplace) | 服务端 | 判断方块是否可以放置 | | [MayPlaceOn](世界/地图.md#mayplaceon) | 服务端 | 判断物品是否可以放到指定的位置上 | | [MirrorDimension](世界/地图.md#mirrordimension) | 服务端 | 复制不同dimension的地形 | | [OpenClientChunkGeneration](世界/地图.md#openclientchunkgeneration) | 服务端 | 开启/关闭客户端区块生成功能，需要在LoadServerAddonScriptsAfter事件触发时调用。开启客户端区块生成功能时，如果使用了netease:structure_feature或修改了大部分地图，会导致客户端和服务端地图不一致的问题。此时可以通过关闭客户端区块生成功能解决该问题。 | -| [PlaceFeature](世界/地图.md#placefeature) | 服务端 | 放置特征，与[/placefeature指令](https://minecraft.fandom.com/zh/wiki/%E5%91%BD%E4%BB%A4/placefeature)相似 | +| [PlaceFeature](世界/地图.md#placefeature) | 服务端 | 放置特征，与[/placefeature指令](https://zh.minecraft.wiki/w/%E5%91%BD%E4%BB%A4/placefeature)相似 | | [PlaceNeteaseLargeFeature](世界/地图.md#placeneteaselargefeature) | 服务端 | 放置网易版大型结构特征 | | [PlaceStructure](世界/地图.md#placestructure) | 服务端 | 放置结构 | | [SetAddArea](世界/地图.md#setaddarea) | 服务端 | 设置区块的常加载 | @@ -627,7 +631,7 @@ sidebarDepth: 1 | [SetMobStrengthMax](实体/属性.md#setmobstrengthmax) | 服务端 | 设置生物强度的最大值，截止至网易2.9版本，只对羊驼有效，强度越大羊驼驮运的箱子时格子数量越多，[SetMobStrength](实体/属性.md#setmobstrength)无法超过SetMobStrengthMax的值。由于引擎限制，在羊驼被打时候会reload组件，strengthMax会恢复成llama.json中的配置值(minecraft:strength) | | [SetName](实体/属性.md#setname) | 服务端 | 用于设置生物的自定义名称，跟原版命名牌作用相同，玩家和新版流浪商人暂不支持 | | [SetOutOfControl](实体/属性.md#setoutofcontrol) | 服务端 | 设置实体是否处于失控状态，截止至网易2.9版本，只对船有效 | -| [SetPersistent](实体/属性.md#setpersistent) | 服务端 | 设置实体不会因为离玩家太远而被[清除](https://minecraft.fandom.com/zh/wiki/%E7%94%9F%E6%88%90#.E5.9F.BA.E5.B2.A9.E7.89.88_2) | +| [SetPersistent](实体/属性.md#setpersistent) | 服务端 | 设置实体不会因为离玩家太远而被[清除](https://zh.minecraft.wiki/w/%E7%94%9F%E6%88%90#%E6%B8%85%E9%99%A4) | | [SetPlayerLookAtPos](实体/属性.md#setplayerlookatpos) | 客户端 | 设置本地玩家看向某个位置 | | [SetPos](实体/属性.md#setpos) | 服务端 | 设置实体位置 | | [SetRecoverTotalAirSupplyTime](实体/属性.md#setrecovertotalairsupplytime) | 服务端 | 设置恢复最大氧气量的时间，单位秒 | @@ -635,7 +639,7 @@ sidebarDepth: 1 | [SetRot](实体/属性.md#setrot) | 客户端 | 设置实体头与水平方向的俯仰角度和竖直方向的旋转角度 MC坐标系说明 | | [SetSheared](实体/属性.md#setsheared) | 服务端 | 设置实体是否被剃毛，截止至网易2.9版本，只对羊有效 | | [SetSitting](实体/属性.md#setsitting) | 服务端 | 设置生物是否坐下 | -| [SetSize](实体/属性.md#setsize) | 服务端 | 设置实体的包围盒 | +| [SetSize](实体/属性.md#setsize) | 服务端 | 设置实体的包围盒。设置过大会导致游戏卡顿。实体的scale的立方乘以包围盒的体积不可超过32768 | | [SetTradeLevel](实体/属性.md#settradelevel) | 服务端 | 设置村民的交易等级 | | [SetVariant](实体/属性.md#setvariant) | 服务端 | 设置实体的变种属性值 | | [isEntityInLava](实体/属性.md#isentityinlava) | 客户端 | 实体是否在岩浆中 | @@ -694,7 +698,7 @@ sidebarDepth: 1 | [SetEntityShareablesItems](实体/行为.md#setentityshareablesitems) | 服务端 | 设置生物可分享/可拾取的物品列表 | | [SetEntityTamed](实体/行为.md#setentitytamed) | 服务端 | 设置生物驯服，需要配合 entityEvent组件使用。该类驯服不包含骑乘功能。 | | [SetJumpPower](实体/行为.md#setjumppower) | 服务端 | 设置生物跳跃力度，0.42表示正常水平 | -| [SetLeashHolder](实体/行为.md#setleashholder) | 服务端 | 为实体添加牵引者，与原版拴绳的作用相同，详见基岩版栓绳介绍 | +| [SetLeashHolder](实体/行为.md#setleashholder) | 服务端 | 为实体添加牵引者，与原版拴绳的作用相同，详见基岩版栓绳介绍 | | [SetLootDropped](实体/行为.md#setlootdropped) | 服务端 | 设置生物是否生成掉落物 | | [SetMobKnockback](实体/行为.md#setmobknockback) | 服务端 | 设置击退的初始速度，需要考虑阻力的影响 | | [SetMotion](实体/行为.md#setmotion) | 服务端 | 设置生物（不含玩家）的瞬时移动方向向量 | @@ -864,6 +868,7 @@ sidebarDepth: 1 | [GetArmorValue](玩家/属性.md#getarmorvalue) | 客户端 | 获取玩家护甲值 | | [GetEnchantmentSeed](玩家/属性.md#getenchantmentseed) | 服务端 | 获取玩家的附魔种子，该种子会决定附魔台上准备附魔的装备的附魔项 | | [GetPlayerCurLevelExp](玩家/属性.md#getplayercurlevelexp) | 客户端 | 获取玩家当前等级需要的经验值 | +| [GetPlayerCurrentExhaustionValue](玩家/属性.md#getplayercurrentexhaustionvalue) | 服务端 | 获取玩家foodExhaustionLevel的当前消耗度。详见消耗度介绍 | | [GetPlayerExp](玩家/属性.md#getplayerexp) | 服务端 | 获取玩家当前等级下的经验值 | | [GetPlayerExp](玩家/属性.md#getplayerexp) | 客户端 | 获取玩家当前等级下的经验值 | | [GetPlayerHealthLevel](玩家/属性.md#getplayerhealthlevel) | 服务端 | 获取玩家健康临界值，当饥饿值大于等于健康临界值时会自动恢复血量，开启饥饿值且开启自然恢复时有效。原版默认值为18 | @@ -879,6 +884,7 @@ sidebarDepth: 1 | [IsPlayerNaturalRegen](玩家/属性.md#isplayernaturalregen) | 服务端 | 是否开启玩家自然恢复，当饥饿值大于等于健康临界值时会自动恢复血量，开启饥饿值且开启自然恢复时有效。原版默认开启 | | [IsPlayerNaturalStarve](玩家/属性.md#isplayernaturalstarve) | 服务端 | 是否开启玩家饥饿掉血，当饥饿值小于饥饿临界值时会自动恢复血量，开启饥饿值且开启饥饿掉血时有效。原版默认开启 | | [SetEnchantmentSeed](玩家/属性.md#setenchantmentseed) | 服务端 | 设置玩家的附魔种子，该种子会决定附魔台上准备附魔的装备的附魔项 | +| [SetPlayerCurrentExhaustionValue](玩家/属性.md#setplayercurrentexhaustionvalue) | 服务端 | 设置玩家foodExhaustionLevel的当前消耗度。详见消耗度介绍 | | [SetPlayerHealthLevel](玩家/属性.md#setplayerhealthlevel) | 服务端 | 设置玩家健康临界值，当饥饿值大于等于健康临界值时会自动恢复血量，开启饥饿值且开启自然恢复时有效.原版默认值为18 | | [SetPlayerHealthTick](玩家/属性.md#setplayerhealthtick) | 服务端 | 设置玩家自然恢复速度，当饥饿值大于等于健康临界值时会自动恢复血量，开启饥饿值且开启自然恢复时有效.原版默认值为80刻（即每4秒）恢复1点血量 | | [SetPlayerHunger](玩家/属性.md#setplayerhunger) | 服务端 | 设置玩家饥饿度。 | @@ -905,7 +911,7 @@ sidebarDepth: 1 | [EndSprinting](玩家/行为.md#endsprinting) | 客户端 | 使本地玩家结束向前疾跑/冲刺状态 | | [GetEntityRider](玩家/行为.md#getentityrider) | 服务端 | 获取骑乘者正在骑乘的实体的id。 | | [GetEntityRider](玩家/行为.md#getentityrider) | 客户端 | 获取骑乘者正在骑乘的实体的id。 | -| [GetInteracteCenterOffset](玩家/行为.md#getinteractecenteroffset) | 服务端 | 获取玩家[服务端交互中心](../../1-ModAPI/更新信息/2.8.md#玩家摄像机)的偏移 | +| [GetInteracteCenterOffset](玩家/行为.md#getinteractecenteroffset) | 服务端 | 获取玩家[服务端交互中心](玩家/../../更新信息/2.8.md#玩家摄像机)的偏移 | | [GetIsBlocking](玩家/行为.md#getisblocking) | 服务端 | 获取玩家激活盾牌状态 | | [GetPickCenterOffset](玩家/行为.md#getpickcenteroffset) | 客户端 | 获取玩家设置的第三人称下客户端交互中心的偏移 | | [GetPickRange](玩家/行为.md#getpickrange) | 客户端 | 获取玩家客户端的交互距离 | @@ -917,8 +923,8 @@ sidebarDepth: 1 | [GetPlayerRespawnPos](玩家/行为.md#getplayerrespawnpos) | 服务端 | 获取玩家复活点 | | [GetRelevantPlayer](玩家/行为.md#getrelevantplayer) | 服务端 | 获取附近玩家id列表 | | [IsEntityRiding](玩家/行为.md#isentityriding) | 服务端 | 检查玩家是否骑乘。 | -| [IsInScaffolding](玩家/行为.md#isinscaffolding) | 客户端 | 获取玩家是否与脚手架有交叉 | -| [IsOnLadder](玩家/行为.md#isonladder) | 客户端 | 获取玩家是否与梯子/藤蔓有交叉 | +| [IsInScaffolding](玩家/行为.md#isinscaffolding) | 客户端 | 获取玩家是否在脚手架中 | +| [IsOnLadder](玩家/行为.md#isonladder) | 客户端 | 获取玩家是否在梯子/藤蔓上 | | [IsPlayerCanFly](玩家/行为.md#isplayercanfly) | 服务端 | 获取玩家能否飞行 | | [IsPlayerFlying](玩家/行为.md#isplayerflying) | 服务端 | 获取玩家是否在飞行 | | [OpenWorkBench](玩家/行为.md#openworkbench) | 服务端 | 在玩家当前位置打开工作台UI，不依赖于工作台方块 | @@ -1389,7 +1395,7 @@ sidebarDepth: 1 | [SetAnimationBoneMask](模型.md#setanimationbonemask) | 客户端 | 设置是否屏蔽动画中指定的骨骼的动画，若开启骨骼屏蔽后，该骨骼将不再播放该动画中的动作。通过屏蔽指定骨骼的动画可实现同一个骨骼模型同时在不同骨骼上播放不同的动作动画，从而实现快捷的动作融合。 | | [SetBrightness](模型.md#setbrightness) | 客户端 | 设置实体的亮度 | | [SetEntityOpacity](模型.md#setentityopacity) | 客户端 | 设置骨骼模型的透明度，只能对骨骼模型生效，如果设置的是原版模型，则模型的影子会被隐藏。 | -| [SetEntityScale](模型.md#setentityscale) | 服务端 | 设置实体的放缩比例大小，设置比例过大会导致游戏卡顿，建议控制在20倍以内 | +| [SetEntityScale](模型.md#setentityscale) | 服务端 | 设置实体的放缩比例大小，设置比例过大会导致游戏卡顿，建议控制在20倍以内。实体的scale的立方乘以包围盒的体积不可超过32768 | | [SetEntityShadowShow](模型.md#setentityshadowshow) | 客户端 | 设置实体打开/关闭影子渲染 | | [SetExtraUniformValue](模型.md#setextrauniformvalue) | 客户端 | 设置shader中特定Uniform的值 | | [SetFreeModelAniSpeed](模型.md#setfreemodelanispeed) | 客户端 | 设置自由模型动画的播放速度 | @@ -1444,7 +1450,7 @@ sidebarDepth: 1 | [HideReportGUI](原生UI.md#hidereportgui) | 客户端 | 隐藏举报按钮原生UI。 | | [HideSlotBarGui](原生UI.md#hideslotbargui) | 客户端 | 隐藏游戏中底部中间的物品栏界面 | | [HideSneakGui](原生UI.md#hidesneakgui) | 客户端 | 隐藏游戏中左下角方向键的中心处潜行按钮。隐藏后点击相应位置不会响应 | -| [HideSwimGui](原生UI.md#hideswimgui) | 客户端 | 隐藏游戏中的浮潜按钮。隐藏后点击相应位置不会响应。仅影响十字键操作下的浮潜按钮，摇杆模式上浮=跳跃，下潜=潜行，需要通过HideJumpGui和HideSneakGui来隐藏 | +| [HideSwimGui](原生UI.md#hideswimgui) | 客户端 | 隐藏游戏中的浮潜按钮。隐藏后点击相应位置不会响应。 | | [HideVoiceGUI](原生UI.md#hidevoicegui) | 客户端 | 隐藏语音按钮原生UI。该接口在开启新版聊天时不生效 | | [HideWalkGui](原生UI.md#hidewalkgui) | 客户端 | 隐藏游戏中跑/走按钮。隐藏后点击相应位置不会响应 | | [OpenChatGui](原生UI.md#openchatgui) | 客户端 | 打开原版聊天栏 | @@ -1579,6 +1585,7 @@ sidebarDepth: 1 | [GetOrientation](自定义UI/UI控件.md#getorientation) | 客户端 | 获取stackPanel的排列方向 | | [GetPath](自定义UI/UI控件.md#getpath) | 客户端 | 返回当前控件的相对路径，路径从画布节点开始算起 | | [GetPosition](自定义UI/UI控件.md#getposition) | 客户端 | 获取控件相对父节点的坐标 | +| [GetPropertyBag](自定义UI/UI控件.md#getpropertybag) | 客户端 | 获取PropertyBag | | [GetRotateAngle](自定义UI/UI控件.md#getrotateangle) | 客户端 | 获取图片相对自身的旋转锚点旋转的角度 | | [GetRotatePivot](自定义UI/UI控件.md#getrotatepivot) | 客户端 | 获取图片相对自身的旋转锚点 | | [GetRotateRect](自定义UI/UI控件.md#getrotaterect) | 客户端 | 获取图片当前的四个边角点 | @@ -1653,6 +1660,7 @@ sidebarDepth: 1 | [SetOffsetDelta](自定义UI/UI控件.md#setoffsetdelta) | 客户端 | 设置点击面板的拖拽偏移量 | | [SetOrientation](自定义UI/UI控件.md#setorientation) | 客户端 | 设置stackPanel的排列方向 | | [SetPosition](自定义UI/UI控件.md#setposition) | 客户端 | 设置控件相对父节点的坐标 | +| [SetPropertyBag](自定义UI/UI控件.md#setpropertybag) | 客户端 | 设置PropertyBag,将使用字典中的每个值来覆盖原本PropertyBag中的值 | | [SetRotatePivot](自定义UI/UI控件.md#setrotatepivot) | 客户端 | 设置图片自身旋转锚点，该点并不是固定的点，而是相对于自身位置的点 | | [SetScrollViewPercentValue](自定义UI/UI控件.md#setscrollviewpercentvalue) | 客户端 | 设置当前scroll_view内容的百分比位置 | | [SetScrollViewPos](自定义UI/UI控件.md#setscrollviewpos) | 客户端 | 设置当前scroll_view内容的位置 | diff --git a/docs/mcdocs/1-ModAPI/接口/世界/地图.md b/docs/mcdocs/1-ModAPI/接口/世界/地图.md index 0d0b134c..92fd0ace 100644 --- a/docs/mcdocs/1-ModAPI/接口/世界/地图.md +++ b/docs/mcdocs/1-ModAPI/接口/世界/地图.md @@ -202,7 +202,7 @@ method in mod.server.component.explosionCompServer.ExplosionComponentServer | 参数名 |
数据类型
| 说明 | | :--- | :--- | :--- | | pos | tuple(float,float,float) | 爆炸位置 | - | radius | int | 爆炸威力，具体含义可参考[wiki](https://minecraft-zh.gamepedia.com/%E7%88%86%E7%82%B8)对爆炸的解释 | + | radius | int | 爆炸威力，具体含义可参考[wiki](https://zh.minecraft.wiki/w/%E7%88%86%E7%82%B8)对爆炸的解释 | | fire | bool | 是否带火 | | breaks | bool | 是否破坏方块 | | sourceId | str | 爆炸伤害源的实体id | @@ -1344,7 +1344,7 @@ method in mod.server.component.featureCompServer.FeatureCompServer - 描述 - 与[/locate指令](https://minecraft-zh.gamepedia.com/%E5%91%BD%E4%BB%A4/locate)相似，用于定位网易自定义特征规则 + 与[/locate指令](https://zh.minecraft.wiki/w/%E5%91%BD%E4%BB%A4/locate)相似，用于定位网易自定义特征规则 - 参数 @@ -1384,7 +1384,7 @@ method in mod.server.component.featureCompServer.FeatureCompServer - 描述 - 与[/locate指令](https://minecraft-zh.gamepedia.com/%E5%91%BD%E4%BB%A4/locate)相似，用于定位原版的部分结构，如海底神殿、末地城等。 + 与[/locate指令](https://zh.minecraft.wiki/w/%E5%91%BD%E4%BB%A4/locate)相似，用于定位原版的部分结构，如海底神殿、末地城等。 - 参数 @@ -1566,7 +1566,7 @@ method in mod.server.component.gameCompServer.GameComponentServer - 描述 - 放置特征，与[/placefeature指令](https://minecraft.fandom.com/zh/wiki/%E5%91%BD%E4%BB%A4/placefeature)相似 + 放置特征，与[/placefeature指令](https://zh.minecraft.wiki/w/%E5%91%BD%E4%BB%A4/placefeature)相似 - 参数 @@ -1706,7 +1706,7 @@ method in mod.server.component.chunkSourceComp.ChunkSourceCompServer - 备注 - key必须唯一，若添加区域时key已存在将添加失败。 - - 该方式创建的常加载区域不会tick，即实体，方块实体，随机刻都不会进行更新。若需要区域被tick，请使用原版[tickingarea指令](https://minecraft-zh.gamepedia.com/%E5%91%BD%E4%BB%A4/tickingarea)。 + - 该方式创建的常加载区域不会tick，即实体，方块实体，随机刻都不会进行更新。若需要区域被tick，请使用原版[tickingarea指令](https://zh.minecraft.wiki/w/%E5%91%BD%E4%BB%A4/tickingarea)。 - 将当前未加载的区块设置为常加载区块时，不会从存档加载生物。但如果是当前已加载的区块，则玩家远离区块后，区块内的实体会一直保持加载。 - 常加载区块内可以使用api创建实体、放置方块、放置结构、修改方块实体数据。 - 由于区块加载算法的特性，不保证最小到最大坐标的区块完全加载并可用（即CheckChunkState接口返回True），建议将操作位置的四周外延80格的区域都设置为常加载，例如需要在(0,5,0)的位置生成生物/放置方块，需要将(-80,0,-80)到(80,0,80)的区域设置为常加载。 @@ -1942,11 +1942,11 @@ method in mod.server.component.gameCompServer.GameComponentServer - 备注 - 同时设置dimensionId与pos时，出生点被设置在对应维度的对应坐标。 - 只设置dimensionId，而pos为None时，出生点设置为对应维度，而坐标将通过[基岩版世界生成搜索](https://minecraft.fandom.com/zh/wiki/%E7%94%9F%E6%88%90#.E5.9F.BA.E5.B2.A9.E7.89.88.E4.B8.96.E7.95.8C.E7.94.9F.E6.88.90.E6.90.9C.E7.B4.A2)决定。 + 只设置dimensionId，而pos为None时，出生点设置为对应维度，而坐标将通过[基岩版世界生成搜索](https://zh.minecraft.wiki/w/%E7%94%9F%E6%88%90#%E7%8E%A9%E5%AE%B6%E7%94%9F%E6%88%90)决定。 只设置pos，而dimensionId为None，则出生点设置为当前出生维度的对应坐标，与setworldspawn指令相同。 - 将pos的y轴设置为65535，表示出生到xz坐标轴的最高实心方块上。 - 当出生维度的类型是地狱和末地时，不会像主世界一样寻找一个安全的位置出生。 - - 关于世界出生点与个人出生点的规则，详见[玩家的生成](https://minecraft.fandom.com/zh/wiki/%E7%94%9F%E6%88%90#.E7.8E.A9.E5.AE.B6.E7.9A.84.E7.94.9F.E6.88.90) + - 关于世界出生点与个人出生点的规则，详见[玩家的生成](https://zh.minecraft.wiki/w/%E7%94%9F%E6%88%90#%E7%8E%A9%E5%AE%B6%E7%94%9F%E6%88%90) - 注意:如果和/spawnpoint一起使用，则/spawnpoint的优先级更高，SetSpawnDimensionAndPosition将失效 - 示例 diff --git a/docs/mcdocs/1-ModAPI/接口/世界/实体管理.md b/docs/mcdocs/1-ModAPI/接口/世界/实体管理.md index 821a442a..5ce28197 100644 --- a/docs/mcdocs/1-ModAPI/接口/世界/实体管理.md +++ b/docs/mcdocs/1-ModAPI/接口/世界/实体管理.md @@ -713,7 +713,7 @@ method in mod.server.component.gameCompServer.GameComponentServer - 备注 - 注意，如果检测的实体所在的区块被卸载，则该接口返回False。因此，需要注意实体所在的区块是否被加载。 - - 区块卸载：游戏只会加载玩家周围的区块，玩家移动到别的区域时，原来所在区域的区块会被卸载，参考[区块介绍](https://minecraft-zh.gamepedia.com/%E5%8C%BA%E5%9D%97) + - 区块卸载：游戏只会加载玩家周围的区块，玩家移动到别的区域时，原来所在区域的区块会被卸载，参考[区块介绍](https://zh.minecraft.wiki/w/%E5%8C%BA%E5%9D%97) - 示例 @@ -748,7 +748,7 @@ method in mod.client.component.gameCompClient.GameComponentClient - 备注 - 注意，如果检测的实体所在的区块被卸载，则该接口返回False。因此，需要注意实体所在的区块是否被加载。 - - 区块卸载：游戏只会加载玩家周围的区块，玩家移动到别的区域时，原来所在区域的区块会被卸载，参考[区块介绍](https://minecraft-zh.gamepedia.com/%E5%8C%BA%E5%9D%97) + - 区块卸载：游戏只会加载玩家周围的区块，玩家移动到别的区域时，原来所在区域的区块会被卸载，参考[区块介绍](https://zh.minecraft.wiki/w/%E5%8C%BA%E5%9D%97) - 示例 @@ -886,9 +886,10 @@ method in mod.server.component.blockInfoCompServer.BlockInfoComponentServer | pos | tuple(int,int,int) | 掉落位置 | | aux | int | 方块的附加值 | | probability | float | 掉落概率，范围为[0, 1]，0为不掉落，1为100%掉落 | - | bonusLootLevel | int | [时运等级](https://minecraft-zh.gamepedia.com/时运)，默认为0 | + | bonusLootLevel | int | [时运等级](https://zh.minecraft.wiki/w/时运)，默认为0 | | dimensionId | int | 掉落方块的维度，默认值为-1，传入非负值时用于获取产生方块掉落的维度；否则将随机挑选一个存在玩家的维度产生掉落 | | allowRandomness | bool | 是否允许随机采集，默认为True，如果为False，掉落概率probability无效 | + | spawnOrb | bool | 是否生成经验球，默认都不生成，设成True时按原版采集逻辑进行经验球掉落，如矿石类方块会产生随机数量的经验球 | - 返回值 diff --git a/docs/mcdocs/1-ModAPI/接口/世界/方块管理.md b/docs/mcdocs/1-ModAPI/接口/世界/方块管理.md index 69bc4ef1..fab63fa3 100644 --- a/docs/mcdocs/1-ModAPI/接口/世界/方块管理.md +++ b/docs/mcdocs/1-ModAPI/接口/世界/方块管理.md @@ -446,7 +446,7 @@ method in mod.server.component.blockInfoCompServer.BlockInfoComponentServer | oldBlockHandling | int | 0：替换，1：销毁，2：保留，默认为0 | | dimensionId | int | 方块所在维度，必需参数 | | isLegacy | bool | 是否设置为传统的aux，建议设置为True，即aux对应的state不随着版本迭代而变化。默认为False | - | updateNeighbors | bool | 是否给相邻的方块触发[方块更新](https://minecraft.fandom.com/zh/wiki/%E6%96%B9%E5%9D%97%E6%9B%B4%E6%96%B0?variant=zh)以及BlockNeighborChangedServerEvent事件。默认为True触发。若选择不触发可节省约30%的性能消耗。 | + | updateNeighbors | bool | 是否给相邻的方块触发[方块更新](https://zh.minecraft.wiki/w/%E6%96%B9%E5%9D%97%E6%9B%B4%E6%96%B0)以及BlockNeighborChangedServerEvent事件。默认为True触发。若选择不触发可节省约30%的性能消耗。 | - 返回值 diff --git a/docs/mcdocs/1-ModAPI/接口/世界/消息.md b/docs/mcdocs/1-ModAPI/接口/世界/消息.md index 4afac65d..3e7d0d5c 100644 --- a/docs/mcdocs/1-ModAPI/接口/世界/消息.md +++ b/docs/mcdocs/1-ModAPI/接口/世界/消息.md @@ -19,7 +19,7 @@ method in mod.server.component.msgCompServer.MsgComponentServer | :--- | :--- | :--- | | playerId | str | 指定玩家id | | msg | str | 消息内容 | - | color | str | 颜色样式代码字符串，可参考wiki[样式代码](https://minecraft-zh.gamepedia.com/%E6%A0%B7%E5%BC%8F%E4%BB%A3%E7%A0%81)，默认为白色 | + | color | str | 颜色样式代码字符串，可参考wiki[样式代码](https://zh.minecraft.wiki/w/%E6%A0%BC%E5%BC%8F%E5%8C%96%E4%BB%A3%E7%A0%81)，默认为白色 | - 返回值 diff --git a/docs/mcdocs/1-ModAPI/接口/世界/索引.md b/docs/mcdocs/1-ModAPI/接口/世界/索引.md index eb5e9d49..4e827d8c 100644 --- a/docs/mcdocs/1-ModAPI/接口/世界/索引.md +++ b/docs/mcdocs/1-ModAPI/接口/世界/索引.md @@ -60,13 +60,13 @@ sidebarDepth: 1 | [GetStructureSize](地图.md#getstructuresize) | 服务端 | 获取结构体的长宽高 | | [IsChunkGenerated](地图.md#ischunkgenerated) | 服务端 | 获取某个区块是否生成过。 | | [IsSlimeChunk](地图.md#isslimechunk) | 服务端 | 获取某个区块是否是史莱姆区块。 | -| [LocateNeteaseFeatureRule](地图.md#locateneteasefeaturerule) | 服务端 | 与[/locate指令](https://minecraft-zh.gamepedia.com/%E5%91%BD%E4%BB%A4/locate)相似，用于定位网易自定义特征规则 | -| [LocateStructureFeature](地图.md#locatestructurefeature) | 服务端 | 与[/locate指令](https://minecraft-zh.gamepedia.com/%E5%91%BD%E4%BB%A4/locate)相似，用于定位原版的部分结构，如海底神殿、末地城等。 | +| [LocateNeteaseFeatureRule](地图.md#locateneteasefeaturerule) | 服务端 | 与[/locate指令](https://zh.minecraft.wiki/w/%E5%91%BD%E4%BB%A4/locate)相似，用于定位网易自定义特征规则 | +| [LocateStructureFeature](地图.md#locatestructurefeature) | 服务端 | 与[/locate指令](https://zh.minecraft.wiki/w/%E5%91%BD%E4%BB%A4/locate)相似，用于定位原版的部分结构，如海底神殿、末地城等。 | | [MayPlace](地图.md#mayplace) | 服务端 | 判断方块是否可以放置 | | [MayPlaceOn](地图.md#mayplaceon) | 服务端 | 判断物品是否可以放到指定的位置上 | | [MirrorDimension](地图.md#mirrordimension) | 服务端 | 复制不同dimension的地形 | | [OpenClientChunkGeneration](地图.md#openclientchunkgeneration) | 服务端 | 开启/关闭客户端区块生成功能，需要在LoadServerAddonScriptsAfter事件触发时调用。开启客户端区块生成功能时，如果使用了netease:structure_feature或修改了大部分地图，会导致客户端和服务端地图不一致的问题。此时可以通过关闭客户端区块生成功能解决该问题。 | -| [PlaceFeature](地图.md#placefeature) | 服务端 | 放置特征，与[/placefeature指令](https://minecraft.fandom.com/zh/wiki/%E5%91%BD%E4%BB%A4/placefeature)相似 | +| [PlaceFeature](地图.md#placefeature) | 服务端 | 放置特征，与[/placefeature指令](https://zh.minecraft.wiki/w/%E5%91%BD%E4%BB%A4/placefeature)相似 | | [PlaceNeteaseLargeFeature](地图.md#placeneteaselargefeature) | 服务端 | 放置网易版大型结构特征 | | [PlaceStructure](地图.md#placestructure) | 服务端 | 放置结构 | | [SetAddArea](地图.md#setaddarea) | 服务端 | 设置区块的常加载 | diff --git a/docs/mcdocs/1-ModAPI/接口/原生UI.md b/docs/mcdocs/1-ModAPI/接口/原生UI.md index 73daa316..4bb1035a 100644 --- a/docs/mcdocs/1-ModAPI/接口/原生UI.md +++ b/docs/mcdocs/1-ModAPI/接口/原生UI.md @@ -37,7 +37,7 @@ sidebarDepth: 1 | [HideReportGUI](原生UI.md#hidereportgui) | 客户端 | 隐藏举报按钮原生UI。 | | [HideSlotBarGui](原生UI.md#hideslotbargui) | 客户端 | 隐藏游戏中底部中间的物品栏界面 | | [HideSneakGui](原生UI.md#hidesneakgui) | 客户端 | 隐藏游戏中左下角方向键的中心处潜行按钮。隐藏后点击相应位置不会响应 | -| [HideSwimGui](原生UI.md#hideswimgui) | 客户端 | 隐藏游戏中的浮潜按钮。隐藏后点击相应位置不会响应。仅影响十字键操作下的浮潜按钮，摇杆模式上浮=跳跃，下潜=潜行，需要通过HideJumpGui和HideSneakGui来隐藏 | +| [HideSwimGui](原生UI.md#hideswimgui) | 客户端 | 隐藏游戏中的浮潜按钮。隐藏后点击相应位置不会响应。 | | [HideVoiceGUI](原生UI.md#hidevoicegui) | 客户端 | 隐藏语音按钮原生UI。该接口在开启新版聊天时不生效 | | [HideWalkGui](原生UI.md#hidewalkgui) | 客户端 | 隐藏游戏中跑/走按钮。隐藏后点击相应位置不会响应 | | [OpenChatGui](原生UI.md#openchatgui) | 客户端 | 打开原版聊天栏 | @@ -871,7 +871,7 @@ method in mod.client.extraClientApi - 描述 - 隐藏游戏中的浮潜按钮。隐藏后点击相应位置不会响应。仅影响十字键操作下的浮潜按钮，摇杆模式上浮=跳跃，下潜=潜行，需要通过HideJumpGui和HideSneakGui来隐藏 + 隐藏游戏中的浮潜按钮。隐藏后点击相应位置不会响应。 - 参数 diff --git a/docs/mcdocs/1-ModAPI/接口/实体/属性.md b/docs/mcdocs/1-ModAPI/接口/实体/属性.md index 3e12fe3f..829d7424 100644 --- a/docs/mcdocs/1-ModAPI/接口/实体/属性.md +++ b/docs/mcdocs/1-ModAPI/接口/实体/属性.md @@ -1508,7 +1508,7 @@ method in mod.server.component.entityDefinitionsCompServer.EntityDefinitionsComp | bool | 是否为自然生成的，调用失败返回None | - 备注 - - 一些自然生成的生物拥有持久性（例如末影龙、随大型结构生成的生物），则IsNaturallySpawned会返回False，详见基岩版持久性生物介绍 + - 一些自然生成的生物拥有持久性（例如末影龙、随大型结构生成的生物），则IsNaturallySpawned会返回False，详见基岩版持久性生物介绍 - 示例 @@ -2452,7 +2452,7 @@ method in mod.server.component.attrCompServer.AttrCompServer - 描述 - 设置实体不会因为离玩家太远而被[清除](https://minecraft.fandom.com/zh/wiki/%E7%94%9F%E6%88%90#.E5.9F.BA.E5.B2.A9.E7.89.88_2) + 设置实体不会因为离玩家太远而被[清除](https://zh.minecraft.wiki/w/%E7%94%9F%E6%88%90#%E6%B8%85%E9%99%A4) - 参数 @@ -2532,7 +2532,7 @@ method in mod.server.component.posCompServer.PosComponentServer | 参数名 |
数据类型
| 说明 | | :--- | :--- | :--- | - | pos | tuple(int,int,int) | xyz值 | + | pos | tuple(float,float,float) | xyz值 | - 返回值 @@ -2735,7 +2735,7 @@ method in mod.server.component.collisionBoxCompServer.CollisionBoxComponentServe - 描述 - 设置实体的包围盒 + 设置实体的包围盒。设置过大会导致游戏卡顿。实体的scale的立方乘以包围盒的体积不可超过32768 - 参数 diff --git a/docs/mcdocs/1-ModAPI/接口/实体/渲染.md b/docs/mcdocs/1-ModAPI/接口/实体/渲染.md index 963e4779..92f6d716 100644 --- a/docs/mcdocs/1-ModAPI/接口/实体/渲染.md +++ b/docs/mcdocs/1-ModAPI/接口/实体/渲染.md @@ -474,6 +474,7 @@ method in mod.client.component.actorRenderCompClient.ActorRenderCompClient | bool | 是否成功 | - 备注 + - 调用该接口后需要调用[RebuildRenderForOneActor](#rebuildrenderforoneactor)才会生效 - 某些动画资源可能用到了molang表达式，在添加动画时请务必确保这些molang表达式也存在。 - 示例 @@ -658,6 +659,9 @@ method in mod.client.component.actorRenderCompClient.ActorRenderCompClient | :--- | :--- | | bool | 是否成功 | +- 备注 + - 调用该接口后需要调用[RebuildRenderForOneActor](#rebuildrenderforoneactor)才会生效 + - 示例 ```python @@ -1104,6 +1108,7 @@ method in mod.client.component.actorRenderCompClient.ActorRenderCompClient | :--- | :--- | :--- | | entityId | str | 实体Id | | paramTypeStr | str | 渲染参数类型，可选类型有"textures","geometry","materials","animations","render_controllers","particle_effects","sound_effects" | + | getValue | bool | 是否获取详细值，默认为False。该参数对render_controllers无效 | - 返回值 @@ -1111,6 +1116,9 @@ method in mod.client.component.actorRenderCompClient.ActorRenderCompClient | :--- | :--- | | list(str) | 参数列表，如获取失败则返回None | +- 备注 + - 无法用于获取Player的ColorTexture + - 示例 ```python diff --git a/docs/mcdocs/1-ModAPI/接口/实体/索引.md b/docs/mcdocs/1-ModAPI/接口/实体/索引.md index ad20fe4f..24da6ddd 100644 --- a/docs/mcdocs/1-ModAPI/接口/实体/索引.md +++ b/docs/mcdocs/1-ModAPI/接口/实体/索引.md @@ -119,7 +119,7 @@ sidebarDepth: 1 | [SetMobStrengthMax](属性.md#setmobstrengthmax) | 服务端 | 设置生物强度的最大值，截止至网易2.9版本，只对羊驼有效，强度越大羊驼驮运的箱子时格子数量越多，[SetMobStrength](属性.md#setmobstrength)无法超过SetMobStrengthMax的值。由于引擎限制，在羊驼被打时候会reload组件，strengthMax会恢复成llama.json中的配置值(minecraft:strength) | | [SetName](属性.md#setname) | 服务端 | 用于设置生物的自定义名称，跟原版命名牌作用相同，玩家和新版流浪商人暂不支持 | | [SetOutOfControl](属性.md#setoutofcontrol) | 服务端 | 设置实体是否处于失控状态，截止至网易2.9版本，只对船有效 | -| [SetPersistent](属性.md#setpersistent) | 服务端 | 设置实体不会因为离玩家太远而被[清除](https://minecraft.fandom.com/zh/wiki/%E7%94%9F%E6%88%90#.E5.9F.BA.E5.B2.A9.E7.89.88_2) | +| [SetPersistent](属性.md#setpersistent) | 服务端 | 设置实体不会因为离玩家太远而被[清除](https://zh.minecraft.wiki/w/%E7%94%9F%E6%88%90#%E6%B8%85%E9%99%A4) | | [SetPlayerLookAtPos](属性.md#setplayerlookatpos) | 客户端 | 设置本地玩家看向某个位置 | | [SetPos](属性.md#setpos) | 服务端 | 设置实体位置 | | [SetRecoverTotalAirSupplyTime](属性.md#setrecovertotalairsupplytime) | 服务端 | 设置恢复最大氧气量的时间，单位秒 | @@ -127,7 +127,7 @@ sidebarDepth: 1 | [SetRot](属性.md#setrot) | 客户端 | 设置实体头与水平方向的俯仰角度和竖直方向的旋转角度 MC坐标系说明 | | [SetSheared](属性.md#setsheared) | 服务端 | 设置实体是否被剃毛，截止至网易2.9版本，只对羊有效 | | [SetSitting](属性.md#setsitting) | 服务端 | 设置生物是否坐下 | -| [SetSize](属性.md#setsize) | 服务端 | 设置实体的包围盒 | +| [SetSize](属性.md#setsize) | 服务端 | 设置实体的包围盒。设置过大会导致游戏卡顿。实体的scale的立方乘以包围盒的体积不可超过32768 | | [SetTradeLevel](属性.md#settradelevel) | 服务端 | 设置村民的交易等级 | | [SetVariant](属性.md#setvariant) | 服务端 | 设置实体的变种属性值 | | [isEntityInLava](属性.md#isentityinlava) | 客户端 | 实体是否在岩浆中 | @@ -188,7 +188,7 @@ sidebarDepth: 1 | [SetEntityShareablesItems](行为.md#setentityshareablesitems) | 服务端 | 设置生物可分享/可拾取的物品列表 | | [SetEntityTamed](行为.md#setentitytamed) | 服务端 | 设置生物驯服，需要配合 entityEvent组件使用。该类驯服不包含骑乘功能。 | | [SetJumpPower](行为.md#setjumppower) | 服务端 | 设置生物跳跃力度，0.42表示正常水平 | -| [SetLeashHolder](行为.md#setleashholder) | 服务端 | 为实体添加牵引者，与原版拴绳的作用相同，详见基岩版栓绳介绍 | +| [SetLeashHolder](行为.md#setleashholder) | 服务端 | 为实体添加牵引者，与原版拴绳的作用相同，详见基岩版栓绳介绍 | | [SetLootDropped](行为.md#setlootdropped) | 服务端 | 设置生物是否生成掉落物 | | [SetMobKnockback](行为.md#setmobknockback) | 服务端 | 设置击退的初始速度，需要考虑阻力的影响 | | [SetMotion](行为.md#setmotion) | 服务端 | 设置生物（不含玩家）的瞬时移动方向向量 | diff --git a/docs/mcdocs/1-ModAPI/接口/实体/行为.md b/docs/mcdocs/1-ModAPI/接口/实体/行为.md index b4bb1180..9c469116 100644 --- a/docs/mcdocs/1-ModAPI/接口/实体/行为.md +++ b/docs/mcdocs/1-ModAPI/接口/实体/行为.md @@ -1951,7 +1951,7 @@ method in mod.server.component.entityDefinitionsCompServer.EntityDefinitionsComp - 描述 - 为实体添加牵引者，与原版拴绳的作用相同，详见基岩版栓绳介绍 + 为实体添加牵引者，与原版拴绳的作用相同，详见基岩版栓绳介绍 - 参数 diff --git a/docs/mcdocs/1-ModAPI/接口/方块/方块实体.md b/docs/mcdocs/1-ModAPI/接口/方块/方块实体.md index e96931e3..c3471e6a 100644 --- a/docs/mcdocs/1-ModAPI/接口/方块/方块实体.md +++ b/docs/mcdocs/1-ModAPI/接口/方块/方块实体.md @@ -234,7 +234,7 @@ method in mod.server.component.blockInfoCompServer.BlockInfoComponentServer - 备注 - 随着版本更迭，方块中包含的数据结构可能被微软团队调整，并且不会公告，使用该接口的开发者需注意版本更新时做好测试和兼容。数据编码为UTF-8 - 适用于：[方块实体](https://minecraft-zh.gamepedia.com/%E6%96%B9%E5%9D%97%E5%AE%9E%E4%BD%93) + 适用于：[方块实体](https://zh.minecraft.wiki/w/%E6%96%B9%E5%9D%97%E5%AE%9E%E4%BD%93) 特殊情况：末影箱的物品信息不能通过该接口获取 - 需要注意的是，由于该接口获取的是包含原版nbttag及自定义方块的数据，为了兼容原版nbttag，Python对象在获取出来时，会做一定的转换，如： None -> {"__type__" : 1, "__value__": 2} @@ -273,7 +273,7 @@ method in mod.client.component.blockInfoCompClient.BlockInfoComponentClient - 备注 - 随着版本更迭，方块中包含的数据结构可能被微软团队调整，并且不会公告，使用该接口的开发者需注意版本更新时做好测试和兼容。数据编码为UTF-8 - 适用于：[方块实体](https://minecraft-zh.gamepedia.com/%E6%96%B9%E5%9D%97%E5%AE%9E%E4%BD%93) + 适用于：[方块实体](https://zh.minecraft.wiki/w/%E6%96%B9%E5%9D%97%E5%AE%9E%E4%BD%93) 特殊情况：末影箱的物品信息不能通过该接口获取 - 需要注意的是，由于该接口获取的是包含原版nbttag及自定义方块的数据，为了兼容原版nbttag，Python对象在获取出来时，会做一定的转换，如： None -> {"__type__" : 1, "__value__": 2} @@ -761,7 +761,7 @@ method in mod.server.component.blockInfoCompServer.BlockInfoComponentServer - 备注 - 随着版本更迭，方块中包含的数据结构可能被微软团队调整，并且不会公告，使用该接口的开发者需注意版本更新时做好测试和兼容。数据编码为UTF-8 - 适用于：[方块实体](https://minecraft-zh.gamepedia.com/%E6%96%B9%E5%9D%97%E5%AE%9E%E4%BD%93) + 适用于：[方块实体](https://zh.minecraft.wiki/w/%E6%96%B9%E5%9D%97%E5%AE%9E%E4%BD%93) 特殊情况：末影箱的物品信息不能通过该接口设置 注意：面向、状态等数据修改只会影响方块实体的数据，不会影响方块的渲染表现 切记：如果忽略游戏原有规则随意修改nbt数据，可能会导致bug或游戏崩溃 diff --git a/docs/mcdocs/1-ModAPI/接口/模型.md b/docs/mcdocs/1-ModAPI/接口/模型.md index 4e4aadf7..4251cd2c 100644 --- a/docs/mcdocs/1-ModAPI/接口/模型.md +++ b/docs/mcdocs/1-ModAPI/接口/模型.md @@ -46,7 +46,7 @@ sidebarDepth: 1 | [SetAnimationBoneMask](模型.md#setanimationbonemask) | 客户端 | 设置是否屏蔽动画中指定的骨骼的动画，若开启骨骼屏蔽后，该骨骼将不再播放该动画中的动作。通过屏蔽指定骨骼的动画可实现同一个骨骼模型同时在不同骨骼上播放不同的动作动画，从而实现快捷的动作融合。 | | [SetBrightness](模型.md#setbrightness) | 客户端 | 设置实体的亮度 | | [SetEntityOpacity](模型.md#setentityopacity) | 客户端 | 设置骨骼模型的透明度，只能对骨骼模型生效，如果设置的是原版模型，则模型的影子会被隐藏。 | -| [SetEntityScale](模型.md#setentityscale) | 服务端 | 设置实体的放缩比例大小，设置比例过大会导致游戏卡顿，建议控制在20倍以内 | +| [SetEntityScale](模型.md#setentityscale) | 服务端 | 设置实体的放缩比例大小，设置比例过大会导致游戏卡顿，建议控制在20倍以内。实体的scale的立方乘以包围盒的体积不可超过32768 | | [SetEntityShadowShow](模型.md#setentityshadowshow) | 客户端 | 设置实体打开/关闭影子渲染 | | [SetExtraUniformValue](模型.md#setextrauniformvalue) | 客户端 | 设置shader中特定Uniform的值 | | [SetFreeModelAniSpeed](模型.md#setfreemodelanispeed) | 客户端 | 设置自由模型动画的播放速度 | @@ -1375,7 +1375,7 @@ method in mod.server.component.scaleCompServer.ScaleComponentServer - 描述 - 设置实体的放缩比例大小，设置比例过大会导致游戏卡顿，建议控制在20倍以内 + 设置实体的放缩比例大小，设置比例过大会导致游戏卡顿，建议控制在20倍以内。实体的scale的立方乘以包围盒的体积不可超过32768 - 参数 diff --git a/docs/mcdocs/1-ModAPI/接口/物品.md b/docs/mcdocs/1-ModAPI/接口/物品.md index 73394458..32975132 100644 --- a/docs/mcdocs/1-ModAPI/接口/物品.md +++ b/docs/mcdocs/1-ModAPI/接口/物品.md @@ -334,6 +334,7 @@ method in mod.server.component.itemCompServer.ItemCompServer | itemCategory |str| 创造栏分类 | | itemType |str| 物品类型 | | customItemType |str| 自定义物品类型 | + | tags | list(str) | 物品的tags列表，如['minecraft:is_food'] | customTips |str| 自定义物品/方块tips | | itemTierLevel |int| 工具等级 | | fuelDuration |float| 燃料时长 | @@ -344,6 +345,7 @@ method in mod.server.component.itemCompServer.ItemCompServer | armorSlot |int| 防具槽位 | | armorToughness |int| 防具韧性 | | armorKnockbackResistance |float| 防具击退抗性 | + | enchant_slot_type |int| 附魔槽位枚举标志 自定义附魔文档 - 部分原版物品较为特殊，获取不到个别字段的返回值 方块类燃料获取不到燃料时长，弓、弩获取不到武器攻击力，蛋糕获取不到营养值和饱食度，马铠获取不到防具防御力，上述物品获取对应字段返回值为0 - 创造栏分类说明 @@ -392,7 +394,9 @@ method in mod.server.component.itemCompServer.ItemCompServer ```python import mod.server.extraServerApi as serverApi comp = serverApi.GetEngineCompFactory().CreateItem(levelId) -comp.GetItemBasicInfo("minecraft:bow") +info = comp.GetItemBasicInfo("minecraft:bow") +enchant_slot_type = info["enchant_slot_type"] +support_sword = (enchant_slot_type & EnchantSlotType.SWORD) > 0 ``` @@ -432,6 +436,7 @@ method in mod.client.component.itemCompClient.ItemCompClient | itemCategory |str| 创造栏分类 | | itemType |str| 物品类型 | | customItemType |str| 自定义物品类型 | + | tags | list(str) | 物品的tags列表，如['minecraft:is_food'] | customTips |str| 自定义物品/方块tips | | itemTierLevel |int| 工具等级 | | fuelDuration |float| 燃料时长 | @@ -442,6 +447,7 @@ method in mod.client.component.itemCompClient.ItemCompClient | armorSlot |int| 防具槽位 | | armorToughness |int| 防具韧性 | | armorKnockbackResistance |float| 防具击退抗性 | + | enchant_slot_type |int| 附魔槽位枚举标志 自定义附魔文档 - 部分原版物品较为特殊，获取不到个别字段的返回值 方块类燃料获取不到燃料时长，弓、弩获取不到武器攻击力，蛋糕获取不到营养值和饱食度，马铠获取不到防具防御力，上述物品获取对应字段返回值为0 - id_aux字段的示例： @@ -514,7 +520,9 @@ method in mod.client.component.itemCompClient.ItemCompClient ```python import mod.client.extraClientApi as clientApi comp = clientApi.GetEngineCompFactory().CreateItem(levelId) -comp.GetItemBasicInfo("minecraft:bow") +info = comp.GetItemBasicInfo("minecraft:bow") +enchant_slot_type = info["enchant_slot_type"] +support_sword = (enchant_slot_type & EnchantSlotType.SWORD) > 0 ``` diff --git a/docs/mcdocs/1-ModAPI/接口/特效/粒子.md b/docs/mcdocs/1-ModAPI/接口/特效/粒子.md index 2a1b8183..8af81942 100644 --- a/docs/mcdocs/1-ModAPI/接口/特效/粒子.md +++ b/docs/mcdocs/1-ModAPI/接口/特效/粒子.md @@ -18,11 +18,11 @@ method in mod.client.component.particleEntityBindComp.ParticleEntityBindComp | 参数名 |
数据类型
| 说明 | | :--- | :--- | :--- | - | isClientEntity | bool | 如果实体是由CreateClientEntityByTypeStr接口创建的,则需要传入True.默认为False | | bindEntityId | str | 绑定的entity的ID | | offset | tuple(float,float,float) | 绑定的偏移量，相对绑定entity脚下中心 | | rot | tuple(float,float,float) | 绑定的旋转角度 | | correction | bool | 默认不开启，开启后可以使特效的旋转角度准确设置为参照玩家的相对角度 | + | isClientEntity | bool | 如果实体是由CreateClientEntityByTypeStr接口创建的,则需要传入True.默认为False | - 返回值 diff --git a/docs/mcdocs/1-ModAPI/接口/玩家/属性.md b/docs/mcdocs/1-ModAPI/接口/玩家/属性.md index ccc2adf7..ad8d7b6c 100644 --- a/docs/mcdocs/1-ModAPI/接口/玩家/属性.md +++ b/docs/mcdocs/1-ModAPI/接口/玩家/属性.md @@ -228,6 +228,36 @@ print(comp.GetPlayerCurLevelExp(playerId)) +## GetPlayerCurrentExhaustionValue + +服务端 + +method in mod.server.component.playerCompServer.PlayerCompServer + +- 描述 + + 获取玩家foodExhaustionLevel的当前消耗度。详见消耗度介绍 + +- 参数 + + 无 + +- 返回值 + + |
数据类型
| 说明 | + | :--- | :--- | + | float | 玩家foodExhaustionLevel的当前消耗度, | + +- 示例 + +```python +import mod.server.extraServerApi as serverApi +comp = serverApi.GetEngineCompFactory().CreatePlayer(playerId) +value = comp.GetPlayerCurrentExhaustionValue() +``` + + + ## GetPlayerExp 服务端客户端 @@ -699,6 +729,38 @@ comp.SetEnchantmentSeed(32) +## SetPlayerCurrentExhaustionValue + +服务端 + +method in mod.server.component.playerCompServer.PlayerCompServer + +- 描述 + + 设置玩家foodExhaustionLevel的当前消耗度。详见消耗度介绍 + +- 参数 + + | 参数名 |
数据类型
| 说明 | + | :--- | :--- | :--- | + | value | float | 当前消耗度 | + +- 返回值 + + |
数据类型
| 说明 | + | :--- | :--- | + | bool | 是否设置成功 | + +- 示例 + +```python +import mod.server.extraServerApi as serverApi +comp = serverApi.GetEngineCompFactory().CreatePlayer(playerId) +result = comp.SetPlayerCurrentExhaustionValue(2.0) +``` + + + ## SetPlayerHealthLevel 服务端 diff --git a/docs/mcdocs/1-ModAPI/接口/玩家/摄像机.md b/docs/mcdocs/1-ModAPI/接口/玩家/摄像机.md index 1692b278..f11029a1 100644 --- a/docs/mcdocs/1-ModAPI/接口/玩家/摄像机.md +++ b/docs/mcdocs/1-ModAPI/接口/玩家/摄像机.md @@ -106,8 +106,8 @@ method in mod.client.component.cameraCompClient.CameraComponentClient | startPos | tuple(float,float,float) | 轨迹起点，默认为None，表示以调用[StartCameraMotion](#StartCameraMotion)的位置作为起点。 | | relativeCoord | bool | 是否使用相对坐标设置起点和终点，默认为False。 | | isLoop | bool | 是否循环，若设为True，则相机会在起点和终点之间往复运动，默认为False。 | - | targetRot | tuple(float,float) | 相机到达targetPos时的朝向，受参数relativeCoord影响，默认为None，表示使用调用[StartCameraMotion](#StartCameraMotion)时的朝向。 | - | startRot | tuple(float,float) | 相机到达startPos时的朝向，受参数relativeCoord影响，默认为None，表示使用调用[StartCameraMotion](#StartCameraMotion)时的朝向。 | + | targetRot | tuple(float,float,float) | 相机到达targetPos时的朝向，受参数relativeCoord影响，默认为None，表示使用调用[StartCameraMotion](#StartCameraMotion)时的朝向。 | + | startRot | tuple(float,float,float) | 相机到达startPos时的朝向，受参数relativeCoord影响，默认为None，表示使用调用[StartCameraMotion](#StartCameraMotion)时的朝向。 | | useVelocityDir | bool | 是否使用运动中的速度方向作为朝向，默认为False，若为True，则参数targetRot和startRot无效 | | ease | TimeEaseType | 时间变化函数, 默认值为clientApi.GetMinecraftEnum().TimeEaseType.linear, 参数不在枚举值中也当作linear | @@ -131,8 +131,8 @@ method in mod.client.component.cameraCompClient.CameraComponentClient import mod.client.extraClientApi as clientApi comp = clientApi.GetEngineCompFactory().CreateCamera(levelId) target = (5, 0, 0) -rot1 = (0, 0) -rot2 = (0, 360) +rot1 = (0, 0, 0) +rot2 = (0, 360, 0) mID = comp.AddCameraTrackMotion(target, 3.0, startPos=None, relativeCoord=True, isLoop=False, targetRot=rot1, startRot=rot2, useVelocityDir=True, ease = clientApi.GetMinecraftEnum().TimeEaseType.linear) ``` @@ -604,7 +604,7 @@ method in mod.client.component.cameraCompClient.CameraComponentClient | 参数名 |
数据类型
| 说明 | | :--- | :--- | :--- | | lockPos | tuple(float,float,float) | 世界坐标 | - | lockRot | tuple(float,float) | 摄像机的角度（俯仰角及偏航角） | + | lockRot | tuple(float,float,float) | 摄像机的角度（俯仰角,偏航角,横滚角） | - 返回值 @@ -622,7 +622,7 @@ method in mod.client.component.cameraCompClient.CameraComponentClient import mod.client.extraClientApi as clientApi comp = clientApi.GetEngineCompFactory().CreateCamera(levelId) # 把摄像机固定在(0, 6, 0)，并且30度俯视，朝向世界z轴正方向 -comp.LockCamera((0, 6, 0), (30, 0)) +comp.LockCamera((0, 6, 0), (30, 0, 0)) ``` diff --git a/docs/mcdocs/1-ModAPI/接口/玩家/渲染.md b/docs/mcdocs/1-ModAPI/接口/玩家/渲染.md index 29804ead..c5989dc0 100644 --- a/docs/mcdocs/1-ModAPI/接口/玩家/渲染.md +++ b/docs/mcdocs/1-ModAPI/接口/玩家/渲染.md @@ -370,8 +370,8 @@ method in mod.client.component.actorRenderCompClient.ActorRenderCompClient | 参数名 |
数据类型
| 说明 | | :--- | :--- | :--- | - | geometryKey | str | 贴图键 | - | geometryName | str | 贴图路径 | + | textureKey | str | 贴图键 | + | textureName | str | 贴图路径 | - 返回值 @@ -620,7 +620,7 @@ method in mod.client.component.modelCompClient.ModelComponentClient | 参数名 |
数据类型
| 说明 | | :--- | :--- | :--- | - | skin | str | 贴图路径，以textures\models为当前路径的相对路径 | + | skin | str | 贴图路径，以textures/models为当前路径的相对路径 | - 返回值 @@ -631,6 +631,7 @@ method in mod.client.component.modelCompClient.ModelComponentClient - 备注 - 会覆盖原有皮肤（包括4d皮肤）。但会被骨骼模型覆盖 - 只能修改Steve模型的皮肤，不能修改Alex模型的皮肤 + - 如需修改细手臂模型皮肤，请使用[AddPlayerTexture](#addplayertexture)修改default键对应的贴图 - 示例 diff --git a/docs/mcdocs/1-ModAPI/接口/玩家/索引.md b/docs/mcdocs/1-ModAPI/接口/玩家/索引.md index f2698e25..29f63059 100644 --- a/docs/mcdocs/1-ModAPI/接口/玩家/索引.md +++ b/docs/mcdocs/1-ModAPI/接口/玩家/索引.md @@ -27,6 +27,7 @@ sidebarDepth: 1 | [GetArmorValue](属性.md#getarmorvalue) | 客户端 | 获取玩家护甲值 | | [GetEnchantmentSeed](属性.md#getenchantmentseed) | 服务端 | 获取玩家的附魔种子，该种子会决定附魔台上准备附魔的装备的附魔项 | | [GetPlayerCurLevelExp](属性.md#getplayercurlevelexp) | 客户端 | 获取玩家当前等级需要的经验值 | +| [GetPlayerCurrentExhaustionValue](属性.md#getplayercurrentexhaustionvalue) | 服务端 | 获取玩家foodExhaustionLevel的当前消耗度。详见消耗度介绍 | | [GetPlayerExp](属性.md#getplayerexp) | 服务端 | 获取玩家当前等级下的经验值 | | [GetPlayerExp](属性.md#getplayerexp) | 客户端 | 获取玩家当前等级下的经验值 | | [GetPlayerHealthLevel](属性.md#getplayerhealthlevel) | 服务端 | 获取玩家健康临界值，当饥饿值大于等于健康临界值时会自动恢复血量，开启饥饿值且开启自然恢复时有效。原版默认值为18 | @@ -42,6 +43,7 @@ sidebarDepth: 1 | [IsPlayerNaturalRegen](属性.md#isplayernaturalregen) | 服务端 | 是否开启玩家自然恢复，当饥饿值大于等于健康临界值时会自动恢复血量，开启饥饿值且开启自然恢复时有效。原版默认开启 | | [IsPlayerNaturalStarve](属性.md#isplayernaturalstarve) | 服务端 | 是否开启玩家饥饿掉血，当饥饿值小于饥饿临界值时会自动恢复血量，开启饥饿值且开启饥饿掉血时有效。原版默认开启 | | [SetEnchantmentSeed](属性.md#setenchantmentseed) | 服务端 | 设置玩家的附魔种子，该种子会决定附魔台上准备附魔的装备的附魔项 | +| [SetPlayerCurrentExhaustionValue](属性.md#setplayercurrentexhaustionvalue) | 服务端 | 设置玩家foodExhaustionLevel的当前消耗度。详见消耗度介绍 | | [SetPlayerHealthLevel](属性.md#setplayerhealthlevel) | 服务端 | 设置玩家健康临界值，当饥饿值大于等于健康临界值时会自动恢复血量，开启饥饿值且开启自然恢复时有效.原版默认值为18 | | [SetPlayerHealthTick](属性.md#setplayerhealthtick) | 服务端 | 设置玩家自然恢复速度，当饥饿值大于等于健康临界值时会自动恢复血量，开启饥饿值且开启自然恢复时有效.原版默认值为80刻（即每4秒）恢复1点血量 | | [SetPlayerHunger](属性.md#setplayerhunger) | 服务端 | 设置玩家饥饿度。 | @@ -70,7 +72,7 @@ sidebarDepth: 1 | [EndSprinting](行为.md#endsprinting) | 客户端 | 使本地玩家结束向前疾跑/冲刺状态 | | [GetEntityRider](行为.md#getentityrider) | 服务端 | 获取骑乘者正在骑乘的实体的id。 | | [GetEntityRider](行为.md#getentityrider) | 客户端 | 获取骑乘者正在骑乘的实体的id。 | -| [GetInteracteCenterOffset](行为.md#getinteractecenteroffset) | 服务端 | 获取玩家[服务端交互中心](../../../1-ModAPI/更新信息/2.8.md#玩家摄像机)的偏移 | +| [GetInteracteCenterOffset](行为.md#getinteractecenteroffset) | 服务端 | 获取玩家[服务端交互中心](../../更新信息/2.8.md#玩家摄像机)的偏移 | | [GetIsBlocking](行为.md#getisblocking) | 服务端 | 获取玩家激活盾牌状态 | | [GetPickCenterOffset](行为.md#getpickcenteroffset) | 客户端 | 获取玩家设置的第三人称下客户端交互中心的偏移 | | [GetPickRange](行为.md#getpickrange) | 客户端 | 获取玩家客户端的交互距离 | @@ -82,8 +84,8 @@ sidebarDepth: 1 | [GetPlayerRespawnPos](行为.md#getplayerrespawnpos) | 服务端 | 获取玩家复活点 | | [GetRelevantPlayer](行为.md#getrelevantplayer) | 服务端 | 获取附近玩家id列表 | | [IsEntityRiding](行为.md#isentityriding) | 服务端 | 检查玩家是否骑乘。 | -| [IsInScaffolding](行为.md#isinscaffolding) | 客户端 | 获取玩家是否与脚手架有交叉 | -| [IsOnLadder](行为.md#isonladder) | 客户端 | 获取玩家是否与梯子/藤蔓有交叉 | +| [IsInScaffolding](行为.md#isinscaffolding) | 客户端 | 获取玩家是否在脚手架中 | +| [IsOnLadder](行为.md#isonladder) | 客户端 | 获取玩家是否在梯子/藤蔓上 | | [IsPlayerCanFly](行为.md#isplayercanfly) | 服务端 | 获取玩家能否飞行 | | [IsPlayerFlying](行为.md#isplayerflying) | 服务端 | 获取玩家是否在飞行 | | [OpenWorkBench](行为.md#openworkbench) | 服务端 | 在玩家当前位置打开工作台UI，不依赖于工作台方块 | diff --git a/docs/mcdocs/1-ModAPI/接口/玩家/行为.md b/docs/mcdocs/1-ModAPI/接口/玩家/行为.md index 7835444b..64511eb3 100644 --- a/docs/mcdocs/1-ModAPI/接口/玩家/行为.md +++ b/docs/mcdocs/1-ModAPI/接口/玩家/行为.md @@ -424,7 +424,7 @@ method in mod.server.component.playerCompServer.PlayerCompServer - 描述 - 获取玩家[服务端交互中心](../../../1-ModAPI/更新信息/2.8.md#玩家摄像机)的偏移 + 获取玩家[服务端交互中心](../../更新信息/2.8.md#玩家摄像机)的偏移 - 参数 @@ -1547,9 +1547,6 @@ method in mod.server.component.playerCompServer.PlayerCompServer | :--- | :--- | | bool | 是否设置成功 | -- 备注 - - 备注：如需限制玩家跳跃，请使用SetPlayerJumpable - - 示例 ```python diff --git a/docs/mcdocs/1-ModAPI/接口/自定义UI/UI控件.md b/docs/mcdocs/1-ModAPI/接口/自定义UI/UI控件.md index d83ad082..7904c69c 100644 --- a/docs/mcdocs/1-ModAPI/接口/自定义UI/UI控件.md +++ b/docs/mcdocs/1-ModAPI/接口/自定义UI/UI控件.md @@ -54,7 +54,7 @@ method in mod.client.ui.controls.minimapUIControl.MiniMapUIControl | 参数名 |
数据类型
| 说明 | | :--- | :--- | :--- | | entityId | str | 实体Id | - | text | str | 文本的内容，可以支持[样式代码](https://minecraft-zh.gamepedia.com/%E6%A0%B7%E5%BC%8F%E4%BB%A3%E7%A0%81)（§可以设置文字的颜色、格式等，该种用法更加灵活多变） | + | text | str | 文本的内容，可以支持[样式代码](https://zh.minecraft.wiki/w/%E6%A0%BC%E5%BC%8F%E5%8C%96%E4%BB%A3%E7%A0%81)（§可以设置文字的颜色、格式等，该种用法更加灵活多变） | | scale | float | 文本缩放倍数，等于文本控件json中的font_scale_factor参数，默认缩放倍数为1.0 | - 返回值 @@ -192,7 +192,7 @@ method in mod.client.ui.controls.minimapUIControl.MiniMapUIControl | :--- | :--- | :--- | | key | str | 标记Id | | vec2 | tuple(float,float) | 地图位置二维坐标(x,z) | - | text | str | 文本的内容，可以支持[样式代码](https://minecraft-zh.gamepedia.com/%E6%A0%B7%E5%BC%8F%E4%BB%A3%E7%A0%81)（§可以设置文字的颜色、格式等，该种用法更加灵活多变） | + | text | str | 文本的内容，可以支持[样式代码](https://zh.minecraft.wiki/w/%E6%A0%BC%E5%BC%8F%E5%8C%96%E4%BB%A3%E7%A0%81)（§可以设置文字的颜色、格式等，该种用法更加灵活多变） | | scale | float | 文本缩放倍数，等于文本控件json中的font_scale_factor参数，默认缩放倍数为1.0 | - 返回值 @@ -1271,6 +1271,36 @@ textPosition = baseUIControl.GetPosition() +## GetPropertyBag + +客户端 + +method in mod.client.ui.controls.baseUIControl.BaseUIControl + +- 描述 + + 获取PropertyBag + +- 参数 + + 无 + +- 返回值 + + |
数据类型
| 说明 | + | :--- | :--- | + | str | PropertyBag | + +- 示例 + +```python +text2Path = "/panel/text2" +baseUIControl = uiNode.GetBaseUIControl(text2Path) +propertyBag = baseUIControl.GetPropertyBag() +``` + + + ## GetRotateAngle 客户端 @@ -4018,6 +4048,39 @@ baseUIControl.SetPosition(pos) +## SetPropertyBag + +客户端 + +method in mod.client.ui.controls.baseUIControl.BaseUIControl + +- 描述 + + 设置PropertyBag,将使用字典中的每个值来覆盖原本PropertyBag中的值 + +- 参数 + + | 参数名 |
数据类型
| 说明 | + | :--- | :--- | :--- | + | params | dict | 需要设置的属性字典，字典键值对的值仅支持设置字符串、数字、布尔值类型，其余类型会导致设置失败 | + +- 返回值 + + |
数据类型
| 说明 | + | :--- | :--- | + | bool | 是否设置成功 | + +- 示例 + +```python +text2Path = "/panel/text2" +baseUIControl = uiNode.GetBaseUIControl(text2Path) +params = {"text": "hello world", "number": 123, "boolean": True} +success = baseUIControl.SetPropertyBag(params) +``` + + + ## SetRotatePivot 客户端 @@ -4519,7 +4582,7 @@ method in mod.client.ui.controls.labelUIControl.LabelUIControl | 参数名 |
数据类型
| 说明 | | :--- | :--- | :--- | - | text | str | 文本的内容，可以支持[样式代码](https://minecraft-zh.gamepedia.com/%E6%A0%B7%E5%BC%8F%E4%BB%A3%E7%A0%81)（§可以设置文字的颜色、格式等，该种用法更加灵活多变） | + | text | str | 文本的内容，可以支持[样式代码](https://zh.minecraft.wiki/w/%E6%A0%BC%E5%BC%8F%E5%8C%96%E4%BB%A3%E7%A0%81)（§可以设置文字的颜色、格式等，该种用法更加灵活多变） | | syncSize | bool | 是否设置文本时同步更新文本框大小，默认值为False | - 返回值 diff --git a/docs/mcdocs/1-ModAPI/接口/自定义UI/索引.md b/docs/mcdocs/1-ModAPI/接口/自定义UI/索引.md index 9c2d981e..088b4d07 100644 --- a/docs/mcdocs/1-ModAPI/接口/自定义UI/索引.md +++ b/docs/mcdocs/1-ModAPI/接口/自定义UI/索引.md @@ -136,6 +136,7 @@ sidebarDepth: 1 | [GetOrientation](UI控件.md#getorientation) | 客户端 | 获取stackPanel的排列方向 | | [GetPath](UI控件.md#getpath) | 客户端 | 返回当前控件的相对路径，路径从画布节点开始算起 | | [GetPosition](UI控件.md#getposition) | 客户端 | 获取控件相对父节点的坐标 | +| [GetPropertyBag](UI控件.md#getpropertybag) | 客户端 | 获取PropertyBag | | [GetRotateAngle](UI控件.md#getrotateangle) | 客户端 | 获取图片相对自身的旋转锚点旋转的角度 | | [GetRotatePivot](UI控件.md#getrotatepivot) | 客户端 | 获取图片相对自身的旋转锚点 | | [GetRotateRect](UI控件.md#getrotaterect) | 客户端 | 获取图片当前的四个边角点 | @@ -210,6 +211,7 @@ sidebarDepth: 1 | [SetOffsetDelta](UI控件.md#setoffsetdelta) | 客户端 | 设置点击面板的拖拽偏移量 | | [SetOrientation](UI控件.md#setorientation) | 客户端 | 设置stackPanel的排列方向 | | [SetPosition](UI控件.md#setposition) | 客户端 | 设置控件相对父节点的坐标 | +| [SetPropertyBag](UI控件.md#setpropertybag) | 客户端 | 设置PropertyBag,将使用字典中的每个值来覆盖原本PropertyBag中的值 | | [SetRotatePivot](UI控件.md#setrotatepivot) | 客户端 | 设置图片自身旋转锚点，该点并不是固定的点，而是相对于自身位置的点 | | [SetScrollViewPercentValue](UI控件.md#setscrollviewpercentvalue) | 客户端 | 设置当前scroll_view内容的百分比位置 | | [SetScrollViewPos](UI控件.md#setscrollviewpos) | 客户端 | 设置当前scroll_view内容的位置 | diff --git a/docs/mcdocs/1-ModAPI/接口/通用/工具.md b/docs/mcdocs/1-ModAPI/接口/通用/工具.md index 07f89647..d8e9f17b 100644 --- a/docs/mcdocs/1-ModAPI/接口/通用/工具.md +++ b/docs/mcdocs/1-ModAPI/接口/通用/工具.md @@ -474,6 +474,66 @@ fps = comp.GetFps() +## GetHostPlayerId + +服务端客户端 + +### 服务端接口 + + +method in mod.server.extraServerApi + +- 描述 + + 获取房主的entityId + +- 参数 + + 无 + +- 返回值 + + |
数据类型
| 说明 | + | :--- | :--- | + | str | 房主的entityId,若房主未加入则返回None | + +- 示例 + +```python +import mod.server.extraServerApi as serverApi +serverApi.GetHostPlayerId() +``` + + + +### 客户端接口 + + +method in mod.client.extraClientApi + +- 描述 + + 获取房主的entityId + +- 参数 + + 无 + +- 返回值 + + |
数据类型
| 说明 | + | :--- | :--- | + | str | 房主的entityId,若房主未加入则返回None | + +- 示例 + +```python +import mod.client.extraClientApi as clientApi +clientApi.GetHostPlayerId() +``` + + + ## GetMinecraftEnum 服务端客户端 diff --git a/docs/mcdocs/1-ModAPI/接口/通用/数学.md b/docs/mcdocs/1-ModAPI/接口/通用/数学.md index d20e871a..4011c856 100644 --- a/docs/mcdocs/1-ModAPI/接口/通用/数学.md +++ b/docs/mcdocs/1-ModAPI/接口/通用/数学.md @@ -67,6 +67,70 @@ direction = clientApi.GetDirFromRot((0, 0)) +## GetIntPos + +服务端客户端 + +### 服务端接口 + + +method in mod.server.extraServerApi + +- 描述 + + 获取坐标所在方块的位置，即浮点数坐标向下取整后的整数坐标。 + +- 参数 + + | 参数名 |
数据类型
| 说明 | + | :--- | :--- | :--- | + | pos | tuple(float,float,float) | 坐标元组 | + +- 返回值 + + |
数据类型
| 说明 | + | :--- | :--- | + | tuple(int,int,int) | 坐标所在方块的位置 | + +- 示例 + +```python +import mod.server.extraServerApi as serverApi +serverApi.GetIntPos((1.2,1.3,1.4)) +``` + + + +### 客户端接口 + + +method in mod.client.extraClientApi + +- 描述 + + 获取坐标所在方块的位置，即浮点数坐标向下取整后的整数坐标。 + +- 参数 + + | 参数名 |
数据类型
| 说明 | + | :--- | :--- | :--- | + | pos | tuple(float,float,float) | 坐标元组 | + +- 返回值 + + |
数据类型
| 说明 | + | :--- | :--- | + | tuple(int,int,int) | 坐标所在方块的位置 | + +- 示例 + +```python +import mod.client.extraClientApi as clientApi +clientApi.GetIntPos((1.2,1.3,1.4)) +``` + + + ## GetLocalPosFromWorld 服务端客户端 diff --git a/docs/mcdocs/1-ModAPI/接口/通用/索引.md b/docs/mcdocs/1-ModAPI/接口/通用/索引.md index d9d99064..607afeed 100644 --- a/docs/mcdocs/1-ModAPI/接口/通用/索引.md +++ b/docs/mcdocs/1-ModAPI/接口/通用/索引.md @@ -86,6 +86,8 @@ sidebarDepth: 1 | --- | --- | --- | | [GetDirFromRot](数学.md#getdirfromrot) | 服务端 | 通过旋转角度获取朝向 | | [GetDirFromRot](数学.md#getdirfromrot) | 客户端 | 通过旋转角度获取朝向 | +| [GetIntPos](数学.md#getintpos) | 服务端 | 获取坐标所在方块的位置，即浮点数坐标向下取整后的整数坐标。 | +| [GetIntPos](数学.md#getintpos) | 客户端 | 获取坐标所在方块的位置，即浮点数坐标向下取整后的整数坐标。 | | [GetLocalPosFromWorld](数学.md#getlocalposfromworld) | 服务端 | 获取基于实体的世界坐标对应的局部坐标 | | [GetLocalPosFromWorld](数学.md#getlocalposfromworld) | 客户端 | 获取基于实体的世界坐标对应的局部坐标 | | [GetRotFromDir](数学.md#getrotfromdir) | 服务端 | 通过朝向获取旋转角度 | @@ -111,6 +113,8 @@ sidebarDepth: 1 | [GetChinese](工具.md#getchinese) | 客户端 | 获取langStr对应的中文，可参考PC开发包中\handheld\localization\handheld\data\resource_packs\vanilla\texts\zh_CN.lang | | [GetClipboardContent](工具.md#getclipboardcontent) | 客户端 | 获取系统剪贴板内容 | | [GetFps](工具.md#getfps) | 客户端 | 获取fps | +| [GetHostPlayerId](工具.md#gethostplayerid) | 服务端 | 获取房主的entityId | +| [GetHostPlayerId](工具.md#gethostplayerid) | 客户端 | 获取房主的entityId | | [GetMinecraftEnum](工具.md#getminecraftenum) | 服务端 | 用于获取[枚举值文档](../../枚举值/索引.md)中的枚举值 | | [GetMinecraftEnum](工具.md#getminecraftenum) | 客户端 | 用于获取[枚举值文档](../../枚举值/索引.md)中的枚举值 | | [GetModConfigJson](工具.md#getmodconfigjson) | 客户端 | 以字典形式返回指定路径的json格式配置文件的内容，文件必须放置在资源包的/modconfigs目录下 | diff --git a/docs/mcdocs/1-ModAPI/更新信息/3.3.md b/docs/mcdocs/1-ModAPI/更新信息/3.3.md index a7b2a1cd..37e583f4 100644 --- a/docs/mcdocs/1-ModAPI/更新信息/3.3.md +++ b/docs/mcdocs/1-ModAPI/更新信息/3.3.md @@ -1,15 +1,15 @@ # 3.3 -2025.3.14：版本号（V3.3 BE1.20.50）包括Mod PC包，手机测试版启动器，和服务器引擎。 +2025.3.21：版本号（V3.3 BE1.20.50）包括Mod PC包，手机测试版启动器，和服务器引擎。 示例Demo：前往此处下载 ## 一、更新时间表 1. 在2025年3月14日上线3.3第一个Beta版。 -2. 在2025年3月27日上线3.3第二个Beta版。 -3. 在2025年4月8日上线3.3稳定版。 -4. 在2025年4月11日，全渠道将更新3.3版本玩家包体，玩家将陆续更新到3.3版本，请开发者合理安排更新节奏。 +2. 在2025年3月21日上线3.3第二个Beta版。 +3. 在2025年3月28日上线3.3稳定版。 +4. 在2025年4月3日，全渠道将更新3.3版本玩家包体，玩家将陆续更新到3.3版本，请开发者合理安排更新节奏。 ## 二、重要功能更新 @@ -22,7 +22,7 @@ ![自定义指令](../picture/custom_command.png) 3. 支持播放方块/物品破坏粒子，以及物品被食用时的粒子，可用于增强游戏表现效果，实现加工、锻造等场景的完整视觉反馈链条。例如：机械动力中在传送带上压铸道具，农夫乐事砧板切碎食材等。 -4. 我们重新设计了底层数据协议，原生支持Python基础数据类型的直接存储和传输，包括long、tuple、set和frozenset，便于开发者存储和传输复杂数据结构（如方块调色板）。涉及接口包括SetConfigData、GetConfigData、Mod SDK双端通信接口、Apollo通信接口等。 +4. 我们重新设计了底层数据协议，原生支持Python基础数据类型的直接存储和传输，包括long、tuple、set和frozenset，便于开发者存储和传输复杂数据结构（如方块调色板）。涉及接口包括SetConfigData、GetConfigData、Mod SDK双端通信接口、Apollo通信接口等。**请不要在3.3存储含有tuple等数据后，在3.2旧版读取并再次存储，将导致数据格式错误**。 5. 新增物品组件netease:initial_user_data，用于指定在创造物品栏中注册的初始NBT数据，简化如自带附魔的物品或特殊属性道具的注册流程。 6. 新增方块组件netease:block_animate_random_tick，该组件可方便地实现如落叶飘落、粒子飞散等效果，并对性能无明显影响。 7. 新增维度组件netease:ban_vanilla_structure，用于灵活地屏蔽原版结构生成。 @@ -80,6 +80,8 @@ - 调整 +1. 调整[SetHurtByEntity](../)(服务端)， damage改为浮点型 + 1. 调整[Hurt](../接口/实体/行为.md#hurt)(服务端)， damage改为浮点型 1. 调整[GetItemInfoByBlockName](../接口/物品.md#getiteminfobyblockname)(服务端)， 新增isLegacy参数，默认为True @@ -114,4 +116,5 @@ - 废弃（将在未来不可用） -1. 废弃SpawnItemToLevel，请使用CreateEngineItemEntity \ No newline at end of file +1. 废弃SpawnItemToLevel，请使用CreateEngineItemEntity + diff --git a/docs/mcdocs/1-ModAPI/更新信息/3.4.md b/docs/mcdocs/1-ModAPI/更新信息/3.4.md new file mode 100644 index 00000000..b6dd2af9 --- /dev/null +++ b/docs/mcdocs/1-ModAPI/更新信息/3.4.md @@ -0,0 +1,93 @@ +# 3.4 +2025.5.22：版本号（V3.4 BE1.21.00）包括Mod PC包，手机测试版启动器，和服务器引擎。 + +示例Demo：前往此处下载 + +## 一、更新时间表 + +1. 在2025年5月22日上线3.4第一个Beta版。 +2. 在2025年6月05日上线3.4第二个Beta版。 +3. 在2025年6月17日上线3.4稳定版。 +4. 在2025年6月27日，全渠道将更新3.4版本玩家包体，玩家将陆续更新到3.4版本，请开发者合理安排更新节奏。 + +## 二、重要功能更新 + +1. 新增自定义容器，可以实现自定义容器界面，支持配置其他方块组件（如自定义实体方块组件）、容器名、交互时打开的自定义ui、以及自定义容器的大小等 + +2. 新增[PlayerTryPutCustomContainerItemServerEvent](../事件/物品.md#playertryputcustomcontaineritemserverevent)(服务端)用于监听玩家将物品放入自定义容器 + +3. [ClientItemTryUseEvent](../事件/物品.md#clientitemtryuseevent)(客户端)、[ClientItemUseOnEvent](../事件/物品.md#clientitemuseonevent)(客户端)、[ClientBlockUseEvent](../事件/方块.md#clientblockuseevent)(客户端)事件逻辑性调整。**三个事件cancel时即可取消使用，无需服务端再次cancel，且服务端事件将不再触发** + +4. 调整LockCamera(客户端)与AddCameraTrackMotion(客户端)支持**roll旋转** + +5. SpawnResources增加掉落经验球参数，设成True时按原版采集逻辑进行经验球掉落，如矿石类方块会产生随机数量的经验球 + +6. 新增GetPlayerCurrentExhaustionValue(服务端)、SetPlayerCurrentExhaustionValue(服务端) 获取和设置玩家当前消耗度 + +7. 方块实体模型的渲染消失问题修复，现在将根据netease:aabb组件中clip字段作为裁减碰撞盒，开发者可以自行配置netease:aabb组件中clip字段大小控制模型显示大小 + +8. 新版视角切换按钮贴图位于/textures/ui/perspective.png，材质包开发者请留意提前适配 + + + + +## 三、API更新 + +- 新增 + +1. 新增[GetIntPos](../接口/通用/数学.md#getintpos)(服务端)， 获取坐标所在方块的位置 + +1. 新增[GetHostPlayerId](../接口/通用/工具.md#gethostplayerid)(服务端)， 获取房主的entityId + +1. 新增[GetIntPos](../接口/通用/数学.md#getintpos)(客户端)， 获取坐标所在方块的位置 + +1. 新增[GetHostPlayerId](../接口/通用/工具.md#gethostplayerid)(客户端)， 获取房主的entityId + +1. 新增[GetPlayerCurrentExhaustionValue](../接口/玩家/属性.md#getplayercurrentexhaustionvalue)(服务端)， 获取玩家当前消耗度 + +1. 新增[SetPlayerCurrentExhaustionValue](../接口/玩家/属性.md#setplayercurrentexhaustionvalue)(服务端)， 设置玩家当前消耗度 + +1. 新增[GetPropertyBag](../接口/自定义UI/UI控件.md#getpropertybag)(客户端)， 获取PropertyBag + +1. 新增[SetPropertyBag](../接口/自定义UI/UI控件.md#setpropertybag)(客户端)， 设置PropertyBag + +1. 新增[ChunkGeneratedServerEvent](../事件/世界.md#chunkgeneratedserverevent)(服务端)， 新增chunkPosX,chunkPosZ + +1. 新增[PlayerTryPutCustomContainerItemServerEvent](../事件/物品.md#playertryputcustomcontaineritemserverevent)(服务端)， 玩家尝试将物品放入自定义容器时触发该事件 + +- 调整 + +1. 调整[HideSwimGui](../接口/原生UI.md#hideswimgui)(客户端)， 修改接口描述, 隐藏潜伏按钮 + +1. 调整[SpawnResources](../接口/世界/实体管理.md#spawnresources)(服务端)， 新增是否生成经验球参数，默认为False，设成True时按原版采集逻辑进行经验球掉落，如矿石类方块会产生随机数量的经验球 + +1. 调整[GetItemBasicInfo](../接口/物品.md#getitembasicinfo)(服务端)， 新增字段，enchant_slot_type + +1. 调整[SetPos](../接口/实体/属性.md#setpos)(服务端)， 修改文档类型描述 + +1. 调整[GetActorRenderParams](../接口/实体/渲染.md#getactorrenderparams)(客户端)， 修复返回数据 + +1. 调整[LockCamera](../接口/玩家/摄像机.md#lockcamera)(客户端)， lockRot支持roll旋转 + +1. 调整[AddCameraTrackMotion](../接口/玩家/摄像机.md#addcameratrackmotion)(客户端)， targetRot和startRot支持roll旋转 + +1. 调整[GetItemBasicInfo](../接口/物品.md#getitembasicinfo)(客户端)， 新增字段，enchant_slot_type + +1. 调整[ServerItemTryUseEvent](../事件/物品.md#serveritemtryuseevent)(服务端)， ClientItemTryUseEvent的cancel设置为True时，服务端事件不会被触发了。 + +1. 调整[ServerItemUseOnEvent](../事件/物品.md#serveritemuseonevent)(服务端)， 客户端事件ClientItemUseOnEvent设置ret设置为True时，服务端不再会接受到这个事件。 + +1. 调整[BlockStrengthChangedServerEvent](../事件/方块.md#blockstrengthchangedserverevent)(服务端)， 新增变化前的红石信号量参数 + +1. 调整[ClientItemTryUseEvent](../事件/物品.md#clientitemtryuseevent)(客户端)， ClientItemTryUseEvent事件设置cancel为True时,不会再给服务端同步物品使用网络包。 + +1. 调整[ClientItemUseOnEvent](../事件/物品.md#clientitemuseonevent)(客户端)， ClientItemUseOnEvent事件设置ret为True时，不会再给服务端同步物品使用网络包。 + +1. 调整[ClientBlockUseEvent](../事件/方块.md#clientblockuseevent)(客户端)， 当拦截交互逻辑时，不再会给服务端发送网络包， + +1. 调整[BlockAnimateRandomTickEvent](../事件/方块.md#blockanimaterandomtickevent)(客户端)， 新增blockName与auxData参数 + +1. 调整[ActorDamageCause](../枚举值/ActorDamageCause.md)， 微软把suicide改成了self_destruct + +1. 调整[OriginGUIName](../枚举值/OriginGUIName.md)， 增加摄像机视角按钮 + diff --git a/docs/mcdocs/1-ModAPI/枚举值/ActorDamageCause.md b/docs/mcdocs/1-ModAPI/枚举值/ActorDamageCause.md index d76a25d4..84d9f650 100644 --- a/docs/mcdocs/1-ModAPI/枚举值/ActorDamageCause.md +++ b/docs/mcdocs/1-ModAPI/枚举值/ActorDamageCause.md @@ -24,7 +24,8 @@ class ActorDamageCause(object): BlockExplosion = "block_explosion" # 方块爆炸 EntityExplosion = "entity_explosion" # 生物爆炸 Void = "void" # 虚空 - Suicide = "suicide" # 自杀（kill命令） + Suicide = "self_destruct" # 自杀（kill命令）兼容旧版 + SelfDestruct = "self_destruct" # 自杀（kill命令） Magic = "magic" # 尖牙对生物造成的伤害、守卫者对生物造成的魔法伤害和药水伤害等 Wither = "wither" # 凋零效果 Starve = "starve" # 饥饿 diff --git a/docs/mcdocs/1-ModAPI/枚举值/AniCheatMove.md b/docs/mcdocs/1-ModAPI/枚举值/AniCheatMove.md index 833c03ea..c2d0d8de 100644 --- a/docs/mcdocs/1-ModAPI/枚举值/AniCheatMove.md +++ b/docs/mcdocs/1-ModAPI/枚举值/AniCheatMove.md @@ -11,7 +11,6 @@ class in mod.common.minecraftEnum ```python class AniCheatMove(object): CheckStyle = "server-authoritative-movement" # 位移检查的模式 - CorrectSwitch = "correct-player-movement" # 是否对位移有问题的客户端进行纠正 MinCorrectDelayTick = "player-rewind-min-correction-delay-ticks" # 服务端从发现作弊到发送纠正指令的最小tick数，0表示发现作弊时每帧发送纠正指令(int) TickHistorySize = "player-rewind-history-size-ticks" # 客户端保存历史帧数，用于倒带模拟。每秒20帧(int) diff --git a/docs/mcdocs/1-ModAPI/枚举值/AniCheatMoveRewind.md b/docs/mcdocs/1-ModAPI/枚举值/AniCheatMoveRewind.md index b41071a5..76b82d61 100644 --- a/docs/mcdocs/1-ModAPI/枚举值/AniCheatMoveRewind.md +++ b/docs/mcdocs/1-ModAPI/枚举值/AniCheatMoveRewind.md @@ -11,7 +11,6 @@ class in mod.common.minecraftEnum ```python class AniCheatMoveRewind(object): PositionThreshold = "player-rewind-position-threshold" # 某一帧中，客户端位置与服务端位置的距离平方阈值，超过阈值会触发反作弊纠正(float) - VelocityThreshold = "player-rewind-velocity-threshold" # 某一帧中，客户端速度和服务端速度的差值平方阈值，超过这个阈值会触发反作弊纠正(float) PositionAcceptance = "player-rewind-position-acceptance" # 某一帧中，如果客户端位置和服务端位置的距离平方小于这个值，服务端会采用客户端的值(float) PositionPersuasion = "player-rewind-position-persuasion" # 如果客户端和服务端位置不一致，服务端会每帧在客户端的计算方向上加上这个值(float) diff --git a/docs/mcdocs/1-ModAPI/枚举值/AniCheatMoveUnSupportRewind.md b/docs/mcdocs/1-ModAPI/枚举值/AniCheatMoveUnSupportRewind.md deleted file mode 100644 index 238760bf..00000000 --- a/docs/mcdocs/1-ModAPI/枚举值/AniCheatMoveUnSupportRewind.md +++ /dev/null @@ -1,19 +0,0 @@ -# AniCheatMoveUnSupportRewind - -class in mod.common.minecraftEnum - -- 描述 - - 反作弊配置枚举值，不支持倒带模拟的特殊场景相关参数 - - - -```python -class AniCheatMoveUnSupportRewind(object): - PositionThreshold = "player-rewind-unsupported-position-threshold" # 某一帧中，客户端位置与服务端位置的距离平方阈值，超过阈值会触发反作弊纠正(float) - VelocityThreshold = "player-rewind-unsupported-velocity-threshold" # 某一帧中，客户端速度和服务端速度的差值平方阈值，超过这个阈值会触发反作弊纠正(float) - PositionAcceptance = "player-rewind-unsupported-position-acceptance" # 某一帧中，如果客户端位置和服务端位置的距离平方小于这个值，服务端会采用客户端的值(float) - PositionPersuasion = "player-rewind-unsupported-position-persuasion" # 如果客户端和服务端位置不一致，服务端会每帧在客户端的计算方向上加上这个值(float) - -``` - diff --git a/docs/mcdocs/1-ModAPI/枚举值/AttrType.md b/docs/mcdocs/1-ModAPI/枚举值/AttrType.md index c7017f1f..28d3b2b1 100644 --- a/docs/mcdocs/1-ModAPI/枚举值/AttrType.md +++ b/docs/mcdocs/1-ModAPI/枚举值/AttrType.md @@ -7,8 +7,8 @@ class in mod.common.minecraftEnum 描述属性枚举值，用于设置与获取实体的引擎属性的当前值与最大值 - 备注 - - ABSORPTION: 伤害吸收效果的量化值，详见wiki文档：[伤害吸收](https://minecraft-zh.gamepedia.com/index.php?title=%E4%BC%A4%E5%AE%B3%E5%90%B8%E6%94%B6&variant=zh) - - 各类属性值一般通过entity的json配置，如 `minecraft:knockback_resistance : { "value" : 100, "max" : 100}` + - ABSORPTION: 伤害吸收效果的量化值，详见wiki文档：[伤害吸收](https://zh.minecraft.wiki/w/%E4%BC%A4%E5%AE%B3%E5%90%B8%E6%94%B6) + - 各类属性值一般通过entity的json配置，如`minecraft:knockback_resistance : {"value": 100, "max": 100}` - 当json文件中未配置时，引擎会针对不同属性进行不同初始值、不同最大值的设置 diff --git a/docs/mcdocs/1-ModAPI/枚举值/ColorCode.md b/docs/mcdocs/1-ModAPI/枚举值/ColorCode.md index 6e79c80a..69e70606 100644 --- a/docs/mcdocs/1-ModAPI/枚举值/ColorCode.md +++ b/docs/mcdocs/1-ModAPI/枚举值/ColorCode.md @@ -4,7 +4,7 @@ class in mod.common.minecraftEnum - 描述 - [样式代码](https://minecraft-zh.gamepedia.com/%E6%A0%B7%E5%BC%8F%E4%BB%A3%E7%A0%81) + [样式代码](https://zh.minecraft.wiki/w/%E6%A0%BC%E5%BC%8F%E5%8C%96%E4%BB%A3%E7%A0%81) diff --git a/docs/mcdocs/1-ModAPI/枚举值/EffectType.md b/docs/mcdocs/1-ModAPI/枚举值/EffectType.md index 4a98b5a7..a2b1aa74 100644 --- a/docs/mcdocs/1-ModAPI/枚举值/EffectType.md +++ b/docs/mcdocs/1-ModAPI/枚举值/EffectType.md @@ -41,6 +41,12 @@ class EffectType(object): BAD_OMEN = "bad_omen" # 不祥之兆， 进入村庄时触发袭击 HERO_OF_THE_VILLAGE = "village_hero" # 村庄英雄，与村民交易价格降低 DARKNESS = "darkness" # 黑暗,是一种会将玩家的视野限制在15格内，且导致屏幕不时变暗的状态效果。 + WIND_CHARGED = "wind_charged" # 蓄风，是一种让生物死亡时产生风爆的状态效果 + INFESTED = "infested" # 寄生，是一个可以让生物生成蠹虫的状态效果 + OOZING = "oozing" # 渗浆，是一种让生物死亡时产生史莱姆的状态效果 + TRIAL_OMEN = "trial_omen" # 试炼之兆，是不祥之兆的变种，有此效果的玩家会被不祥的trial_omen粒子包围并播放event.mob_effect.trial_omen音效 + WEAVING = "weaving" # 盘丝，是一个可以让生物死亡时传播蜘蛛网以及让生物以较快速度穿过蜘蛛网的状态效果 + RAID_OMEN = "raid_omen" # 袭击之兆，是带有不祥之兆的玩家进入村庄时获得的状态效果，可触发袭击。 ``` diff --git a/docs/mcdocs/1-ModAPI/枚举值/EnchantSlotType.md b/docs/mcdocs/1-ModAPI/枚举值/EnchantSlotType.md index 27cad1e1..f5880f87 100644 --- a/docs/mcdocs/1-ModAPI/枚举值/EnchantSlotType.md +++ b/docs/mcdocs/1-ModAPI/枚举值/EnchantSlotType.md @@ -23,6 +23,7 @@ class EnchantSlotType(object): BOW = 32 # 弓 SPEAR = 32768 # 三叉戟 CROSSBOW = 65536 # 弩 + HEAVY_WEAPON = 4194304 # 重锤 # tool group G_TOOL = 131520 # 剪刀、打火石、盾 diff --git a/docs/mcdocs/1-ModAPI/枚举值/EnchantType.md b/docs/mcdocs/1-ModAPI/枚举值/EnchantType.md index ec911e53..53ff8b8e 100644 --- a/docs/mcdocs/1-ModAPI/枚举值/EnchantType.md +++ b/docs/mcdocs/1-ModAPI/枚举值/EnchantType.md @@ -48,8 +48,12 @@ class EnchantType(object): CrossbowQuickCharge = 35 # 快速装填 SoulSpeed = 36 # 灵魂疾行 SwiftSneak = 37 # 迅捷潜行 - NumEnchantments = 38 # 附魔种数 - InvalidEnchantment = 39 # 无效附魔 + WindBurst = 38 # 风爆 + Density = 39 # 致密 + Breach = 40 # 破甲 + NumEnchantments = 41 # 附魔种数 + InvalidEnchantment = 42 # 无效附魔 + ModEnchant = 255 # 自定义附魔 ``` diff --git a/docs/mcdocs/1-ModAPI/枚举值/EntityType.md b/docs/mcdocs/1-ModAPI/枚举值/EntityType.md index c13424e7..894c6653 100644 --- a/docs/mcdocs/1-ModAPI/枚举值/EntityType.md +++ b/docs/mcdocs/1-ModAPI/枚举值/EntityType.md @@ -7,8 +7,7 @@ class in mod.common.minecraftEnum 实体类型枚举 - 备注 - - 当实体行为包内使用[runtime_identifier](https://mc.163.com/dev/mcmanual/mc-dev/mconline/100-%E5%8E%86%E5%8F%B2%E5%BD%92%E6%A1%A3%E6%95%99%E7%A8%8B/15-%E7%8E%A9%E6%B3%95%E7%BB%84%E4%BB%B6%E6%95%99%E7%A8%8B%E3%80%90%E6%96%B0%E7%89%88%E3%80%91/7-%E8%87%AA%E5%AE%9A%E4%B9%89%E5%AE%9E%E4%BD%93/4-%E6%8E%A2%E7%B4%A2%E5%AE%9E%E4%BD%93%E7%9A%84%E8%A1%8C%E4%B8%BA%E6%96%87%E4%BB%B6.html#%E7%90%86%E8%A7%A3%E5%AE%9E%E4%BD%93%E8%A1%8C%E4%B8%BA%E7%9A%84%E6%8F%8F%E8%BF%B0%E4%BF%A1%E6%81%AF) - 字段继承某种实体的特征时，此时实体所属分类与runtime_indentifier所指向的实体相同。 + - 当实体行为包内使用[runtime_identifier](https://dev.mc.163.com/dev/mcmanual/mc-dev/mconline/15-%E7%8E%A9%E6%B3%95%E7%BB%84%E4%BB%B6%E6%95%99%E7%A8%8B/7-%E8%87%AA%E5%AE%9A%E4%B9%89%E5%AE%9E%E4%BD%93/4-%E6%8E%A2%E7%B4%A2%E5%AE%9E%E4%BD%93%E7%9A%84%E8%A1%8C%E4%B8%BA%E6%96%87%E4%BB%B6.html#%E7%90%86%E8%A7%A3%E5%AE%9E%E4%BD%93%E8%A1%8C%E4%B8%BA%E7%9A%84%E6%8F%8F%E8%BF%B0%E4%BF%A1%E6%81%AF)字段继承某种实体的特征时，此时实体所属分类与runtime_indentifier所指向的实体相同。 - 自定义实体未使用runtime_identifier字段时该实体默认只属于Mob类。 - 在控制台打印枚举值为位运算结果，例如，EntityType.Zombie 输出为 199456。 @@ -161,6 +160,12 @@ class EntityType(object): TraderLlama = 137 | Llama # 行商羊驼 Camel = 138 | Animal # 骆驼 Sniffer = 139 | Animal # 嗅探兽 + Breeze = 140 | Monster # 旋风人 + BreezeWindChargeProjectile = 141 | Projectile # 旋风人风弹 + Armadillo = 142 | Animal # 犰狳 + WindChargeProjectile = 143 | Projectile # 风弹 + Bogged = 144 | SkeletonMonster # 沼骸 + OminousItemSpawner = 145 # 不祥之物生成器 CustomProjectile = 254 | Projectile # 自定义抛射物 EntityExtension = 255 # 实体扩展 MAX_ENTITY_ID = 256 # 最大实体ID diff --git a/docs/mcdocs/1-ModAPI/枚举值/ItemUseMethodEnum.md b/docs/mcdocs/1-ModAPI/枚举值/ItemUseMethodEnum.md index 119df0da..6e740b3f 100644 --- a/docs/mcdocs/1-ModAPI/枚举值/ItemUseMethodEnum.md +++ b/docs/mcdocs/1-ModAPI/枚举值/ItemUseMethodEnum.md @@ -27,6 +27,7 @@ class ItemUseMethodEnum(object): Dyed = 13 # 使用炼药锅对物品染色 Traded = 14 # 交易 BrushingCompleted = 15 # 刷子清刷完毕 + OpenedVault = 16 # 打开宝库 ``` diff --git a/docs/mcdocs/1-ModAPI/枚举值/OpenContainerId.md b/docs/mcdocs/1-ModAPI/枚举值/OpenContainerId.md index 02b2f402..d5b45d29 100644 --- a/docs/mcdocs/1-ModAPI/枚举值/OpenContainerId.md +++ b/docs/mcdocs/1-ModAPI/枚举值/OpenContainerId.md @@ -29,6 +29,8 @@ class OpenContainerId(object): CreatedOutputContainer = 61 # 创造输出位(目前无用) SmithingTableTemplateContainer = 62 # 锻造台模板位 CrafterLevelEntityContainer = 63 # 合成器输入位 + NeteaseContainer = 64 # 自定义方块容器槽位 (关闭后放入物品数据存于方块实体中) + NeteaseUIContainer = 65 # 网易UI槽位 (数据存于玩家中，关闭ui后放入物品返回背包) ``` diff --git a/docs/mcdocs/1-ModAPI/枚举值/OriginGUIName.md b/docs/mcdocs/1-ModAPI/枚举值/OriginGUIName.md index ed206e07..6bf28f8b 100644 --- a/docs/mcdocs/1-ModAPI/枚举值/OriginGUIName.md +++ b/docs/mcdocs/1-ModAPI/枚举值/OriginGUIName.md @@ -24,7 +24,8 @@ class OriginGUIName(object): PauseBtn = "binding.area.pause" # 暂停键 ChatBtn = "binding.area.chat" # 聊天按钮 MenuBtn = "binding.area.fold_menu" # 菜单按钮(截图分享) - ReportBtn = "binding.area.report_cheat" # 举报按钮 + ReportBtn = "binding.area.report_cheat" # 举报按钮（已废弃） + CameraViewBtn = "binding.area.camera_view" # 摄像机视角按钮 DestroyOrAttackBtn = "binding.area.destroy_or_attack" # 破坏/攻击按钮 BuildOrInteractBtn = "binding.area.build_or_interact" # 建造/交互按钮 MoveStickBtn = "binding.area.default_move_stick_area" # 新触控摇杆按钮 diff --git a/docs/mcdocs/1-ModAPI/枚举值/StructureFeatureType.md b/docs/mcdocs/1-ModAPI/枚举值/StructureFeatureType.md index badc4c51..40548230 100644 --- a/docs/mcdocs/1-ModAPI/枚举值/StructureFeatureType.md +++ b/docs/mcdocs/1-ModAPI/枚举值/StructureFeatureType.md @@ -27,7 +27,8 @@ class StructureFeatureType(object): Bastion = 14 # 堡垒遗迹 AncientCity = 15 # 远古城市 TrailRuins = 16 # 古迹废墟 - NeteaseLargeFeature = 17 # 网易版大型结构特征 + TrialChambers = 17 # 试炼密室 + NeteaseLargeFeature = 18 # 网易版大型结构特征 ``` diff --git a/docs/mcdocs/1-ModAPI/枚举值/索引.md b/docs/mcdocs/1-ModAPI/枚举值/索引.md index 431140e1..7f3e867f 100644 --- a/docs/mcdocs/1-ModAPI/枚举值/索引.md +++ b/docs/mcdocs/1-ModAPI/枚举值/索引.md @@ -6,71 +6,70 @@ | 枚举值 | 描述 | | --- | --- | -| [ActorDamageCause](../枚举值/ActorDamageCause.md) | 描述实体伤害来源枚举值，及实体被伤害的原因。 | -| [AniCheatBlockBreak](../枚举值/AniCheatBlockBreak.md) | 反作弊配置枚举值，破坏方块相关 | -| [AniCheatConsts](../枚举值/AniCheatConsts.md) | 反作弊配置开关宏定义 | -| [AniCheatMove](../枚举值/AniCheatMove.md) | 反作弊配置枚举值，移动检查开关 | -| [AniCheatMoveRewind](../枚举值/AniCheatMoveRewind.md) | 反作弊配置枚举值，位移倒带模拟相关参数 | -| [AniCheatMoveUnSupportRewind](../枚举值/AniCheatMoveUnSupportRewind.md) | 反作弊配置枚举值，不支持倒带模拟的特殊场景相关参数 | -| [AnimationModeType](../枚举值/AnimationModeType.md) | 描述放置结构体时的动画模式 | -| [ArmorSlotType](../枚举值/ArmorSlotType.md) | 描述盔甲槽位枚举值 | -| [AttrType](../枚举值/AttrType.md) | 描述属性枚举值，用于设置与获取实体的引擎属性的当前值与最大值 | -| [AttributeBuffType](../枚举值/AttributeBuffType.md) | Buff状态类型枚举值 | -| [BiomeType](../枚举值/BiomeType.md) | 生物群系枚举 | -| [BlockBreathability](../枚举值/BlockBreathability.md) | 方块的可呼吸性 | -| [BrewingStandSlotType](../枚举值/BrewingStandSlotType.md) | 描述酿造台槽位 | -| [ButtonEventType](../枚举值/ButtonEventType.md) | 按钮事件枚举值 | -| [ButtonState](../枚举值/ButtonState.md) | 按钮状态枚举值 | -| [CatVariantType](../枚举值/CatVariantType.md) | 描述猫的变体种类 | -| [Change](../枚举值/Change.md) | 刷怪设置参数枚举，用于[SpawnCustomModule](../接口/世界/生物生成.md#spawncustommodule) | -| [ColorCode](../枚举值/ColorCode.md) | [样式代码](https://minecraft-zh.gamepedia.com/%E6%A0%B7%E5%BC%8F%E4%BB%A3%E7%A0%81) | -| [CommandBlockType](../枚举值/CommandBlockType.md) | 命令方块类型 | -| [ConditionType](../枚举值/ConditionType.md) | 命令方块条件类型 | -| [ContainerType](../枚举值/ContainerType.md) | 容器类型 | -| [EffectType](../枚举值/EffectType.md) | 描述特效类型的枚举值 | -| [EnchantSlotType](../枚举值/EnchantSlotType.md) | 附魔槽位枚举值 | -| [EnchantType](../枚举值/EnchantType.md) | 附魔类型枚举值 | -| [EntityColorType](../枚举值/EntityColorType.md) | 描述实体的颜色种类，截止至网易2.9版本，该枚举值应用于羊和热带鱼的颜色 | -| [EntityComponentType](../枚举值/EntityComponentType.md) | 原版实体组件类型,具体描述可参考[微软原版实体组件描述](https://learn.microsoft.com/en-us/minecraft/creator/reference/content/entityreference/examples/componentlist) | -| [EntityTeleportCause](../枚举值/EntityTeleportCause.md) | 传送理由枚举 | -| [EntityType](../枚举值/EntityType.md) | 实体类型枚举 | -| [Facing](../枚举值/Facing.md) | 朝向枚举值 | -| [FoxType](../枚举值/FoxType.md) | 描述狐狸的种类 | -| [GameDiffculty](../枚举值/GameDiffculty.md) | 描述游戏难度的枚举值 | -| [GameType](../枚举值/GameType.md) | 描述游戏类型的枚举值 | -| [GamepadKeyType](../枚举值/GamepadKeyType.md) | 描述游戏手柄的按键枚举值 | -| [HorseSpotType](../枚举值/HorseSpotType.md) | 描述马的斑点种类 | -| [HorseType](../枚举值/HorseType.md) | 描述马的变体颜色 | -| [InputMode](../枚举值/InputMode.md) | 控制器输入模式 | -| [InventoryType](../枚举值/InventoryType.md) | 原版分页类型的枚举值 | -| [ItemAcquisitionMethod](../枚举值/ItemAcquisitionMethod.md) | 获得物品的方法枚举值 | -| [ItemCategory](../枚举值/ItemCategory.md) | 物品所属创造栏类型 | -| [ItemColor](../枚举值/ItemColor.md) | 物品的颜色枚举值 | -| [ItemPosType](../枚举值/ItemPosType.md) | 描述玩家物品位置 | -| [ItemUseMethodEnum](../枚举值/ItemUseMethodEnum.md) | 使用物品的方法枚举值 | -| [KeyBoardType](../枚举值/KeyBoardType.md) | 描述PC端点击键盘输入的按钮枚举值 | -| [MirrorModeType](../枚举值/MirrorModeType.md) | 描述放置结构体时的镜像模式 | -| [OpenContainerId](../枚举值/OpenContainerId.md) | 开放容器Id | -| [OptionId](../枚举值/OptionId.md) | 可设置的枚举值 | -| [OriginGUIName](../枚举值/OriginGUIName.md) | 获取原生UI名字 | -| [PlayerActionType](../枚举值/PlayerActionType.md) | 玩家动作枚举 | -| [PlayerExhauseRatioType](../枚举值/PlayerExhauseRatioType.md) | 饥饿度消耗倍率类型 | -| [PlayerUISlot](../枚举值/PlayerUISlot.md) | 开放容器对应的slot偏移 | -| [RayFilterType](../枚举值/RayFilterType.md) | 射线检测类型 | -| [RedstoneModeType](../枚举值/RedstoneModeType.md) | 命令方块红石类型 | -| [RenderControllerArrayType](../枚举值/RenderControllerArrayType.md) | 渲染控制器字典中材质、贴图、模型的枚举值 | -| [RenderLayer](../枚举值/RenderLayer.md) | 方块渲染时的材质类型 | -| [SetBlockType](../枚举值/SetBlockType.md) | 方块设置的类型 | -| [SliderOptionId](../枚举值/SliderOptionId.md) | 滑动条设置选项枚举值 | -| [StructureFeatureType](../枚举值/StructureFeatureType.md) | 原版结构特征类型的枚举 | -| [TimeEaseType](../枚举值/TimeEaseType.md) | 时间变化类型 | -| [TouchEvent](../枚举值/TouchEvent.md) | 触摸回调事件枚举值 | -| [TradeLevelType](../枚举值/TradeLevelType.md) | 描述村民的交易等级 | -| [TransferServerFailReason](../枚举值/TransferServerFailReason.md) | 转服判定失败的错误码 | -| [UICategory](../枚举值/UICategory.md) | 原生UI类型名 | -| [UiBaseLayer](../枚举值/UiBaseLayer.md) | 自定义UI界面的层次宏定义，用于在多个插件之间协调UI界面的遮挡关系 | -| [UseAnimation](../枚举值/UseAnimation.md) | 使用物品时动画枚举值 | -| [VillagerClothingType](../枚举值/VillagerClothingType.md) | 描述v2版村民的衣服类型 | -| [VirtualWorldObjectType](../枚举值/VirtualWorldObjectType.md) | 虚拟世界对象类型 | -| [WalkState](../枚举值/WalkState.md) | 玩家行走模式 | +| [ActorDamageCause](ActorDamageCause.md) | 描述实体伤害来源枚举值，及实体被伤害的原因。 | +| [AniCheatBlockBreak](AniCheatBlockBreak.md) | 反作弊配置枚举值，破坏方块相关 | +| [AniCheatConsts](AniCheatConsts.md) | 反作弊配置开关宏定义 | +| [AniCheatMove](AniCheatMove.md) | 反作弊配置枚举值，移动检查开关 | +| [AniCheatMoveRewind](AniCheatMoveRewind.md) | 反作弊配置枚举值，位移倒带模拟相关参数 | +| [AnimationModeType](AnimationModeType.md) | 描述放置结构体时的动画模式 | +| [ArmorSlotType](ArmorSlotType.md) | 描述盔甲槽位枚举值 | +| [AttrType](AttrType.md) | 描述属性枚举值，用于设置与获取实体的引擎属性的当前值与最大值 | +| [AttributeBuffType](AttributeBuffType.md) | Buff状态类型枚举值 | +| [BiomeType](BiomeType.md) | 生物群系枚举 | +| [BlockBreathability](BlockBreathability.md) | 方块的可呼吸性 | +| [BrewingStandSlotType](BrewingStandSlotType.md) | 描述酿造台槽位 | +| [ButtonEventType](ButtonEventType.md) | 按钮事件枚举值 | +| [ButtonState](ButtonState.md) | 按钮状态枚举值 | +| [CatVariantType](CatVariantType.md) | 描述猫的变体种类 | +| [Change](Change.md) | 刷怪设置参数枚举，用于[SpawnCustomModule](../接口/世界/生物生成.md#spawncustommodule) | +| [ColorCode](ColorCode.md) | [样式代码](https://zh.minecraft.wiki/w/%E6%A0%BC%E5%BC%8F%E5%8C%96%E4%BB%A3%E7%A0%81) | +| [CommandBlockType](CommandBlockType.md) | 命令方块类型 | +| [ConditionType](ConditionType.md) | 命令方块条件类型 | +| [ContainerType](ContainerType.md) | 容器类型 | +| [EffectType](EffectType.md) | 描述特效类型的枚举值 | +| [EnchantSlotType](EnchantSlotType.md) | 附魔槽位枚举值 | +| [EnchantType](EnchantType.md) | 附魔类型枚举值 | +| [EntityColorType](EntityColorType.md) | 描述实体的颜色种类，截止至网易2.9版本，该枚举值应用于羊和热带鱼的颜色 | +| [EntityComponentType](EntityComponentType.md) | 原版实体组件类型,具体描述可参考[微软原版实体组件描述](https://learn.microsoft.com/en-us/minecraft/creator/reference/content/entityreference/examples/componentlist) | +| [EntityTeleportCause](EntityTeleportCause.md) | 传送理由枚举 | +| [EntityType](EntityType.md) | 实体类型枚举 | +| [Facing](Facing.md) | 朝向枚举值 | +| [FoxType](FoxType.md) | 描述狐狸的种类 | +| [GameDiffculty](GameDiffculty.md) | 描述游戏难度的枚举值 | +| [GameType](GameType.md) | 描述游戏类型的枚举值 | +| [GamepadKeyType](GamepadKeyType.md) | 描述游戏手柄的按键枚举值 | +| [HorseSpotType](HorseSpotType.md) | 描述马的斑点种类 | +| [HorseType](HorseType.md) | 描述马的变体颜色 | +| [InputMode](InputMode.md) | 控制器输入模式 | +| [InventoryType](InventoryType.md) | 原版分页类型的枚举值 | +| [ItemAcquisitionMethod](ItemAcquisitionMethod.md) | 获得物品的方法枚举值 | +| [ItemCategory](ItemCategory.md) | 物品所属创造栏类型 | +| [ItemColor](ItemColor.md) | 物品的颜色枚举值 | +| [ItemPosType](ItemPosType.md) | 描述玩家物品位置 | +| [ItemUseMethodEnum](ItemUseMethodEnum.md) | 使用物品的方法枚举值 | +| [KeyBoardType](KeyBoardType.md) | 描述PC端点击键盘输入的按钮枚举值 | +| [MirrorModeType](MirrorModeType.md) | 描述放置结构体时的镜像模式 | +| [OpenContainerId](OpenContainerId.md) | 开放容器Id | +| [OptionId](OptionId.md) | 可设置的枚举值 | +| [OriginGUIName](OriginGUIName.md) | 获取原生UI名字 | +| [PlayerActionType](PlayerActionType.md) | 玩家动作枚举 | +| [PlayerExhauseRatioType](PlayerExhauseRatioType.md) | 饥饿度消耗倍率类型 | +| [PlayerUISlot](PlayerUISlot.md) | 开放容器对应的slot偏移 | +| [RayFilterType](RayFilterType.md) | 射线检测类型 | +| [RedstoneModeType](RedstoneModeType.md) | 命令方块红石类型 | +| [RenderControllerArrayType](RenderControllerArrayType.md) | 渲染控制器字典中材质、贴图、模型的枚举值 | +| [RenderLayer](RenderLayer.md) | 方块渲染时的材质类型 | +| [SetBlockType](SetBlockType.md) | 方块设置的类型 | +| [SliderOptionId](SliderOptionId.md) | 滑动条设置选项枚举值 | +| [StructureFeatureType](StructureFeatureType.md) | 原版结构特征类型的枚举 | +| [TimeEaseType](TimeEaseType.md) | 时间变化类型 | +| [TouchEvent](TouchEvent.md) | 触摸回调事件枚举值 | +| [TradeLevelType](TradeLevelType.md) | 描述村民的交易等级 | +| [TransferServerFailReason](TransferServerFailReason.md) | 转服判定失败的错误码 | +| [UICategory](UICategory.md) | 原生UI类型名 | +| [UiBaseLayer](UiBaseLayer.md) | 自定义UI界面的层次宏定义，用于在多个插件之间协调UI界面的遮挡关系 | +| [UseAnimation](UseAnimation.md) | 使用物品时动画枚举值 | +| [VillagerClothingType](VillagerClothingType.md) | 描述v2版村民的衣服类型 | +| [VirtualWorldObjectType](VirtualWorldObjectType.md) | 虚拟世界对象类型 | +| [WalkState](WalkState.md) | 玩家行走模式 | diff --git a/docs/mcdocs/2-Apollo/0-Apollo更新信息.md b/docs/mcdocs/2-Apollo/0-Apollo更新信息.md index 45d0dd17..83442147 100644 --- a/docs/mcdocs/2-Apollo/0-Apollo更新信息.md +++ b/docs/mcdocs/2-Apollo/0-Apollo更新信息.md @@ -1,5 +1,102 @@ # Apollo更新信息 +## 2025.06.17 更新内容 +1. 发布Apollo 3.4正式版 + + 引擎app_verion（deploy.json中需要配置引擎app_verion）分别是： + + | | app_verion | + | ------- | --------------------- | + | game | 3.4.0.release20250617 | + | proxy | 3.4.0.release20250617 | + | master | 3.4.0.release20250617 | + | service | 3.4.0.release20250617 | + +2. 发布Apollo2.0 3.4正式包 + + 引擎及插件版本分别是： + + | | app_verion | + | ---------------- | -------------------------- | + | proxy | 3.4.0.java.release20250617 | + | master | 3.4.0.java.release20250617 | + | geyser | 3.4.0.java.release20250617 | + | BungeeMaster插件 | 1.0.2-SNAPSHOT | + | SpigotMaster插件 | 1.3.13-SNAPSHOT | + + 其他插件版本要求： + + | | verion | + | ---------- | ------------------ | + | BungeeCord | 1.20-R0.3-SNAPSHOT | + | ViaVersion | 5.2.1 | + + 注：由于Viaversion转换1.20.5版本头颅（模型）会过滤掉非法昵称的信息，导致自定义方块和中文昵称的头颅（模型）出错，因此无法直接使用官网版本。可选择MCS内容库中的“ViaVersion-5.2.1”资源或自行修改。 + +## 2025.05.21 更新内容 +1. 发布Apollo 3.4beta包 + + 引擎app_verion（deploy.json中需要配置引擎app_verion）分别是： + + | | app_verion | + | ------- | ------------------ | + | game | 3.4.0.beta20250521 | + | proxy | 3.4.0.beta20250521 | + | master | 3.4.0.beta20250521 | + | service | 3.4.0.beta20250521 | + +2. 发布Apollo2.0 3.4beta包 + + 引擎及插件版本分别是： + + | | app_verion | + | ---------------- | ----------------------- | + | proxy | 3.4.0.java.beta20250521 | + | master | 3.4.0.java.beta20250521 | + | geyser | 3.4.0.java.beta20250521 | + | BungeeMaster插件 | 1.0.2-SNAPSHOT | + | SpigotMaster插件 | 1.3.13-SNAPSHOT | + + 其他插件版本要求： + + | | verion | + | ---------- | ------------------ | + | BungeeCord | 1.20-R0.3-SNAPSHOT | + | ViaVersion | 5.2.1 | + + 注：由于Viaversion转换1.20.5版本头颅（模型）会过滤掉非法昵称的信息，导致自定义方块和中文昵称的头颅（模型）出错，因此无法直接使用官网版本。可选择MCS内容库中的“ViaVersion-5.2.1”资源或自行修改。 + +## 2025.03.28 更新内容 +1. 发布Apollo 3.3正式版 + + 引擎app_verion（deploy.json中需要配置引擎app_verion）分别是： + + | | app_verion | + | ------- | --------------------- | + | game | 3.3.0.release20250328 | + | proxy | 3.3.0.release20250328 | + | master | 3.3.0.release20250328 | + | service | 3.3.0.release20250328 | + +2. 发布Apollo2.0 3.3正式包 + + 引擎及插件版本分别是： + + | | app_verion | + | ---------------- | -------------------------- | + | proxy | 3.3.0.java.release20250328 | + | master | 3.3.0.java.release20250328 | + | geyser | 3.3.0.java.release20250328 | + | BungeeMaster插件 | 1.0.2-SNAPSHOT | + | SpigotMaster插件 | 1.3.13-SNAPSHOT | + + 其他插件版本要求： + + | | verion | + | ---------- | ------------------ | + | BungeeCord | 1.20-R0.3-SNAPSHOT | + | ViaVersion | 4.10.2 | + ## 2025.03.13 更新内容 1. 发布Apollo 3.3beta包