更新3.4API

This commit is contained in:
boybook
2025-06-27 23:59:47 +08:00
parent c0f98b179b
commit 12738a142c
52 changed files with 1146 additions and 292 deletions

View File

@@ -189,6 +189,8 @@ sidebarDepth: 1
| --- | --- | --- |
| [GetDirFromRot](通用/数学.md#getdirfromrot) | <span style="display:inline;color:#ff5555">服务端</span> | 通过旋转角度获取朝向 |
| [GetDirFromRot](通用/数学.md#getdirfromrot) | <span style="display:inline;color:#7575f9">客户端</span> | 通过旋转角度获取朝向 |
| [GetIntPos](通用/数学.md#getintpos) | <span style="display:inline;color:#ff5555">服务端</span> | 获取坐标所在方块的位置,即浮点数坐标向下取整后的整数坐标。 |
| [GetIntPos](通用/数学.md#getintpos) | <span style="display:inline;color:#7575f9">客户端</span> | 获取坐标所在方块的位置,即浮点数坐标向下取整后的整数坐标。 |
| [GetLocalPosFromWorld](通用/数学.md#getlocalposfromworld) | <span style="display:inline;color:#ff5555">服务端</span> | 获取基于实体的世界坐标对应的局部坐标 |
| [GetLocalPosFromWorld](通用/数学.md#getlocalposfromworld) | <span style="display:inline;color:#7575f9">客户端</span> | 获取基于实体的世界坐标对应的局部坐标 |
| [GetRotFromDir](通用/数学.md#getrotfromdir) | <span style="display:inline;color:#ff5555">服务端</span> | 通过朝向获取旋转角度 |
@@ -212,6 +214,8 @@ sidebarDepth: 1
| [GetChinese](通用/工具.md#getchinese) | <span style="display:inline;color:#7575f9">客户端</span> | 获取langStr对应的中文可参考PC开发包中\handheld\localization\handheld\data\resource_packs\vanilla\texts\zh_CN.lang |
| [GetClipboardContent](通用/工具.md#getclipboardcontent) | <span style="display:inline;color:#7575f9">客户端</span> | 获取系统剪贴板内容 |
| [GetFps](通用/工具.md#getfps) | <span style="display:inline;color:#7575f9">客户端</span> | 获取fps |
| [GetHostPlayerId](通用/工具.md#gethostplayerid) | <span style="display:inline;color:#ff5555">服务端</span> | 获取房主的entityId |
| [GetHostPlayerId](通用/工具.md#gethostplayerid) | <span style="display:inline;color:#7575f9">客户端</span> | 获取房主的entityId |
| [GetMinecraftEnum](通用/工具.md#getminecraftenum) | <span style="display:inline;color:#ff5555">服务端</span> | 用于获取[枚举值文档](通用/../../枚举值/索引.md)中的枚举值 |
| [GetMinecraftEnum](通用/工具.md#getminecraftenum) | <span style="display:inline;color:#7575f9">客户端</span> | 用于获取[枚举值文档](通用/../../枚举值/索引.md)中的枚举值 |
| [GetModConfigJson](通用/工具.md#getmodconfigjson) | <span style="display:inline;color:#7575f9">客户端</span> | 以字典形式返回指定路径的json格式配置文件的内容文件必须放置在资源包的/modconfigs目录下 |
@@ -296,13 +300,13 @@ sidebarDepth: 1
| [GetStructureSize](世界/地图.md#getstructuresize) | <span style="display:inline;color:#ff5555">服务端</span> | 获取结构体的长宽高 |
| [IsChunkGenerated](世界/地图.md#ischunkgenerated) | <span style="display:inline;color:#ff5555">服务端</span> | 获取某个区块是否生成过。 |
| [IsSlimeChunk](世界/地图.md#isslimechunk) | <span style="display:inline;color:#ff5555">服务端</span> | 获取某个区块是否是史莱姆区块。 |
| [LocateNeteaseFeatureRule](世界/地图.md#locateneteasefeaturerule) | <span style="display:inline;color:#ff5555">服务端</span> | 与[/locate指令](https://minecraft-zh.gamepedia.com/%E5%91%BD%E4%BB%A4/locate)相似,用于定位<a href="../../../mcguide/20-玩法开发/15-自定义游戏内容/4-自定义维度/4-自定义特征.html#特征规则feature-rules">网易自定义特征规则</a> |
| [LocateStructureFeature](世界/地图.md#locatestructurefeature) | <span style="display:inline;color:#ff5555">服务端</span> | 与[/locate指令](https://minecraft-zh.gamepedia.com/%E5%91%BD%E4%BB%A4/locate)相似,用于定位原版的部分结构,如海底神殿、末地城等。 |
| [LocateNeteaseFeatureRule](世界/地图.md#locateneteasefeaturerule) | <span style="display:inline;color:#ff5555">服务端</span> | 与[/locate指令](https://zh.minecraft.wiki/w/%E5%91%BD%E4%BB%A4/locate)相似,用于定位<a href="../../../mcguide/20-玩法开发/15-自定义游戏内容/4-自定义维度/4-自定义特征.html#特征规则feature-rules">网易自定义特征规则</a> |
| [LocateStructureFeature](世界/地图.md#locatestructurefeature) | <span style="display:inline;color:#ff5555">服务端</span> | 与[/locate指令](https://zh.minecraft.wiki/w/%E5%91%BD%E4%BB%A4/locate)相似,用于定位原版的部分结构,如海底神殿、末地城等。 |
| [MayPlace](世界/地图.md#mayplace) | <span style="display:inline;color:#ff5555">服务端</span> | 判断方块是否可以放置 |
| [MayPlaceOn](世界/地图.md#mayplaceon) | <span style="display:inline;color:#ff5555">服务端</span> | 判断物品是否可以放到指定的位置上 |
| [MirrorDimension](世界/地图.md#mirrordimension) | <span style="display:inline;color:#ff5555">服务端</span> | 复制不同dimension的地形 |
| [OpenClientChunkGeneration](世界/地图.md#openclientchunkgeneration) | <span style="display:inline;color:#ff5555">服务端</span> | 开启/关闭客户端区块生成功能需要在LoadServerAddonScriptsAfter事件触发时调用。开启客户端区块生成功能时如果使用了netease:structure_feature或修改了大部分地图会导致客户端和服务端地图不一致的问题。此时可以通过关闭客户端区块生成功能解决该问题。 |
| [PlaceFeature](世界/地图.md#placefeature) | <span style="display:inline;color:#ff5555">服务端</span> | 放置特征,与[/placefeature指令](https://minecraft.fandom.com/zh/wiki/%E5%91%BD%E4%BB%A4/placefeature)相似 |
| [PlaceFeature](世界/地图.md#placefeature) | <span style="display:inline;color:#ff5555">服务端</span> | 放置特征,与[/placefeature指令](https://zh.minecraft.wiki/w/%E5%91%BD%E4%BB%A4/placefeature)相似 |
| [PlaceNeteaseLargeFeature](世界/地图.md#placeneteaselargefeature) | <span style="display:inline;color:#ff5555">服务端</span> | 放置<a href="../../../mcguide/20-玩法开发/15-自定义游戏内容/4-自定义维度/6-自定义大型特征.html#自定义大型特征">网易版大型结构特征</a> |
| [PlaceStructure](世界/地图.md#placestructure) | <span style="display:inline;color:#ff5555">服务端</span> | 放置结构 |
| [SetAddArea](世界/地图.md#setaddarea) | <span style="display:inline;color:#ff5555">服务端</span> | 设置区块的常加载 |
@@ -627,7 +631,7 @@ sidebarDepth: 1
| [SetMobStrengthMax](实体/属性.md#setmobstrengthmax) | <span style="display:inline;color:#ff5555">服务端</span> | 设置生物强度的最大值截止至网易2.9版本,只对羊驼有效,强度越大羊驼驮运的箱子时格子数量越多,[SetMobStrength](实体/属性.md#setmobstrength)无法超过SetMobStrengthMax的值。由于引擎限制在羊驼被打时候会reload组件strengthMax会恢复成llama.json中的配置值(minecraft:strength) |
| [SetName](实体/属性.md#setname) | <span style="display:inline;color:#ff5555">服务端</span> | 用于设置生物的自定义名称,跟原版命名牌作用相同,玩家和新版流浪商人暂不支持 |
| [SetOutOfControl](实体/属性.md#setoutofcontrol) | <span style="display:inline;color:#ff5555">服务端</span> | 设置实体是否处于失控状态截止至网易2.9版本,只对船有效 |
| [SetPersistent](实体/属性.md#setpersistent) | <span style="display:inline;color:#ff5555">服务端</span> | 设置实体不会因为离玩家太远而被[清除](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) | <span style="display:inline;color:#ff5555">服务端</span> | 设置实体不会因为离玩家太远而被[清除](https://zh.minecraft.wiki/w/%E7%94%9F%E6%88%90#%E6%B8%85%E9%99%A4) |
| [SetPlayerLookAtPos](实体/属性.md#setplayerlookatpos) | <span style="display:inline;color:#7575f9">客户端</span> | 设置本地玩家看向某个位置 |
| [SetPos](实体/属性.md#setpos) | <span style="display:inline;color:#ff5555">服务端</span> | 设置实体位置 |
| [SetRecoverTotalAirSupplyTime](实体/属性.md#setrecovertotalairsupplytime) | <span style="display:inline;color:#ff5555">服务端</span> | 设置恢复最大氧气量的时间,单位秒 |
@@ -635,7 +639,7 @@ sidebarDepth: 1
| [SetRot](实体/属性.md#setrot) | <span style="display:inline;color:#7575f9">客户端</span> | 设置实体头与水平方向的俯仰角度和竖直方向的旋转角度 <a href="../../../mcguide/20-玩法开发/10-基本概念/10-Vector3.html">MC坐标系说明</a> |
| [SetSheared](实体/属性.md#setsheared) | <span style="display:inline;color:#ff5555">服务端</span> | 设置实体是否被剃毛截止至网易2.9版本,只对羊有效 |
| [SetSitting](实体/属性.md#setsitting) | <span style="display:inline;color:#ff5555">服务端</span> | 设置生物是否坐下 |
| [SetSize](实体/属性.md#setsize) | <span style="display:inline;color:#ff5555">服务端</span> | 设置实体的包围盒 |
| [SetSize](实体/属性.md#setsize) | <span style="display:inline;color:#ff5555">服务端</span> | 设置实体的包围盒。设置过大会导致游戏卡顿。实体的scale的立方乘以包围盒的体积不可超过32768 |
| [SetTradeLevel](实体/属性.md#settradelevel) | <span style="display:inline;color:#ff5555">服务端</span> | 设置村民的交易等级 |
| [SetVariant](实体/属性.md#setvariant) | <span style="display:inline;color:#ff5555">服务端</span> | 设置实体的变种属性值 |
| [isEntityInLava](实体/属性.md#isentityinlava) | <span style="display:inline;color:#7575f9">客户端</span> | 实体是否在岩浆中 |
@@ -694,7 +698,7 @@ sidebarDepth: 1
| [SetEntityShareablesItems](实体/行为.md#setentityshareablesitems) | <span style="display:inline;color:#ff5555">服务端</span> | 设置生物可分享/可拾取的物品列表 |
| [SetEntityTamed](实体/行为.md#setentitytamed) | <span style="display:inline;color:#ff5555">服务端</span> | 设置生物驯服,需要配合 entityEvent组件使用。该类驯服不包含骑乘功能。 |
| [SetJumpPower](实体/行为.md#setjumppower) | <span style="display:inline;color:#ff5555">服务端</span> | 设置生物跳跃力度0.42表示正常水平 |
| [SetLeashHolder](实体/行为.md#setleashholder) | <span style="display:inline;color:#ff5555">服务端</span> | 为实体添加牵引者,与原版拴绳的作用相同,详见<a href="https://minecraft.fandom.com/zh/wiki/%E6%8B%B4%E7%BB%B3#%E6%8B%B4%E8%B5%B7%E7%94%9F%E7%89%A9">基岩版栓绳介绍</a> |
| [SetLeashHolder](实体/行为.md#setleashholder) | <span style="display:inline;color:#ff5555">服务端</span> | 为实体添加牵引者,与原版拴绳的作用相同,详见<a href="https://zh.minecraft.wiki/w/%E6%8B%B4%E7%BB%B3">基岩版栓绳介绍</a> |
| [SetLootDropped](实体/行为.md#setlootdropped) | <span style="display:inline;color:#ff5555">服务端</span> | 设置生物是否生成掉落物 |
| [SetMobKnockback](实体/行为.md#setmobknockback) | <span style="display:inline;color:#ff5555">服务端</span> | 设置击退的初始速度,需要考虑阻力的影响 |
| [SetMotion](实体/行为.md#setmotion) | <span style="display:inline;color:#ff5555">服务端</span> | 设置生物(不含玩家)的瞬时移动方向向量 |
@@ -864,6 +868,7 @@ sidebarDepth: 1
| [GetArmorValue](玩家/属性.md#getarmorvalue) | <span style="display:inline;color:#7575f9">客户端</span> | 获取玩家护甲值 |
| [GetEnchantmentSeed](玩家/属性.md#getenchantmentseed) | <span style="display:inline;color:#ff5555">服务端</span> | 获取玩家的附魔种子,该种子会决定附魔台上准备附魔的装备的附魔项 |
| [GetPlayerCurLevelExp](玩家/属性.md#getplayercurlevelexp) | <span style="display:inline;color:#7575f9">客户端</span> | 获取玩家当前等级需要的经验值 |
| [GetPlayerCurrentExhaustionValue](玩家/属性.md#getplayercurrentexhaustionvalue) | <span style="display:inline;color:#ff5555">服务端</span> | 获取玩家foodExhaustionLevel的当前消耗度。详见<a href="https://zh.minecraft.wiki/w/%E9%A5%A5%E9%A5%BF#%E6%9C%BA%E5%88%B6">消耗度介绍</a> |
| [GetPlayerExp](玩家/属性.md#getplayerexp) | <span style="display:inline;color:#ff5555">服务端</span> | 获取玩家当前等级下的经验值 |
| [GetPlayerExp](玩家/属性.md#getplayerexp) | <span style="display:inline;color:#7575f9">客户端</span> | 获取玩家当前等级下的经验值 |
| [GetPlayerHealthLevel](玩家/属性.md#getplayerhealthlevel) | <span style="display:inline;color:#ff5555">服务端</span> | 获取玩家健康临界值当饥饿值大于等于健康临界值时会自动恢复血量开启饥饿值且开启自然恢复时有效。原版默认值为18 |
@@ -879,6 +884,7 @@ sidebarDepth: 1
| [IsPlayerNaturalRegen](玩家/属性.md#isplayernaturalregen) | <span style="display:inline;color:#ff5555">服务端</span> | 是否开启玩家自然恢复,当饥饿值大于等于健康临界值时会自动恢复血量,开启饥饿值且开启自然恢复时有效。原版默认开启 |
| [IsPlayerNaturalStarve](玩家/属性.md#isplayernaturalstarve) | <span style="display:inline;color:#ff5555">服务端</span> | 是否开启玩家饥饿掉血,当饥饿值小于饥饿临界值时会自动恢复血量,开启饥饿值且开启饥饿掉血时有效。原版默认开启 |
| [SetEnchantmentSeed](玩家/属性.md#setenchantmentseed) | <span style="display:inline;color:#ff5555">服务端</span> | 设置玩家的附魔种子,该种子会决定附魔台上准备附魔的装备的附魔项 |
| [SetPlayerCurrentExhaustionValue](玩家/属性.md#setplayercurrentexhaustionvalue) | <span style="display:inline;color:#ff5555">服务端</span> | 设置玩家foodExhaustionLevel的当前消耗度。详见<a href="https://zh.minecraft.wiki/w/%E9%A5%A5%E9%A5%BF#%E6%9C%BA%E5%88%B6">消耗度介绍</a> |
| [SetPlayerHealthLevel](玩家/属性.md#setplayerhealthlevel) | <span style="display:inline;color:#ff5555">服务端</span> | 设置玩家健康临界值,当饥饿值大于等于健康临界值时会自动恢复血量,开启饥饿值且开启自然恢复时有效.原版默认值为18 |
| [SetPlayerHealthTick](玩家/属性.md#setplayerhealthtick) | <span style="display:inline;color:#ff5555">服务端</span> | 设置玩家自然恢复速度,当饥饿值大于等于健康临界值时会自动恢复血量,开启饥饿值且开启自然恢复时有效.原版默认值为80刻即每4秒恢复1点血量 |
| [SetPlayerHunger](玩家/属性.md#setplayerhunger) | <span style="display:inline;color:#ff5555">服务端</span> | 设置玩家饥饿度。 |
@@ -905,7 +911,7 @@ sidebarDepth: 1
| [EndSprinting](玩家/行为.md#endsprinting) | <span style="display:inline;color:#7575f9">客户端</span> | 使本地玩家结束向前疾跑/冲刺状态 |
| [GetEntityRider](玩家/行为.md#getentityrider) | <span style="display:inline;color:#ff5555">服务端</span> | 获取骑乘者正在骑乘的实体的id。 |
| [GetEntityRider](玩家/行为.md#getentityrider) | <span style="display:inline;color:#7575f9">客户端</span> | 获取骑乘者正在骑乘的实体的id。 |
| [GetInteracteCenterOffset](玩家/行为.md#getinteractecenteroffset) | <span style="display:inline;color:#ff5555">服务端</span> | 获取玩家[服务端交互中心](../../1-ModAPI/更新信息/2.8.md#玩家摄像机)的偏移 |
| [GetInteracteCenterOffset](玩家/行为.md#getinteractecenteroffset) | <span style="display:inline;color:#ff5555">服务端</span> | 获取玩家[服务端交互中心](玩家/../../更新信息/2.8.md#玩家摄像机)的偏移 |
| [GetIsBlocking](玩家/行为.md#getisblocking) | <span style="display:inline;color:#ff5555">服务端</span> | 获取玩家激活盾牌状态 |
| [GetPickCenterOffset](玩家/行为.md#getpickcenteroffset) | <span style="display:inline;color:#7575f9">客户端</span> | 获取玩家设置的第三人称下客户端交互中心的偏移 |
| [GetPickRange](玩家/行为.md#getpickrange) | <span style="display:inline;color:#7575f9">客户端</span> | 获取玩家客户端的交互距离 |
@@ -917,8 +923,8 @@ sidebarDepth: 1
| [GetPlayerRespawnPos](玩家/行为.md#getplayerrespawnpos) | <span style="display:inline;color:#ff5555">服务端</span> | 获取玩家复活点 |
| [GetRelevantPlayer](玩家/行为.md#getrelevantplayer) | <span style="display:inline;color:#ff5555">服务端</span> | 获取附近玩家id列表 |
| [IsEntityRiding](玩家/行为.md#isentityriding) | <span style="display:inline;color:#ff5555">服务端</span> | 检查玩家是否骑乘。 |
| [IsInScaffolding](玩家/行为.md#isinscaffolding) | <span style="display:inline;color:#7575f9">客户端</span> | 获取玩家是否脚手架有交叉 |
| [IsOnLadder](玩家/行为.md#isonladder) | <span style="display:inline;color:#7575f9">客户端</span> | 获取玩家是否梯子/藤蔓有交叉 |
| [IsInScaffolding](玩家/行为.md#isinscaffolding) | <span style="display:inline;color:#7575f9">客户端</span> | 获取玩家是否脚手架 |
| [IsOnLadder](玩家/行为.md#isonladder) | <span style="display:inline;color:#7575f9">客户端</span> | 获取玩家是否梯子/藤蔓 |
| [IsPlayerCanFly](玩家/行为.md#isplayercanfly) | <span style="display:inline;color:#ff5555">服务端</span> | 获取玩家能否飞行 |
| [IsPlayerFlying](玩家/行为.md#isplayerflying) | <span style="display:inline;color:#ff5555">服务端</span> | 获取玩家是否在飞行 |
| [OpenWorkBench](玩家/行为.md#openworkbench) | <span style="display:inline;color:#ff5555">服务端</span> | 在玩家当前位置打开工作台UI不依赖于工作台方块 |
@@ -1389,7 +1395,7 @@ sidebarDepth: 1
| [SetAnimationBoneMask](模型.md#setanimationbonemask) | <span style="display:inline;color:#7575f9">客户端</span> | 设置是否屏蔽动画中指定的骨骼的动画,若开启骨骼屏蔽后,该骨骼将不再播放该动画中的动作。通过屏蔽指定骨骼的动画可实现同一个骨骼模型同时在不同骨骼上播放不同的动作动画,从而实现快捷的动作融合。 |
| [SetBrightness](模型.md#setbrightness) | <span style="display:inline;color:#7575f9">客户端</span> | 设置实体的亮度 |
| [SetEntityOpacity](模型.md#setentityopacity) | <span style="display:inline;color:#7575f9">客户端</span> | 设置骨骼模型的透明度,只能对骨骼模型生效,如果设置的是原版模型,则模型的影子会被隐藏。 |
| [SetEntityScale](模型.md#setentityscale) | <span style="display:inline;color:#ff5555">服务端</span> | 设置实体的放缩比例大小设置比例过大会导致游戏卡顿建议控制在20倍以内 |
| [SetEntityScale](模型.md#setentityscale) | <span style="display:inline;color:#ff5555">服务端</span> | 设置实体的放缩比例大小设置比例过大会导致游戏卡顿建议控制在20倍以内。实体的scale的立方乘以包围盒的体积不可超过32768 |
| [SetEntityShadowShow](模型.md#setentityshadowshow) | <span style="display:inline;color:#7575f9">客户端</span> | 设置实体打开/关闭影子渲染 |
| [SetExtraUniformValue](模型.md#setextrauniformvalue) | <span style="display:inline;color:#7575f9">客户端</span> | 设置shader中特定Uniform的值 |
| [SetFreeModelAniSpeed](模型.md#setfreemodelanispeed) | <span style="display:inline;color:#7575f9">客户端</span> | 设置自由模型动画的播放速度 |
@@ -1444,7 +1450,7 @@ sidebarDepth: 1
| [HideReportGUI](原生UI.md#hidereportgui) | <span style="display:inline;color:#7575f9">客户端</span> | 隐藏举报按钮原生UI。 |
| [HideSlotBarGui](原生UI.md#hideslotbargui) | <span style="display:inline;color:#7575f9">客户端</span> | 隐藏游戏中底部中间的物品栏界面 |
| [HideSneakGui](原生UI.md#hidesneakgui) | <span style="display:inline;color:#7575f9">客户端</span> | 隐藏游戏中左下角方向键的中心处潜行按钮。隐藏后点击相应位置不会响应 |
| [HideSwimGui](原生UI.md#hideswimgui) | <span style="display:inline;color:#7575f9">客户端</span> | 隐藏游戏中的浮潜按钮。隐藏后点击相应位置不会响应。仅影响十字键操作下的浮潜按钮,摇杆模式上浮=跳跃,下潜=潜行需要通过HideJumpGui和HideSneakGui来隐藏 |
| [HideSwimGui](原生UI.md#hideswimgui) | <span style="display:inline;color:#7575f9">客户端</span> | 隐藏游戏中的浮潜按钮。隐藏后点击相应位置不会响应。 |
| [HideVoiceGUI](原生UI.md#hidevoicegui) | <span style="display:inline;color:#7575f9">客户端</span> | 隐藏语音按钮原生UI。该接口在开启新版聊天时不生效 |
| [HideWalkGui](原生UI.md#hidewalkgui) | <span style="display:inline;color:#7575f9">客户端</span> | 隐藏游戏中跑/走按钮。隐藏后点击相应位置不会响应 |
| [OpenChatGui](原生UI.md#openchatgui) | <span style="display:inline;color:#7575f9">客户端</span> | 打开原版聊天栏 |
@@ -1579,6 +1585,7 @@ sidebarDepth: 1
| [GetOrientation](自定义UI/UI控件.md#getorientation) | <span style="display:inline;color:#7575f9">客户端</span> | 获取stackPanel的排列方向 |
| [GetPath](自定义UI/UI控件.md#getpath) | <span style="display:inline;color:#7575f9">客户端</span> | 返回当前控件的相对路径,路径从画布节点开始算起 |
| [GetPosition](自定义UI/UI控件.md#getposition) | <span style="display:inline;color:#7575f9">客户端</span> | 获取控件相对父节点的坐标 |
| [GetPropertyBag](自定义UI/UI控件.md#getpropertybag) | <span style="display:inline;color:#7575f9">客户端</span> | 获取PropertyBag |
| [GetRotateAngle](自定义UI/UI控件.md#getrotateangle) | <span style="display:inline;color:#7575f9">客户端</span> | 获取图片相对自身的旋转锚点旋转的角度 |
| [GetRotatePivot](自定义UI/UI控件.md#getrotatepivot) | <span style="display:inline;color:#7575f9">客户端</span> | 获取图片相对自身的旋转锚点 |
| [GetRotateRect](自定义UI/UI控件.md#getrotaterect) | <span style="display:inline;color:#7575f9">客户端</span> | 获取图片当前的四个边角点 |
@@ -1653,6 +1660,7 @@ sidebarDepth: 1
| [SetOffsetDelta](自定义UI/UI控件.md#setoffsetdelta) | <span style="display:inline;color:#7575f9">客户端</span> | 设置点击面板的拖拽偏移量 |
| [SetOrientation](自定义UI/UI控件.md#setorientation) | <span style="display:inline;color:#7575f9">客户端</span> | 设置stackPanel的排列方向 |
| [SetPosition](自定义UI/UI控件.md#setposition) | <span style="display:inline;color:#7575f9">客户端</span> | 设置控件相对父节点的坐标 |
| [SetPropertyBag](自定义UI/UI控件.md#setpropertybag) | <span style="display:inline;color:#7575f9">客户端</span> | 设置PropertyBag,将使用字典中的每个值来覆盖原本PropertyBag中的值 |
| [SetRotatePivot](自定义UI/UI控件.md#setrotatepivot) | <span style="display:inline;color:#7575f9">客户端</span> | 设置图片自身旋转锚点,该点并不是固定的点,而是相对于自身位置的点 |
| [SetScrollViewPercentValue](自定义UI/UI控件.md#setscrollviewpercentvalue) | <span style="display:inline;color:#7575f9">客户端</span> | 设置当前scroll_view内容的百分比位置 |
| [SetScrollViewPos](自定义UI/UI控件.md#setscrollviewpos) | <span style="display:inline;color:#7575f9">客户端</span> | 设置当前scroll_view内容的位置 |

View File

@@ -202,7 +202,7 @@ method in mod.server.component.explosionCompServer.ExplosionComponentServer
| 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
| :--- | :--- | :--- |
| 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)相似,用于定位<a href="../../../../mcguide/20-玩法开发/15-自定义游戏内容/4-自定义维度/4-自定义特征.html#特征规则feature-rules">网易自定义特征规则</a>
与[/locate指令](https://zh.minecraft.wiki/w/%E5%91%BD%E4%BB%A4/locate)相似,用于定位<a href="../../../../mcguide/20-玩法开发/15-自定义游戏内容/4-自定义维度/4-自定义特征.html#特征规则feature-rules">网易自定义特征规则</a>
- 参数
@@ -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将失效
- 示例

View File

@@ -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时按原版采集逻辑进行经验球掉落如矿石类方块会产生随机数量的经验球 |
- 返回值

View File

@@ -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%的性能消耗。 |
- 返回值

View File

@@ -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),默认为白色 |
- 返回值

View File

@@ -60,13 +60,13 @@ sidebarDepth: 1
| [GetStructureSize](地图.md#getstructuresize) | <span style="display:inline;color:#ff5555">服务端</span> | 获取结构体的长宽高 |
| [IsChunkGenerated](地图.md#ischunkgenerated) | <span style="display:inline;color:#ff5555">服务端</span> | 获取某个区块是否生成过。 |
| [IsSlimeChunk](地图.md#isslimechunk) | <span style="display:inline;color:#ff5555">服务端</span> | 获取某个区块是否是史莱姆区块。 |
| [LocateNeteaseFeatureRule](地图.md#locateneteasefeaturerule) | <span style="display:inline;color:#ff5555">服务端</span> | 与[/locate指令](https://minecraft-zh.gamepedia.com/%E5%91%BD%E4%BB%A4/locate)相似,用于定位<a href="../../../../mcguide/20-玩法开发/15-自定义游戏内容/4-自定义维度/4-自定义特征.html#特征规则feature-rules">网易自定义特征规则</a> |
| [LocateStructureFeature](地图.md#locatestructurefeature) | <span style="display:inline;color:#ff5555">服务端</span> | 与[/locate指令](https://minecraft-zh.gamepedia.com/%E5%91%BD%E4%BB%A4/locate)相似,用于定位原版的部分结构,如海底神殿、末地城等。 |
| [LocateNeteaseFeatureRule](地图.md#locateneteasefeaturerule) | <span style="display:inline;color:#ff5555">服务端</span> | 与[/locate指令](https://zh.minecraft.wiki/w/%E5%91%BD%E4%BB%A4/locate)相似,用于定位<a href="../../../../mcguide/20-玩法开发/15-自定义游戏内容/4-自定义维度/4-自定义特征.html#特征规则feature-rules">网易自定义特征规则</a> |
| [LocateStructureFeature](地图.md#locatestructurefeature) | <span style="display:inline;color:#ff5555">服务端</span> | 与[/locate指令](https://zh.minecraft.wiki/w/%E5%91%BD%E4%BB%A4/locate)相似,用于定位原版的部分结构,如海底神殿、末地城等。 |
| [MayPlace](地图.md#mayplace) | <span style="display:inline;color:#ff5555">服务端</span> | 判断方块是否可以放置 |
| [MayPlaceOn](地图.md#mayplaceon) | <span style="display:inline;color:#ff5555">服务端</span> | 判断物品是否可以放到指定的位置上 |
| [MirrorDimension](地图.md#mirrordimension) | <span style="display:inline;color:#ff5555">服务端</span> | 复制不同dimension的地形 |
| [OpenClientChunkGeneration](地图.md#openclientchunkgeneration) | <span style="display:inline;color:#ff5555">服务端</span> | 开启/关闭客户端区块生成功能需要在LoadServerAddonScriptsAfter事件触发时调用。开启客户端区块生成功能时如果使用了netease:structure_feature或修改了大部分地图会导致客户端和服务端地图不一致的问题。此时可以通过关闭客户端区块生成功能解决该问题。 |
| [PlaceFeature](地图.md#placefeature) | <span style="display:inline;color:#ff5555">服务端</span> | 放置特征,与[/placefeature指令](https://minecraft.fandom.com/zh/wiki/%E5%91%BD%E4%BB%A4/placefeature)相似 |
| [PlaceFeature](地图.md#placefeature) | <span style="display:inline;color:#ff5555">服务端</span> | 放置特征,与[/placefeature指令](https://zh.minecraft.wiki/w/%E5%91%BD%E4%BB%A4/placefeature)相似 |
| [PlaceNeteaseLargeFeature](地图.md#placeneteaselargefeature) | <span style="display:inline;color:#ff5555">服务端</span> | 放置<a href="../../../../mcguide/20-玩法开发/15-自定义游戏内容/4-自定义维度/6-自定义大型特征.html#自定义大型特征">网易版大型结构特征</a> |
| [PlaceStructure](地图.md#placestructure) | <span style="display:inline;color:#ff5555">服务端</span> | 放置结构 |
| [SetAddArea](地图.md#setaddarea) | <span style="display:inline;color:#ff5555">服务端</span> | 设置区块的常加载 |

View File

@@ -37,7 +37,7 @@ sidebarDepth: 1
| [HideReportGUI](原生UI.md#hidereportgui) | <span style="display:inline;color:#7575f9">客户端</span> | 隐藏举报按钮原生UI。 |
| [HideSlotBarGui](原生UI.md#hideslotbargui) | <span style="display:inline;color:#7575f9">客户端</span> | 隐藏游戏中底部中间的物品栏界面 |
| [HideSneakGui](原生UI.md#hidesneakgui) | <span style="display:inline;color:#7575f9">客户端</span> | 隐藏游戏中左下角方向键的中心处潜行按钮。隐藏后点击相应位置不会响应 |
| [HideSwimGui](原生UI.md#hideswimgui) | <span style="display:inline;color:#7575f9">客户端</span> | 隐藏游戏中的浮潜按钮。隐藏后点击相应位置不会响应。仅影响十字键操作下的浮潜按钮,摇杆模式上浮=跳跃,下潜=潜行需要通过HideJumpGui和HideSneakGui来隐藏 |
| [HideSwimGui](原生UI.md#hideswimgui) | <span style="display:inline;color:#7575f9">客户端</span> | 隐藏游戏中的浮潜按钮。隐藏后点击相应位置不会响应。 |
| [HideVoiceGUI](原生UI.md#hidevoicegui) | <span style="display:inline;color:#7575f9">客户端</span> | 隐藏语音按钮原生UI。该接口在开启新版聊天时不生效 |
| [HideWalkGui](原生UI.md#hidewalkgui) | <span style="display:inline;color:#7575f9">客户端</span> | 隐藏游戏中跑/走按钮。隐藏后点击相应位置不会响应 |
| [OpenChatGui](原生UI.md#openchatgui) | <span style="display:inline;color:#7575f9">客户端</span> | 打开原版聊天栏 |
@@ -871,7 +871,7 @@ method in mod.client.extraClientApi
- 描述
隐藏游戏中的浮潜按钮。隐藏后点击相应位置不会响应。仅影响十字键操作下的浮潜按钮,摇杆模式上浮=跳跃,下潜=潜行需要通过HideJumpGui和HideSneakGui来隐藏
隐藏游戏中的浮潜按钮。隐藏后点击相应位置不会响应。
- 参数

View File

@@ -1508,7 +1508,7 @@ method in mod.server.component.entityDefinitionsCompServer.EntityDefinitionsComp
| bool | 是否为自然生成的调用失败返回None |
- 备注
- 一些自然生成的生物拥有持久性例如末影龙、随大型结构生成的生物则IsNaturallySpawned会返回False详见<a href="https://minecraft.fandom.com/zh/wiki/%E7%94%9F%E6%88%90#%E5%9F%BA%E5%B2%A9%E7%89%88_2">基岩版持久性生物介绍</a>
- 一些自然生成的生物拥有持久性例如末影龙、随大型结构生成的生物则IsNaturallySpawned会返回False详见<a href="https://zh.minecraft.wiki/w/%E7%94%9F%E6%88%90#%E5%9F%BA%E5%B2%A9%E7%89%88_2">基岩版持久性生物介绍</a>
- 示例
@@ -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
| 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
| :--- | :--- | :--- |
| 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
- 参数

View File

@@ -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

View File

@@ -119,7 +119,7 @@ sidebarDepth: 1
| [SetMobStrengthMax](属性.md#setmobstrengthmax) | <span style="display:inline;color:#ff5555">服务端</span> | 设置生物强度的最大值截止至网易2.9版本,只对羊驼有效,强度越大羊驼驮运的箱子时格子数量越多,[SetMobStrength](属性.md#setmobstrength)无法超过SetMobStrengthMax的值。由于引擎限制在羊驼被打时候会reload组件strengthMax会恢复成llama.json中的配置值(minecraft:strength) |
| [SetName](属性.md#setname) | <span style="display:inline;color:#ff5555">服务端</span> | 用于设置生物的自定义名称,跟原版命名牌作用相同,玩家和新版流浪商人暂不支持 |
| [SetOutOfControl](属性.md#setoutofcontrol) | <span style="display:inline;color:#ff5555">服务端</span> | 设置实体是否处于失控状态截止至网易2.9版本,只对船有效 |
| [SetPersistent](属性.md#setpersistent) | <span style="display:inline;color:#ff5555">服务端</span> | 设置实体不会因为离玩家太远而被[清除](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) | <span style="display:inline;color:#ff5555">服务端</span> | 设置实体不会因为离玩家太远而被[清除](https://zh.minecraft.wiki/w/%E7%94%9F%E6%88%90#%E6%B8%85%E9%99%A4) |
| [SetPlayerLookAtPos](属性.md#setplayerlookatpos) | <span style="display:inline;color:#7575f9">客户端</span> | 设置本地玩家看向某个位置 |
| [SetPos](属性.md#setpos) | <span style="display:inline;color:#ff5555">服务端</span> | 设置实体位置 |
| [SetRecoverTotalAirSupplyTime](属性.md#setrecovertotalairsupplytime) | <span style="display:inline;color:#ff5555">服务端</span> | 设置恢复最大氧气量的时间,单位秒 |
@@ -127,7 +127,7 @@ sidebarDepth: 1
| [SetRot](属性.md#setrot) | <span style="display:inline;color:#7575f9">客户端</span> | 设置实体头与水平方向的俯仰角度和竖直方向的旋转角度 <a href="../../../../mcguide/20-玩法开发/10-基本概念/10-Vector3.html">MC坐标系说明</a> |
| [SetSheared](属性.md#setsheared) | <span style="display:inline;color:#ff5555">服务端</span> | 设置实体是否被剃毛截止至网易2.9版本,只对羊有效 |
| [SetSitting](属性.md#setsitting) | <span style="display:inline;color:#ff5555">服务端</span> | 设置生物是否坐下 |
| [SetSize](属性.md#setsize) | <span style="display:inline;color:#ff5555">服务端</span> | 设置实体的包围盒 |
| [SetSize](属性.md#setsize) | <span style="display:inline;color:#ff5555">服务端</span> | 设置实体的包围盒。设置过大会导致游戏卡顿。实体的scale的立方乘以包围盒的体积不可超过32768 |
| [SetTradeLevel](属性.md#settradelevel) | <span style="display:inline;color:#ff5555">服务端</span> | 设置村民的交易等级 |
| [SetVariant](属性.md#setvariant) | <span style="display:inline;color:#ff5555">服务端</span> | 设置实体的变种属性值 |
| [isEntityInLava](属性.md#isentityinlava) | <span style="display:inline;color:#7575f9">客户端</span> | 实体是否在岩浆中 |
@@ -188,7 +188,7 @@ sidebarDepth: 1
| [SetEntityShareablesItems](行为.md#setentityshareablesitems) | <span style="display:inline;color:#ff5555">服务端</span> | 设置生物可分享/可拾取的物品列表 |
| [SetEntityTamed](行为.md#setentitytamed) | <span style="display:inline;color:#ff5555">服务端</span> | 设置生物驯服,需要配合 entityEvent组件使用。该类驯服不包含骑乘功能。 |
| [SetJumpPower](行为.md#setjumppower) | <span style="display:inline;color:#ff5555">服务端</span> | 设置生物跳跃力度0.42表示正常水平 |
| [SetLeashHolder](行为.md#setleashholder) | <span style="display:inline;color:#ff5555">服务端</span> | 为实体添加牵引者,与原版拴绳的作用相同,详见<a href="https://minecraft.fandom.com/zh/wiki/%E6%8B%B4%E7%BB%B3#%E6%8B%B4%E8%B5%B7%E7%94%9F%E7%89%A9">基岩版栓绳介绍</a> |
| [SetLeashHolder](行为.md#setleashholder) | <span style="display:inline;color:#ff5555">服务端</span> | 为实体添加牵引者,与原版拴绳的作用相同,详见<a href="https://zh.minecraft.wiki/w/%E6%8B%B4%E7%BB%B3">基岩版栓绳介绍</a> |
| [SetLootDropped](行为.md#setlootdropped) | <span style="display:inline;color:#ff5555">服务端</span> | 设置生物是否生成掉落物 |
| [SetMobKnockback](行为.md#setmobknockback) | <span style="display:inline;color:#ff5555">服务端</span> | 设置击退的初始速度,需要考虑阻力的影响 |
| [SetMotion](行为.md#setmotion) | <span style="display:inline;color:#ff5555">服务端</span> | 设置生物(不含玩家)的瞬时移动方向向量 |

View File

@@ -1951,7 +1951,7 @@ method in mod.server.component.entityDefinitionsCompServer.EntityDefinitionsComp
- 描述
为实体添加牵引者,与原版拴绳的作用相同,详见<a href="https://minecraft.fandom.com/zh/wiki/%E6%8B%B4%E7%BB%B3#%E6%8B%B4%E8%B5%B7%E7%94%9F%E7%89%A9">基岩版栓绳介绍</a>
为实体添加牵引者,与原版拴绳的作用相同,详见<a href="https://zh.minecraft.wiki/w/%E6%8B%B4%E7%BB%B3">基岩版栓绳介绍</a>
- 参数

View File

@@ -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及自定义方块的数据为了兼容原版nbttagPython对象在获取出来时会做一定的转换
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及自定义方块的数据为了兼容原版nbttagPython对象在获取出来时会做一定的转换
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或游戏崩溃

View File

@@ -46,7 +46,7 @@ sidebarDepth: 1
| [SetAnimationBoneMask](模型.md#setanimationbonemask) | <span style="display:inline;color:#7575f9">客户端</span> | 设置是否屏蔽动画中指定的骨骼的动画,若开启骨骼屏蔽后,该骨骼将不再播放该动画中的动作。通过屏蔽指定骨骼的动画可实现同一个骨骼模型同时在不同骨骼上播放不同的动作动画,从而实现快捷的动作融合。 |
| [SetBrightness](模型.md#setbrightness) | <span style="display:inline;color:#7575f9">客户端</span> | 设置实体的亮度 |
| [SetEntityOpacity](模型.md#setentityopacity) | <span style="display:inline;color:#7575f9">客户端</span> | 设置骨骼模型的透明度,只能对骨骼模型生效,如果设置的是原版模型,则模型的影子会被隐藏。 |
| [SetEntityScale](模型.md#setentityscale) | <span style="display:inline;color:#ff5555">服务端</span> | 设置实体的放缩比例大小设置比例过大会导致游戏卡顿建议控制在20倍以内 |
| [SetEntityScale](模型.md#setentityscale) | <span style="display:inline;color:#ff5555">服务端</span> | 设置实体的放缩比例大小设置比例过大会导致游戏卡顿建议控制在20倍以内。实体的scale的立方乘以包围盒的体积不可超过32768 |
| [SetEntityShadowShow](模型.md#setentityshadowshow) | <span style="display:inline;color:#7575f9">客户端</span> | 设置实体打开/关闭影子渲染 |
| [SetExtraUniformValue](模型.md#setextrauniformvalue) | <span style="display:inline;color:#7575f9">客户端</span> | 设置shader中特定Uniform的值 |
| [SetFreeModelAniSpeed](模型.md#setfreemodelanispeed) | <span style="display:inline;color:#7575f9">客户端</span> | 设置自由模型动画的播放速度 |
@@ -1375,7 +1375,7 @@ method in mod.server.component.scaleCompServer.ScaleComponentServer
- 描述
设置实体的放缩比例大小设置比例过大会导致游戏卡顿建议控制在20倍以内
设置实体的放缩比例大小设置比例过大会导致游戏卡顿建议控制在20倍以内。实体的scale的立方乘以包围盒的体积不可超过32768
- 参数

View File

@@ -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| 附魔槽位枚举标志 <a href="../../../mcguide/20-玩法开发/15-自定义游戏内容/11-自定义附魔文档.html">自定义附魔文档</a>
- 部分原版物品较为特殊,获取不到个别字段的返回值
方块类燃料获取不到燃料时长弓、弩获取不到武器攻击力蛋糕获取不到营养值和饱食度马铠获取不到防具防御力上述物品获取对应字段返回值为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| 附魔槽位枚举标志 <a href="../../../mcguide/20-玩法开发/15-自定义游戏内容/11-自定义附魔文档.html">自定义附魔文档</a>
- 部分原版物品较为特殊,获取不到个别字段的返回值
方块类燃料获取不到燃料时长弓、弩获取不到武器攻击力蛋糕获取不到营养值和饱食度马铠获取不到防具防御力上述物品获取对应字段返回值为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
```

View File

@@ -18,11 +18,11 @@ method in mod.client.component.particleEntityBindComp.ParticleEntityBindComp
| 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
| :--- | :--- | :--- |
| 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 |
- 返回值

View File

@@ -228,6 +228,36 @@ print(comp.GetPlayerCurLevelExp(playerId))
## GetPlayerCurrentExhaustionValue
<span style="display:inline;color:#ff5555">服务端</span>
method in mod.server.component.playerCompServer.PlayerCompServer
- 描述
获取玩家foodExhaustionLevel的当前消耗度。详见<a href="https://zh.minecraft.wiki/w/%E9%A5%A5%E9%A5%BF#%E6%9C%BA%E5%88%B6">消耗度介绍</a>
- 参数
- 返回值
| <div style="width: 4em">数据类型</div> | 说明 |
| :--- | :--- |
| float | 玩家foodExhaustionLevel的当前消耗度, |
- 示例
```python
import mod.server.extraServerApi as serverApi
comp = serverApi.GetEngineCompFactory().CreatePlayer(playerId)
value = comp.GetPlayerCurrentExhaustionValue()
```
## GetPlayerExp
<span style="display:inline;color:#ff5555">服务端</span><span style="display:inline;color:#7575f9">客户端</span>
@@ -699,6 +729,38 @@ comp.SetEnchantmentSeed(32)
## SetPlayerCurrentExhaustionValue
<span style="display:inline;color:#ff5555">服务端</span>
method in mod.server.component.playerCompServer.PlayerCompServer
- 描述
设置玩家foodExhaustionLevel的当前消耗度。详见<a href="https://zh.minecraft.wiki/w/%E9%A5%A5%E9%A5%BF#%E6%9C%BA%E5%88%B6">消耗度介绍</a>
- 参数
| 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
| :--- | :--- | :--- |
| value | float | 当前消耗度 |
- 返回值
| <div style="width: 4em">数据类型</div> | 说明 |
| :--- | :--- |
| bool | 是否设置成功 |
- 示例
```python
import mod.server.extraServerApi as serverApi
comp = serverApi.GetEngineCompFactory().CreatePlayer(playerId)
result = comp.SetPlayerCurrentExhaustionValue(2.0)
```
## SetPlayerHealthLevel
<span style="display:inline;color:#ff5555">服务端</span>

View File

@@ -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
| 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
| :--- | :--- | :--- |
| 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))
```

View File

@@ -370,8 +370,8 @@ method in mod.client.component.actorRenderCompClient.ActorRenderCompClient
| 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
| :--- | :--- | :--- |
| geometryKey | str | 贴图键 |
| geometryName | str | 贴图路径 |
| textureKey | str | 贴图键 |
| textureName | str | 贴图路径 |
- 返回值
@@ -620,7 +620,7 @@ method in mod.client.component.modelCompClient.ModelComponentClient
| 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
| :--- | :--- | :--- |
| 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键对应的贴图
- 示例

View File

@@ -27,6 +27,7 @@ sidebarDepth: 1
| [GetArmorValue](属性.md#getarmorvalue) | <span style="display:inline;color:#7575f9">客户端</span> | 获取玩家护甲值 |
| [GetEnchantmentSeed](属性.md#getenchantmentseed) | <span style="display:inline;color:#ff5555">服务端</span> | 获取玩家的附魔种子,该种子会决定附魔台上准备附魔的装备的附魔项 |
| [GetPlayerCurLevelExp](属性.md#getplayercurlevelexp) | <span style="display:inline;color:#7575f9">客户端</span> | 获取玩家当前等级需要的经验值 |
| [GetPlayerCurrentExhaustionValue](属性.md#getplayercurrentexhaustionvalue) | <span style="display:inline;color:#ff5555">服务端</span> | 获取玩家foodExhaustionLevel的当前消耗度。详见<a href="https://zh.minecraft.wiki/w/%E9%A5%A5%E9%A5%BF#%E6%9C%BA%E5%88%B6">消耗度介绍</a> |
| [GetPlayerExp](属性.md#getplayerexp) | <span style="display:inline;color:#ff5555">服务端</span> | 获取玩家当前等级下的经验值 |
| [GetPlayerExp](属性.md#getplayerexp) | <span style="display:inline;color:#7575f9">客户端</span> | 获取玩家当前等级下的经验值 |
| [GetPlayerHealthLevel](属性.md#getplayerhealthlevel) | <span style="display:inline;color:#ff5555">服务端</span> | 获取玩家健康临界值当饥饿值大于等于健康临界值时会自动恢复血量开启饥饿值且开启自然恢复时有效。原版默认值为18 |
@@ -42,6 +43,7 @@ sidebarDepth: 1
| [IsPlayerNaturalRegen](属性.md#isplayernaturalregen) | <span style="display:inline;color:#ff5555">服务端</span> | 是否开启玩家自然恢复,当饥饿值大于等于健康临界值时会自动恢复血量,开启饥饿值且开启自然恢复时有效。原版默认开启 |
| [IsPlayerNaturalStarve](属性.md#isplayernaturalstarve) | <span style="display:inline;color:#ff5555">服务端</span> | 是否开启玩家饥饿掉血,当饥饿值小于饥饿临界值时会自动恢复血量,开启饥饿值且开启饥饿掉血时有效。原版默认开启 |
| [SetEnchantmentSeed](属性.md#setenchantmentseed) | <span style="display:inline;color:#ff5555">服务端</span> | 设置玩家的附魔种子,该种子会决定附魔台上准备附魔的装备的附魔项 |
| [SetPlayerCurrentExhaustionValue](属性.md#setplayercurrentexhaustionvalue) | <span style="display:inline;color:#ff5555">服务端</span> | 设置玩家foodExhaustionLevel的当前消耗度。详见<a href="https://zh.minecraft.wiki/w/%E9%A5%A5%E9%A5%BF#%E6%9C%BA%E5%88%B6">消耗度介绍</a> |
| [SetPlayerHealthLevel](属性.md#setplayerhealthlevel) | <span style="display:inline;color:#ff5555">服务端</span> | 设置玩家健康临界值,当饥饿值大于等于健康临界值时会自动恢复血量,开启饥饿值且开启自然恢复时有效.原版默认值为18 |
| [SetPlayerHealthTick](属性.md#setplayerhealthtick) | <span style="display:inline;color:#ff5555">服务端</span> | 设置玩家自然恢复速度,当饥饿值大于等于健康临界值时会自动恢复血量,开启饥饿值且开启自然恢复时有效.原版默认值为80刻即每4秒恢复1点血量 |
| [SetPlayerHunger](属性.md#setplayerhunger) | <span style="display:inline;color:#ff5555">服务端</span> | 设置玩家饥饿度。 |
@@ -70,7 +72,7 @@ sidebarDepth: 1
| [EndSprinting](行为.md#endsprinting) | <span style="display:inline;color:#7575f9">客户端</span> | 使本地玩家结束向前疾跑/冲刺状态 |
| [GetEntityRider](行为.md#getentityrider) | <span style="display:inline;color:#ff5555">服务端</span> | 获取骑乘者正在骑乘的实体的id。 |
| [GetEntityRider](行为.md#getentityrider) | <span style="display:inline;color:#7575f9">客户端</span> | 获取骑乘者正在骑乘的实体的id。 |
| [GetInteracteCenterOffset](行为.md#getinteractecenteroffset) | <span style="display:inline;color:#ff5555">服务端</span> | 获取玩家[服务端交互中心](../../../1-ModAPI/更新信息/2.8.md#玩家摄像机)的偏移 |
| [GetInteracteCenterOffset](行为.md#getinteractecenteroffset) | <span style="display:inline;color:#ff5555">服务端</span> | 获取玩家[服务端交互中心](../../更新信息/2.8.md#玩家摄像机)的偏移 |
| [GetIsBlocking](行为.md#getisblocking) | <span style="display:inline;color:#ff5555">服务端</span> | 获取玩家激活盾牌状态 |
| [GetPickCenterOffset](行为.md#getpickcenteroffset) | <span style="display:inline;color:#7575f9">客户端</span> | 获取玩家设置的第三人称下客户端交互中心的偏移 |
| [GetPickRange](行为.md#getpickrange) | <span style="display:inline;color:#7575f9">客户端</span> | 获取玩家客户端的交互距离 |
@@ -82,8 +84,8 @@ sidebarDepth: 1
| [GetPlayerRespawnPos](行为.md#getplayerrespawnpos) | <span style="display:inline;color:#ff5555">服务端</span> | 获取玩家复活点 |
| [GetRelevantPlayer](行为.md#getrelevantplayer) | <span style="display:inline;color:#ff5555">服务端</span> | 获取附近玩家id列表 |
| [IsEntityRiding](行为.md#isentityriding) | <span style="display:inline;color:#ff5555">服务端</span> | 检查玩家是否骑乘。 |
| [IsInScaffolding](行为.md#isinscaffolding) | <span style="display:inline;color:#7575f9">客户端</span> | 获取玩家是否脚手架有交叉 |
| [IsOnLadder](行为.md#isonladder) | <span style="display:inline;color:#7575f9">客户端</span> | 获取玩家是否梯子/藤蔓有交叉 |
| [IsInScaffolding](行为.md#isinscaffolding) | <span style="display:inline;color:#7575f9">客户端</span> | 获取玩家是否脚手架 |
| [IsOnLadder](行为.md#isonladder) | <span style="display:inline;color:#7575f9">客户端</span> | 获取玩家是否梯子/藤蔓 |
| [IsPlayerCanFly](行为.md#isplayercanfly) | <span style="display:inline;color:#ff5555">服务端</span> | 获取玩家能否飞行 |
| [IsPlayerFlying](行为.md#isplayerflying) | <span style="display:inline;color:#ff5555">服务端</span> | 获取玩家是否在飞行 |
| [OpenWorkBench](行为.md#openworkbench) | <span style="display:inline;color:#ff5555">服务端</span> | 在玩家当前位置打开工作台UI不依赖于工作台方块 |

View File

@@ -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

View File

@@ -54,7 +54,7 @@ method in mod.client.ui.controls.minimapUIControl.MiniMapUIControl
| 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
| :--- | :--- | :--- |
| 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
<span style="display:inline;color:#7575f9">客户端</span>
method in mod.client.ui.controls.baseUIControl.BaseUIControl
- 描述
获取PropertyBag
- 参数
- 返回值
| <div style="width: 4em">数据类型</div> | 说明 |
| :--- | :--- |
| str | PropertyBag |
- 示例
```python
text2Path = "/panel/text2"
baseUIControl = uiNode.GetBaseUIControl(text2Path)
propertyBag = baseUIControl.GetPropertyBag()
```
## GetRotateAngle
<span style="display:inline;color:#7575f9">客户端</span>
@@ -4018,6 +4048,39 @@ baseUIControl.SetPosition(pos)
## SetPropertyBag
<span style="display:inline;color:#7575f9">客户端</span>
method in mod.client.ui.controls.baseUIControl.BaseUIControl
- 描述
设置PropertyBag,将使用字典中的每个值来覆盖原本PropertyBag中的值
- 参数
| 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
| :--- | :--- | :--- |
| params | dict | 需要设置的属性字典,字典键值对的值仅支持设置字符串、数字、布尔值类型,其余类型会导致设置失败 |
- 返回值
| <div style="width: 4em">数据类型</div> | 说明 |
| :--- | :--- |
| bool | 是否设置成功 |
- 示例
```python
text2Path = "/panel/text2"
baseUIControl = uiNode.GetBaseUIControl(text2Path)
params = {"text": "hello world", "number": 123, "boolean": True}
success = baseUIControl.SetPropertyBag(params)
```
## SetRotatePivot
<span style="display:inline;color:#7575f9">客户端</span>
@@ -4519,7 +4582,7 @@ method in mod.client.ui.controls.labelUIControl.LabelUIControl
| 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
| :--- | :--- | :--- |
| 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 |
- 返回值

View File

@@ -136,6 +136,7 @@ sidebarDepth: 1
| [GetOrientation](UI控件.md#getorientation) | <span style="display:inline;color:#7575f9">客户端</span> | 获取stackPanel的排列方向 |
| [GetPath](UI控件.md#getpath) | <span style="display:inline;color:#7575f9">客户端</span> | 返回当前控件的相对路径,路径从画布节点开始算起 |
| [GetPosition](UI控件.md#getposition) | <span style="display:inline;color:#7575f9">客户端</span> | 获取控件相对父节点的坐标 |
| [GetPropertyBag](UI控件.md#getpropertybag) | <span style="display:inline;color:#7575f9">客户端</span> | 获取PropertyBag |
| [GetRotateAngle](UI控件.md#getrotateangle) | <span style="display:inline;color:#7575f9">客户端</span> | 获取图片相对自身的旋转锚点旋转的角度 |
| [GetRotatePivot](UI控件.md#getrotatepivot) | <span style="display:inline;color:#7575f9">客户端</span> | 获取图片相对自身的旋转锚点 |
| [GetRotateRect](UI控件.md#getrotaterect) | <span style="display:inline;color:#7575f9">客户端</span> | 获取图片当前的四个边角点 |
@@ -210,6 +211,7 @@ sidebarDepth: 1
| [SetOffsetDelta](UI控件.md#setoffsetdelta) | <span style="display:inline;color:#7575f9">客户端</span> | 设置点击面板的拖拽偏移量 |
| [SetOrientation](UI控件.md#setorientation) | <span style="display:inline;color:#7575f9">客户端</span> | 设置stackPanel的排列方向 |
| [SetPosition](UI控件.md#setposition) | <span style="display:inline;color:#7575f9">客户端</span> | 设置控件相对父节点的坐标 |
| [SetPropertyBag](UI控件.md#setpropertybag) | <span style="display:inline;color:#7575f9">客户端</span> | 设置PropertyBag,将使用字典中的每个值来覆盖原本PropertyBag中的值 |
| [SetRotatePivot](UI控件.md#setrotatepivot) | <span style="display:inline;color:#7575f9">客户端</span> | 设置图片自身旋转锚点,该点并不是固定的点,而是相对于自身位置的点 |
| [SetScrollViewPercentValue](UI控件.md#setscrollviewpercentvalue) | <span style="display:inline;color:#7575f9">客户端</span> | 设置当前scroll_view内容的百分比位置 |
| [SetScrollViewPos](UI控件.md#setscrollviewpos) | <span style="display:inline;color:#7575f9">客户端</span> | 设置当前scroll_view内容的位置 |

View File

@@ -474,6 +474,66 @@ fps = comp.GetFps()
## GetHostPlayerId
<span style="display:inline;color:#ff5555">服务端</span><span style="display:inline;color:#7575f9">客户端</span>
### 服务端接口
<span id="s0"></span>
method in mod.server.extraServerApi
- 描述
获取房主的entityId
- 参数
- 返回值
| <div style="width: 4em">数据类型</div> | 说明 |
| :--- | :--- |
| str | 房主的entityId,若房主未加入则返回None |
- 示例
```python
import mod.server.extraServerApi as serverApi
serverApi.GetHostPlayerId()
```
### 客户端接口
<span id="c0"></span>
method in mod.client.extraClientApi
- 描述
获取房主的entityId
- 参数
- 返回值
| <div style="width: 4em">数据类型</div> | 说明 |
| :--- | :--- |
| str | 房主的entityId,若房主未加入则返回None |
- 示例
```python
import mod.client.extraClientApi as clientApi
clientApi.GetHostPlayerId()
```
## GetMinecraftEnum
<span style="display:inline;color:#ff5555">服务端</span><span style="display:inline;color:#7575f9">客户端</span>

View File

@@ -67,6 +67,70 @@ direction = clientApi.GetDirFromRot((0, 0))
## GetIntPos
<span style="display:inline;color:#ff5555">服务端</span><span style="display:inline;color:#7575f9">客户端</span>
### 服务端接口
<span id="s0"></span>
method in mod.server.extraServerApi
- 描述
获取坐标所在方块的位置,即浮点数坐标向下取整后的整数坐标。
- 参数
| 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
| :--- | :--- | :--- |
| pos | tuple(float,float,float) | 坐标元组 |
- 返回值
| <div style="width: 4em">数据类型</div> | 说明 |
| :--- | :--- |
| tuple(int,int,int) | 坐标所在方块的位置 |
- 示例
```python
import mod.server.extraServerApi as serverApi
serverApi.GetIntPos((1.2,1.3,1.4))
```
### 客户端接口
<span id="c0"></span>
method in mod.client.extraClientApi
- 描述
获取坐标所在方块的位置,即浮点数坐标向下取整后的整数坐标。
- 参数
| 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
| :--- | :--- | :--- |
| pos | tuple(float,float,float) | 坐标元组 |
- 返回值
| <div style="width: 4em">数据类型</div> | 说明 |
| :--- | :--- |
| tuple(int,int,int) | 坐标所在方块的位置 |
- 示例
```python
import mod.client.extraClientApi as clientApi
clientApi.GetIntPos((1.2,1.3,1.4))
```
## GetLocalPosFromWorld
<span style="display:inline;color:#ff5555">服务端</span><span style="display:inline;color:#7575f9">客户端</span>

View File

@@ -86,6 +86,8 @@ sidebarDepth: 1
| --- | --- | --- |
| [GetDirFromRot](数学.md#getdirfromrot) | <span style="display:inline;color:#ff5555">服务端</span> | 通过旋转角度获取朝向 |
| [GetDirFromRot](数学.md#getdirfromrot) | <span style="display:inline;color:#7575f9">客户端</span> | 通过旋转角度获取朝向 |
| [GetIntPos](数学.md#getintpos) | <span style="display:inline;color:#ff5555">服务端</span> | 获取坐标所在方块的位置,即浮点数坐标向下取整后的整数坐标。 |
| [GetIntPos](数学.md#getintpos) | <span style="display:inline;color:#7575f9">客户端</span> | 获取坐标所在方块的位置,即浮点数坐标向下取整后的整数坐标。 |
| [GetLocalPosFromWorld](数学.md#getlocalposfromworld) | <span style="display:inline;color:#ff5555">服务端</span> | 获取基于实体的世界坐标对应的局部坐标 |
| [GetLocalPosFromWorld](数学.md#getlocalposfromworld) | <span style="display:inline;color:#7575f9">客户端</span> | 获取基于实体的世界坐标对应的局部坐标 |
| [GetRotFromDir](数学.md#getrotfromdir) | <span style="display:inline;color:#ff5555">服务端</span> | 通过朝向获取旋转角度 |
@@ -111,6 +113,8 @@ sidebarDepth: 1
| [GetChinese](工具.md#getchinese) | <span style="display:inline;color:#7575f9">客户端</span> | 获取langStr对应的中文可参考PC开发包中\handheld\localization\handheld\data\resource_packs\vanilla\texts\zh_CN.lang |
| [GetClipboardContent](工具.md#getclipboardcontent) | <span style="display:inline;color:#7575f9">客户端</span> | 获取系统剪贴板内容 |
| [GetFps](工具.md#getfps) | <span style="display:inline;color:#7575f9">客户端</span> | 获取fps |
| [GetHostPlayerId](工具.md#gethostplayerid) | <span style="display:inline;color:#ff5555">服务端</span> | 获取房主的entityId |
| [GetHostPlayerId](工具.md#gethostplayerid) | <span style="display:inline;color:#7575f9">客户端</span> | 获取房主的entityId |
| [GetMinecraftEnum](工具.md#getminecraftenum) | <span style="display:inline;color:#ff5555">服务端</span> | 用于获取[枚举值文档](../../枚举值/索引.md)中的枚举值 |
| [GetMinecraftEnum](工具.md#getminecraftenum) | <span style="display:inline;color:#7575f9">客户端</span> | 用于获取[枚举值文档](../../枚举值/索引.md)中的枚举值 |
| [GetModConfigJson](工具.md#getmodconfigjson) | <span style="display:inline;color:#7575f9">客户端</span> | 以字典形式返回指定路径的json格式配置文件的内容文件必须放置在资源包的/modconfigs目录下 |