# API索引表
# 通用
# 世界
# 实体
# 玩家
# 方块
# 物品
# 特效
# 模型
# 原生UI
# 自定义UI
# 音效
# 控制
# 游戏设置
# 虚拟世界
# 后处理
# 联机大厅
# 成就
# 商城
# 魔法指令
# 字体
# Component
| 接口 | 描述 | |
|---|---|---|
| CreateComponent | 服务端 | 给实体创建服务端组件 |
| CreateComponent | 客户端 | 给实体创建客户端组件 |
| DestroyComponent | 服务端 | 删除实体的服务端组件 |
| DestroyComponent | 客户端 | 删除实体的客户端组件 |
| GetComponent | 服务端 | 获取实体的服务端组件。一般用来判断某个组件是否创建过，其他情况请使用CreateComponent |
| GetComponent | 客户端 | 获取实体的客户端组件。一般用来判断某个组件是否创建过，其他情况请使用CreateComponent |
| GetComponentCls | 服务端 | 用于获取服务器component基类。实现新的component时，需要继承该接口返回的类 |
| GetComponentCls | 客户端 | 用于获取客户端component基类。实现新的component时，需要继承该接口返回的类 |
| GetEngineCompFactory | 服务端 | 获取引擎组件的工厂，通过工厂可以创建服务端的引擎组件 |
| GetEngineCompFactory | 客户端 | 获取引擎组件的工厂，通过工厂可以创建客户端的引擎组件 |
| RegisterComponent | 服务端 | 用于将组件注册到引擎中 |
| RegisterComponent | 客户端 | 用于将组件注册到引擎中 |
# System
| 接口 | 描述 | |
|---|---|---|
| GetClientSystemCls | 客户端 | 用于获取客户端system基类。实现新的system时，需要继承该接口返回的类 |
| GetServerSystemCls | 服务端 | 用于获取服务器system基类。实现新的system时，需要继承该接口返回的类 |
| GetSystem | 服务端 | 获取已注册的系统 |
| GetSystem | 客户端 | 用于获取其他系统实例 |
| RegisterSystem | 服务端 | 用于将系统注册到引擎中，引擎会创建一个该系统的实例，并在退出游戏时回收。系统可以执行我们引擎赋予的基本逻辑，例如监听事件、执行Tick函数、与客户端进行通讯等。 |
| RegisterSystem | 客户端 | 用于将系统注册到引擎中，引擎会创建一个该系统的实例，并在退出游戏时回收。系统可以执行我们引擎赋予的基本逻辑，例如监听事件、执行Tick函数、与服务端进行通讯等。 |
# 事件
| 接口 | 描述 | |
|---|---|---|
| BroadcastEvent | 服务端 客户端 | 本地广播事件，客户端system广播的事件仅客户端system能监听，服务器system广播的事件仅服务端system能监听。 |
| BroadcastToAllClient | 服务端 | 服务器广播事件到所有客户端 |
| CreateEventData | 服务端 客户端 | 创建自定义事件的数据，eventData用于发送事件。创建的eventData可以理解为一个dict，可以嵌套赋值dict,list和基本数据类型，但不支持tuple |
| GetEngineNamespace | 服务端 | 获取引擎事件的命名空间。监听引擎事件时，namespace传该接口返回的namespace |
| GetEngineNamespace | 客户端 | 获取引擎事件的命名空间。监听引擎事件时，namespace传该接口返回的namespace |
| GetEngineSystemName | 服务端 | 获取引擎系统名。监听引擎事件时，systemName传该接口返回的systemName |
| GetEngineSystemName | 客户端 | 获取引擎系统名。监听引擎事件时，systemName传该接口返回的systemName |
| ListenForEvent | 服务端 客户端 | 注册监听某个系统抛出的事件。若监听引擎事件时，namespace和systemName分别为GetEngineNamespace()和GetEngineSystemName()。具体每个事件的详细事件data可以参考"事件"分类下的内容 |
| NotifyToClient | 服务端 | 服务器发送事件到指定客户端 |
| NotifyToMultiClients | 服务端 | 服务器发送事件到指定一批客户端，相比于在for循环内使用NotifyToClient性能更好 |
| NotifyToServer | 客户端 | 客户端发送事件到服务器 |
| UnListenAllEvents | 服务端 客户端 | 反注册监听某个系统抛出的所有事件，即不再监听。 |
| UnListenForEvent | 服务端 客户端 | 反注册监听某个系统抛出的事件，即不再监听。若是引擎事件，则namespace和systemName分别为GetEngineNamespace和GetEngineSystemName。与ListenForEvent对应。 |
# 本地设备
| 接口 | 描述 | |
|---|---|---|
| GetIP | 客户端 | 获取本地玩家的ip地址 |
| GetPlatform | 服务端 | 获取脚本运行的平台 |
| GetPlatform | 客户端 | 获取脚本运行的平台 |
| IsInApollo | 服务端 | 返回当前游戏Mod是否运行在Apollo网络服 |
| IsInServer | 服务端 | 获取当前游戏是否跑在服务器环境下 |
# 本地存储
| 接口 | 描述 | |
|---|---|---|
| GetConfigData | 客户端 | 获取本地配置文件中存储的数据 |
| SetConfigData | 客户端 | 以本地配置文件的方式存储数据 |
# 数学
| 接口 | 描述 | |
|---|---|---|
| GetDirFromRot | 服务端 | 通过旋转角度获取朝向 |
| GetDirFromRot | 客户端 | 通过旋转角度获取朝向 |
| GetLocalPosFromWorld | 服务端 | 获取基于实体的世界坐标对应的局部坐标 |
| GetLocalPosFromWorld | 客户端 | 获取基于实体的世界坐标对应的局部坐标 |
| GetRotFromDir | 服务端 | 通过朝向获取旋转角度 |
| GetRotFromDir | 客户端 | 通过朝向获取旋转角度 |
| GetWorldPosFromLocal | 服务端 | 获取基于实体的局部坐标对应的世界坐标 |
| GetWorldPosFromLocal | 客户端 | 获取基于实体的局部坐标对应的世界坐标 |
# 工具
| 接口 | 描述 | |
|---|---|---|
| AddRepeatedTimer | 服务端 | 添加服务端触发的定时器，重复执行 |
| AddRepeatedTimer | 客户端 | 添加客户端触发的定时器，重复执行 |
| AddTimer | 服务端 | 添加服务端触发的定时器，非重复 |
| AddTimer | 客户端 | 添加客户端触发的定时器，非重复 |
| CancelTimer | 服务端 | 取消定时器 |
| CancelTimer | 客户端 | 取消定时器 |
| CheckNameValid | 服务端 | 检查昵称是否合法，即不包含敏感词 |
| CheckNameValid | 客户端 | 检查昵称是否合法，即不包含敏感词 |
| CheckWordsValid | 服务端 | 检查语句是否合法，即不包含敏感词 |
| CheckWordsValid | 客户端 | 检查语句是否合法，即不包含敏感词 |
| GetChinese | 服务端 | 获取langStr对应的中文，可参考PC开发包中\handheld\localization\handheld\data\resource_packs\vanilla\texts\zh_CN.lang |
| GetChinese | 客户端 | 获取langStr对应的中文，可参考PC开发包中\handheld\localization\handheld\data\resource_packs\vanilla\texts\zh_CN.lang |
| GetFps | 客户端 | 获取fps |
| GetMinecraftEnum | 服务端 | 用于获取枚举值文档中的枚举值 |
| GetMinecraftEnum | 客户端 | 用于获取枚举值文档中的枚举值 |
| GetModConfigJson | 客户端 | 以字典形式返回指定路径的json格式配置文件的内容，文件必须放置在资源包的/modconfigs目录下 |
| GetServerTickTime | 服务端 | 获取服务端引擎上一帧的帧消耗时间 |
| ImportModule | 服务端 | 使用字符串路径导入模块，作用与importlib.import_module类似，但只能导入当前加载的mod中的模块 |
| ImportModule | 客户端 | 使用字符串路径导入模块，作用与importlib.import_module类似，但只能导入当前加载的mod中的模块 |
| StartCoroutine | 服务端 | 开启服务端协程，实现函数分段式执行，可用于缓解复杂逻辑计算导致游戏卡顿问题 |
| StartCoroutine | 客户端 | 开启客户端协程，实现函数分段式执行，可用于缓解复杂逻辑计算导致游戏卡顿问题 |
| StopCoroutine | 服务端 | 停止协程 |
| StopCoroutine | 客户端 | 停止客户端协程 |
# 调试
| 接口 | 描述 | |
|---|---|---|
| GetEnableReconnectNetgame | 客户端 | 获取是否允许断线重连 |
| GetKeepResourceWhenTransfer | 客户端 | 获取快速切服设置 |
| GetMcpModLogCanPostDump | 服务端 | 获取是否可以打印错误信息到McpModLog日志。 |
| GetMcpModLogCanPostDump | 客户端 | 获取是否可以打印错误信息到McpModLog日志。 |
| GetResourceFastload | 客户端 | 获取资源快速加载设置 |
| PostMcpModDump | 服务端 | 主动打印信息到McpModLog日志，需要先调用 SetMcpModLogCanPostDump 接口进行设置，才能生效。 |
| PostMcpModDump | 客户端 | 主动打印信息到McpModLog日志，需要先调用 SetMcpModLogCanPostDump 接口进行设置，才能生效。 |
| ReloadAllMaterials | 客户端 | 重新加载所有材质文件 |
| ReloadAllShaders | 客户端 | 重新加载所有Shader文件 |
| ReloadOneShader | 客户端 | 重新加载某个Shader文件 |
| SetEnableReconnectNetgame | 客户端 | 设置是否允许断线重连 |
| SetKeepResourceWhenTransfer | 客户端 | 设置快速切服 |
| SetMcpModLogCanPostDump | 服务端 | 设置是否可以打印错误信息到McpModLog日志。 |
| SetMcpModLogCanPostDump | 客户端 | 设置是否可以打印错误信息到McpModLog日志。 |
| SetResourceFastload | 客户端 | 设置资源快速加载 |
| StartMemProfile | 服务端 | 开始启动服务端脚本内存分析，启动后调用StopMemProfile即可在路径fileName生成函数内存火焰图，此接口只支持PC端。生成的火焰图可以用浏览器打开，推荐chrome浏览器。 |
| StartMemProfile | 客户端 | 开始启动客户端脚本内存分析，启动后调用StopMemProfile即可在路径fileName生成函数内存火焰图，此接口只支持PC端。生成的火焰图可以用浏览器打开，推荐chrome浏览器。 |
| StartMultiProfile | 服务端 | 开始启动服务端与客户端双端脚本性能分析，启动后调用StopMultiProfile即可在路径fileName生成函数性能火焰图。双端采集时数据误差较大，建议优先使用StartProfile单端版本，此接口只支持PC端 |
| StartMultiProfile | 客户端 | 开始启动服务端与客户端双端脚本性能分析，启动后调用StopMultiProfile即可在路径fileName生成函数性能火焰图。双端采集时数据误差较大，建议优先使用StartProfile单端版本，此接口只支持PC端 |
| StartProfile | 服务端 | 开始启动服务端脚本性能分析，启动后调用StopProfile即可在路径fileName生成函数性能火焰图，此接口只支持PC端。生成的火焰图可以用浏览器打开，推荐chrome浏览器。 |
| StartProfile | 客户端 | 开始启动客户端脚本性能分析，启动后调用StopProfile即可在路径fileName生成函数性能火焰图，此接口只支持PC端。生成的火焰图可以用浏览器打开，推荐chrome浏览器。 |
| StartRecordEvent | Apollo | 开始启动服务端与客户端之间的脚本事件收发统计，启动后调用StopRecordEvent即可获取两个函数调用之间脚本事件收发的统计信息，仅支持租赁服与Apollo网络服环境（不支持单机环境） |
| StartRecordPacket | Apollo | 开始启动服务端与客户端之间的引擎收发包统计，启动后调用StopRecordPacket即可获取两个函数调用之间引擎收发包的统计信息，仅支持租赁服与Apollo网络服环境（不支持单机环境） |
| StopMemProfile | 服务端 | 停止服务端脚本内存分析并生成火焰图，与StartMemProfile配合使用，此接口只支持PC端 |
| StopMemProfile | 客户端 | 停止客户端脚本内存分析并生成火焰图，与StartMemProfile配合使用，此接口只支持PC端 |
| StopMultiProfile | 服务端 | 停止双端脚本性能分析并生成火焰图，与StartMultiProfile配合使用，此接口只支持PC端 |
| StopMultiProfile | 客户端 | 停止双端脚本性能分析并生成火焰图，与StartMultiProfile配合使用，此接口只支持PC端 |
| StopProfile | 服务端 | 停止服务端脚本性能分析并生成火焰图，与StartProfile配合使用，此接口只支持PC端 |
| StopProfile | 客户端 | 停止客户端脚本性能分析并生成火焰图，与StartProfile配合使用，此接口只支持PC端 |
| StopRecordEvent | Apollo | 停止服务端与客户端之间的脚本事件收发统计并输出结果，与StartRecordEvent配合使用，输出结果为字典，key为网络包名，value字典中记录收发信息，具体见示例，仅支持租赁服与Apollo网络服环境（不支持单机环境） |
| StopRecordPacket | Apollo | 停止服务端与客户端之间的引擎收发包统计并输出结果，与StartRecordPacket配合使用，输出结果为字典，key为网络包名，value字典中记录收发信息，具体见示例，仅支持租赁服与Apollo网络服环境（不支持单机环境） |
# 传感器
| 接口 | 描述 | |
|---|---|---|
| SetGyroSensorReportRate | 客户端 | 设置陀螺仪传感器(上报/触发)频率 |
| ToggleGyroSensor | 客户端 | 开启或关闭陀螺仪传感器采集 |
# 地图
| 接口 | 描述 | |
|---|---|---|
| CanSee | 服务端 | 判断起始对象是否可看见目标对象,基于对象的Head位置判断 |
| CheckBlockToPos | 服务端 | 判断位置之间是否有方块 |
| CheckChunkState | 服务端 | 判断指定位置的chunk是否加载完成 |
| CreateDimension | 服务端 | 创建新的dimension |
| CreateExplosion | 服务端 | 用于生成爆炸 |
| DeleteAllArea | 服务端 | 删除所有常加载区域 |
| DeleteArea | 服务端 | 删除一个常加载区域 |
| DetectStructure | 服务端 | 检测自定义门的结构 |
| DoTaskOnChunkAsync | 服务端 | 异步加载指定范围区块，加载完成后调用输入的回调函数。 |
| GetAllAreaKeys | 服务端 | 获取所有常加载区域名称列表 |
| GetBiomeInfo | 服务端 | 获取群系天气相关参数 |
| GetBiomeName | 服务端 | 获取某一位置所属的生物群系信息 |
| GetBiomeName | 客户端 | 获取客户端当前维度已加载区域某一位置所属的生物群系信息 |
| GetBlockLightLevel | 服务端 | 获取方块位置的光照等级 |
| GetChunkEntites | 服务端 | 获取指定位置的区块中，全部的实体和玩家的ID列表 |
| GetChunkMaxPos | 服务端 | 获取某区块最大点的坐标 |
| GetChunkMinPos | 服务端 | 获取某区块最小点的坐标 |
| GetChunkMobNum | 服务端 | 获取某区块中的生物数量（不包括玩家，但包括盔甲架） |
| GetChunkPosFromBlockPos | 服务端 | 通过方块坐标获得该方块所在区块坐标 |
| GetChunkPosFromBlockPos | 客户端 | 通过方块坐标获得该方块所在区块坐标 |
| GetCurrentDimension | 客户端 | 获取客户端当前维度 |
| GetEntitiesAround | 服务端 | 获取区域内的entity列表 |
| GetEntitiesAround | 客户端 | 获取区域内的entity列表 |
| GetEntitiesAroundByType | 服务端 | 获取区域内的某类型的entity列表 |
| GetEntitiesAroundByType | 客户端 | 获取区域内的某类型的entity列表 |
| GetEntitiesInSquareArea | 服务端 | 获取区域内的entity列表 |
| GetEntitiesInSquareArea | 客户端 | 获取区域内的entity列表 |
| GetLevelId | 服务端 | 获取levelId。某些组件需要levelId创建，可以用此接口获取levelId。其中level即为当前地图的游戏。 |
| GetLevelId | 客户端 | 获取levelId。某些组件需要levelId创建，可以用此接口获取levelId。其中level即为当前地图的游戏。 |
| GetLoadedChunks | 服务端 | 获取指定维度当前已经加载完毕的全部区块的坐标列表 |
| GetSpawnDimension | 服务端 | 获取世界出生维度 |
| GetSpawnPosition | 服务端 | 获取世界出生点坐标 |
| GetStructureSize | 服务端 | 获取结构体的长宽高 |
| IsChunkGenerated | 服务端 | 获取某个区块是否生成过。 |
| IsSlimeChunk | 服务端 | 获取某个区块是否是史莱姆区块。 |
| LocateNeteaseFeatureRule | 服务端 | 与/locate指令 (opens new window)相似，用于定位网易自定义特征规则 |
| LocateStructureFeature | 服务端 | 与/locate指令 (opens new window)相似，用于定位原版的部分结构，如海底神殿、末地城等。 |
| MayPlace | 服务端 | 判断方块是否可以放置 |
| MayPlaceOn | 服务端 | 判断物品是否可以放到指定的位置上 |
| MirrorDimension | 服务端 | 复制不同dimension的地形 |
| OpenClientChunkGeneration | 服务端 | 开启/关闭客户端区块生成功能，需要在LoadServerAddonScriptsAfter事件触发时调用。开启客户端区块生成功能时，如果使用了netease:structure_feature或修改了大部分地图，会导致客户端和服务端地图不一致的问题。此时可以通过关闭客户端区块生成功能解决该问题。 |
| PlaceFeature | 服务端 | 放置特征，与/placefeature指令 (opens new window)相似 |
| PlaceNeteaseLargeFeature | 服务端 | 放置网易版大型结构特征 |
| PlaceStructure | 服务端 | 放置结构 |
| SetAddArea | 服务端 | 设置区块的常加载 |
| SetBiomeByPos | 服务端 | 设置某一位置所属的生物群系信息 |
| SetBiomeByPosList | 服务端 | 设置所有列表中位置所属的生物群系信息 |
| SetBiomeByVolume | 服务端 | 设置长方体空间中所属的生物群系信息 |
| SetBiomeInfo | 服务端 | 设置群系天气相关参数 |
| SetMergeSpawnItemRadius | 服务端 | 设置新生成的物品是否合堆 |
| SetSpawnDimensionAndPosition | 服务端 | 设置世界出生点维度与坐标 |
| UpgradeMapDimensionVersion | 服务端 | 提升指定地图维度的版本号，版本号不符的维度，地图存档信息将被废弃。使用后存档的地图版本均会同步提升至最新版本，假如希望使用此接口清理指定维度的地图存档，需要在保证该维度区块都没有被加载时调用。 |
# 实体管理
| 接口 | 描述 | |
|---|---|---|
| CreateEngineEntityByNBT | 服务端 | 根据nbt数据创建实体 |
| CreateEngineEntityByTypeStr | 服务端 | 创建指定identifier的实体 |
| CreateEngineItemEntity | 服务端 | 用于创建物品实体（即掉落物），返回物品实体的entityId |
| CreateEntityAOI | 服务端 | 注册感应区域，有实体进入时和离开时会触发回调函数func |
| CreateExperienceOrb | 服务端 | 创建专属经验球 |
| CreateProjectileEntity | 服务端 | 创建抛射物（直接发射） |
| DeleteEntityAOI | 服务端 | 删除使用CreateEntityAOI注册的感应区 |
| DestroyEntity | 服务端 | 销毁实体 |
| GetDroppedItem | 服务端 | 获取掉落物的物品信息 |
| GetEngineActor | 服务端 | 获取所有维度中已加载的所有实体（不包含玩家）。 |
| GetEngineActor | 客户端 | 获取客户端当前维度中已加载的所有实体（不包含玩家）。 |
| GetLocalPlayerId | 客户端 | 获取本地玩家的id |
| GetLootItems | 服务端 | 指定战利品表获取一次战利品，返回的物品与json定义的概率有关 |
| GetPlayerList | 服务端 | 获取所有维度中的全部玩家的id列表 |
| GetPlayerList | 客户端 | 获取所有维度中的全部玩家的id列表 |
| HasEntity | 客户端 | 判断 entity 是否存在 |
| IsEntityAlive | 服务端 | 判断生物实体是否存活或非生物实体是否存在 |
| IsEntityAlive | 客户端 | 判断生物实体是否存活或非生物实体是否存在 |
| KillEntity | 服务端 | 杀死某个Entity |
| SpawnItemToLevel | 服务端 | 生成物品掉落物，如果需要获取物品的entityId，可以调用服务端系统接口CreateEngineItemEntity |
| SpawnLootTable | 服务端 | 使用生物类型模拟一次随机掉落，生成的物品与json定义的概率有关 |
| SpawnLootTableWithActor | 服务端 | 使用生物实例模拟一次随机掉落，生成的物品与json定义的概率有关 |
| SpawnResources | 服务端 | 产生方块随机掉落（该方法不适用于实体方块） |
| SpawnResourcesSilkTouched | 服务端 | 模拟方块精准采集掉落 |
| getEntitiesOrBlockFromRay | 服务端 | 从指定位置发射一条射线，获取与射线相交的实体和方块 |
# 方块管理
| 接口 | 描述 | |
|---|---|---|
| GetBlock | 客户端 | 获取某一位置的block |
| GetBlockClip | 服务端 | 获取某一位置方块当前clip的aabb |
| GetBlockClip | 客户端 | 获取指定位置方块当前clip的aabb |
| GetBlockCollision | 服务端 | 获取某一位置方块当前collision的aabb |
| GetBlockCollision | 客户端 | 获取指定位置方块当前collision的aabb |
| GetBlockNew | 服务端 | 获取某一位置的block |
| GetDestroyTotalTime | 服务端 | 获取使用物品破坏方块需要的时间 |
| GetDestroyTotalTime | 客户端 | 获取使用物品破坏方块需要的时间 |
| GetLiquidBlock | 服务端 | 获取某个位置的方块所含流体的信息 |
| GetTopBlockHeight | 服务端 | 获取某一位置最高的非空气方块的高度 |
| GetTopBlockHeight | 客户端 | 获取当前维度某一位置最高的非空气方块的高度 |
| SetBlockNew | 服务端 | 设置某一位置的方块 |
| SetJigsawBlock | 服务端 | 在某一位置放置拼图方块 |
| SetLiquidBlock | 服务端 | 设置某一位置的方块的extraBlock，可在此设置方块含水等 |
| SetSnowBlock | 服务端 | 设置某一位置的方块含雪 |
# 生物生成
| 接口 | 描述 | |
|---|---|---|
| GetEntityLimit | 服务端 | 获取世界最大可生成实体数量上限。可生成实体的含义见SetEntityLimit |
| SetEntityLimit | 服务端 | 设置世界最大可生成实体数量上限。可生成实体指具有spawnrule的实体。当前世界上被加载的可生成实体数量超过这个上限时，生物就不会再通过spawnrule刷出。 |
| SpawnCustomModule | 服务端 | 设置自定义刷怪 |
# 配方
| 接口 | 描述 | |
|---|---|---|
| AddBrewingRecipes | 服务端 | 添加酿造台配方的接口 |
| AddRecipe | 服务端 | 动态注册配方，支持配方类型详见[配方类型说明] |
| GetRecipeResult | 服务端 | 根据配方id获取配方结果。仅支持合成配方 |
| GetRecipesByInput | 服务端 | 通过输入物品查询配方 |
| GetRecipesByInput | 客户端 | 通过输入物品查询配方 |
| GetRecipesByResult | 服务端 | 通过输出物品查询配方所需要的输入材料 |
| GetRecipesByResult | 客户端 | 通过输出物品查询配方所需要的输入材料 |
| RemoveRecipe | 服务端 | 动态禁用配方 |
# 方块组合
| 接口 | 描述 | |
|---|---|---|
| CreateMicroBlockResStr | 服务端 | 生成微缩方块资源Json字符串 |
| GetBlankBlockPalette | 服务端 | 获取一个空白的方块调色板。 |
| GetBlankBlockPalette | 客户端 | 获取一个空白的方块调色板。 |
| GetBlockPaletteBetweenPos | 服务端 | 根据输入的两个方块位置创建并获取一个方块调色板，方块调色板用于描述和记录世界中的多个方块的组合。这个方块调色板包含了这两个位置之间的所有方块及其相对位置。 |
| GetBlockPaletteBetweenPos | 客户端 | 根据输入的两个位置创建并获取一个方块调色板，该接口会搜索这两个位置之间的所有方块创建方块调色板，方块调色板用于描述和记录世界中的多个方块的组合。这个方块调色板包含了这两个位置之间的所有方块及其相对位置。 |
| GetBlockPaletteFromPosList | 服务端 | 根据输入的方块位置列表创建并获取一个方块调色板，方块调色板用于描述和记录世界中的多个方块的组合。创建的方块调色板包含了这个位置列表中的所有方块及其相对位置。 |
| GetBlockPaletteFromPosList | 客户端 | 根据输入的方块位置列表创建并获取一个方块调色板，方块调色板用于描述和记录世界中的多个方块的组合。创建的方块调色板包含了这个位置列表中的所有方块及其相对位置。 |
| RegisterBlockPatterns | 服务端 | 注册特殊方块组合 |
| SetBlockByBlockPalette | 服务端 | 根据输入的方块调色板内容，将调色板内记录的所有方块设置为实际的方块。 |
# 渲染
| 接口 | 描述 | |
|---|---|---|
| GetAmbientBrightness | 客户端 | 获取环境光亮度，影响天空亮度，不影响实体与方块光照 |
| GetFogColor | 客户端 | 获取当前雾效颜色 |
| GetFogLength | 客户端 | 获取雾效范围 |
| GetMoonRot | 客户端 | 获取月亮角度 |
| GetSkyColor | 客户端 | 获取天空颜色 |
| GetSkyTextures | 客户端 | 获取当前维度天空盒贴图，天空盒共6张贴图 |
| GetStarBrightness | 客户端 | 获取星星亮度 |
| GetSunRot | 客户端 | 获取太阳角度 |
| GetUseAmbientBrightness | 客户端 | 判断是否在mod设置了环境光亮度 |
| GetUseFogColor | 客户端 | 判断当前是否开启设置雾效颜色，该值默认为False，使用mod传入的颜色值后为True |
| GetUseFogLength | 客户端 | 判断当前是否开启设置雾效范围,该值默认为False，使用mod传入的范围值后为True |
| GetUseMoonRot | 客户端 | 判断是否在mod设置了月亮角度 |
| GetUseSkyColor | 客户端 | 判断是否在mod设置了天空颜色 |
| GetUseStarBrightness | 客户端 | 判断是否在mod设置了星星亮度 |
| GetUseSunRot | 客户端 | 判断是否在mod设置了太阳角度 |
| HideNameTag | 客户端 | 隐藏场景内所有名字，包括玩家名字，生物的自定义名称，物品展示框与命令方块的悬浮文本等 |
| IsHideNameTag | 客户端 | 获取是否隐藏场景内所有名字 |
| ResetAmbientBrightness | 客户端 | 重置环境光亮度 |
| ResetFogColor | 客户端 | 重置雾效颜色 |
| ResetFogLength | 客户端 | 重置雾效范围 |
| ResetMoonRot | 客户端 | 重置月亮角度 |
| ResetSkyColor | 客户端 | 重置天空颜色 |
| ResetSkyTextures | 客户端 | 重置当前维度天空盒贴图。如果有使用addon配置贴图则会使用配置的贴图，否则为游戏内默认无贴图的情况 |
| ResetStarBrightness | 客户端 | 重置星星亮度 |
| ResetSunRot | 客户端 | 重置太阳角度 |
| SetAmbientBrightness | 客户端 | 设置环境光亮度，影响天空亮度，不影响实体与方块光照 |
| SetFogColor | 客户端 | 设置雾效颜色 |
| SetFogLength | 客户端 | 设置雾效范围 |
| SetMoonRot | 客户端 | 设置月亮所在角度 |
| SetSkyColor | 客户端 | 设置天空颜色 |
| SetSkyTextures | 客户端 | 设置当前维度天空盒贴图，天空盒需要6张贴图 |
| SetStarBrightness | 客户端 | 设置星星亮度，白天也可以显示星星 |
| SetSunRot | 客户端 | 设置太阳所在角度 |
| SkyTextures | 客户端 | 修改太阳、月亮、云层分布、天空盒的贴图。使用addon配置，非python接口。 |
# 时间
| 接口 | 描述 | |
|---|---|---|
| GetLocalDoDayNightCycle | 服务端 | 获取维度是否打开昼夜更替 |
| GetLocalTime | 服务端 | 获取维度的时间 |
| GetTime | 服务端 | 获取当前世界时间 |
| GetTime | 客户端 | 获取当前世界时间 |
| GetUseLocalTime | 服务端 | 获取某个维度是否设置了使用局部时间规则 |
| SetLocalDoDayNightCycle | 服务端 | 设置使用局部时间规则的维度是否打开昼夜更替 |
| SetLocalTime | 服务端 | 设置使用局部时间规则维度的时间 |
| SetLocalTimeOfDay | 服务端 | 设置使用局部时间规则维度在一天内所在的时间 |
| SetTime | 服务端 | 设置当前世界时间 |
| SetTimeOfDay | 服务端 | 设置当前世界在一天内所在的时间 |
| SetUseLocalTime | 服务端 | 让某个维度拥有自己的局部时间规则，开启后该维度可以拥有与其他维度不同的时间与是否昼夜更替的规则 |
# 天气
| 接口 | 描述 | |
|---|---|---|
| GetDimensionLocalWeatherInfo | 服务端 | 获取独立维度天气信息(必须先使用SetDimensionUseLocalWeather接口设置此维度拥有自己的独立天气) |
| GetDimensionUseLocalWeather | 服务端 | 获取某个维度是否拥有自己的天气规则 |
| IsRaining | 服务端 | 获取是否下雨 |
| IsThunder | 服务端 | 获取是否打雷 |
| SetDimensionLocalDoWeatherCycle | 服务端 | 设置某个维度是否开启天气循环(必须先使用SetDimensionUseLocalWeather接口设置此维度拥有自己的独立天气) |
| SetDimensionLocalRain | 服务端 | 设置某个维度下雨(必须先使用SetDimensionUseLocalWeather接口设置此维度拥有自己的独立天气) |
| SetDimensionLocalThunder | 服务端 | 设置某个维度打雷(必须先使用SetDimensionUseLocalWeather接口设置此维度拥有自己的独立天气) |
| SetDimensionUseLocalWeather | 服务端 | 设置某个维度拥有自己的天气规则，开启后该维度可以拥有与其他维度不同的天气和天气更替的规则 |
| SetRaining | 服务端 | 设置是否下雨 |
| SetThunder | 服务端 | 设置是否打雷 |
# 游戏规则
| 接口 | 描述 | |
|---|---|---|
| AddBannedItem | 服务端 | 增加禁用物品 |
| AddBlockProtectField | Apollo | 设置一个方块无法被玩家/实体破坏的区域 |
| CleanBlockProtectField | Apollo | 取消全部已设置的方块无法被玩家/实体破坏的区域 |
| ClearBannedItems | 服务端 | 清空禁用物品 |
| DisableVineBlockSpread | 服务端 | 设置是否禁用藤曼蔓延生长 |
| ForbidLiquidFlow | 服务端 | 禁止/允许地图中的流体流动 |
| GetBannedItemList | 服务端 | 获取禁用物品列表 |
| GetGameDiffculty | 服务端 | 获取游戏难度 |
| GetGameRulesInfoServer | 服务端 | 获取游戏规则 |
| GetGameType | 服务端 | 获取默认游戏模式 |
| GetLevelGravity | 服务端 | 获取重力因子 |
| GetSeed | 服务端 | 获取存档种子 |
| IsDisableCommandMinecart | 服务端 | 获取当前是否允许运行命令方块矿车内置逻辑指令，当前仅Apollo网络服可用 |
| IsLockDifficulty | 服务端 | 获取当前世界的游戏难度是否被锁定 |
| IsLockGameRulesInfo | 服务端 | 获取当前世界的游戏规则是否被锁定 |
| IsLockGameType | 服务端 | 获取当前世界的游戏类型是否被锁定，包括默认游戏类型和个人游戏类型 |
| LockDifficulty | 服务端 | 锁定当前世界游戏难度（仅本次游戏有效），锁定后任何玩家在游戏内都无法通过指令或暂停菜单修改游戏难度 |
| LockGameRulesInfo | 服务端 | 锁定当前世界游戏规则（仅本次游戏有效），玩家无法通过指令、游戏菜单或api修改游戏规则（包括SetGameRulesInfoServer示例中列举的规则） |
| LockGameType | 服务端 | 锁定当前世界游戏类型（仅本次游戏有效），玩家无法通过指令、游戏菜单或相关api如SetPlayerGameType和SetDefaultGameType修改游戏类型，包括默认游戏类型和个人游戏类型 |
| OpenCityProtect | Apollo | 开启城市保护，包括禁止破坏方块，禁止对方块使用物品，禁止怪物攻击玩家，禁止玩家之间互相攻击，禁止日夜切换，禁止天气变化，禁止怪物群落刷新 |
| RemoveBannedItem | 服务端 | 移除禁用物品 |
| RemoveBlockProtectField | Apollo | 取消一个方块无法被玩家/实体破坏的区域 |
| SetCanActorSetOnFireByLightning | 服务端 | 禁止/允许闪电点燃实体 |
| SetCanBlockSetOnFireByLightning | 服务端 | 禁止/允许闪电点燃方块 |
| SetDefaultGameType | 服务端 | 设置默认游戏模式 |
| SetDisableCommandMinecart | 服务端 | 设置停止/开启运行命令方块矿车内置逻辑指令，当前仅Apollo网络服可用 |
| SetDisableContainers | 服务端 | 禁止所有容器界面的打开，包括玩家背包，各种包含背包界面的容器方块如工作台与箱子，以及包含背包界面的实体交互如马背包与村民交易 |
| SetDisableDropItem | 服务端 | 设置禁止丢弃物品 |
| SetDisableGravityInLiquid | 服务端 | 是否屏蔽所有实体在液体（水、岩浆）中的重力 |
| SetDisableHunger | 服务端 | 设置是否屏蔽饥饿度 |
| SetGameDifficulty | 服务端 | 设置游戏难度 |
| SetGameRulesInfoServer | 服务端 | 设置游戏规则。所有参数均可选。 |
| SetHurtCD | 服务端 | 设置全局受击间隔CD |
| SetLevelGravity | 服务端 | 设置重力因子 |
# 自定义数据
| 接口 | 描述 | |
|---|---|---|
| CleanExtraData | 服务端 | 清除实体的自定义数据或者世界的自定义数据，清除实体数据时使用对应实体id创建组件，清除世界数据时使用levelId创建组件 |
| GetExtraData | 服务端 | 获取实体的自定义数据或者世界的自定义数据，某个键所对应的值。获取实体数据时使用对应实体id创建组件，获取世界数据时使用levelId创建组件 |
| GetWholeExtraData | 服务端 | 获取完整的实体的自定义数据或者世界的自定义数据，获取实体数据时使用对应实体id创建组件，获取世界数据时使用levelId创建组件 |
| SaveExtraData | 服务端 | 用于保存实体的自定义数据或者世界的自定义数据 |
| SetExtraData | 服务端 | 用于设置实体的自定义数据或者世界的自定义数据，数据以键值对的形式保存。设置实体数据时使用对应实体id创建组件，设置世界数据时使用levelId创建组件 |
# 指令
| 接口 | 描述 | |
|---|---|---|
| GetCommandPermissionLevel | 服务端 | 返回设定使用/op命令时OP的权限等级（对应server.properties中的op-permission-level配置） |
| GetDefaultPlayerPermissionLevel | 服务端 | 返回新玩家加入时的权限身份（对应server.properties中的default-player-permission-level配置） |
| SetCommand | 服务端 | 使用游戏内指令 |
| SetCommandPermissionLevel | 服务端 | 设置当玩家使用/op命令时OP的权限等级（对应server.properties中的op-permission-level配置） |
| SetDefaultPlayerPermissionLevel | 服务端 | 设置新玩家加入时的权限身份（对应server.properties中的default-player-permission-level配置） |
# 消息
| 接口 | 描述 | |
|---|---|---|
| NotifyOneMessage | 服务端 | 给指定玩家发送聊天框消息 |
| SendMsg | 服务端 | 模拟玩家给所有人发送聊天栏消息 |
| SendMsgToPlayer | 服务端 | 模拟玩家给另一个玩家发送聊天栏消息 |
| SetLeftCornerNotify | 客户端 | 客户端设置左上角通知信息 |
| SetNotifyMsg | 服务端 | 设置消息通知 |
| SetOnePopupNotice | 服务端 | 在具体某个玩家的物品栏上方弹出popup类型通知，位置位于tip类型消息下方，此功能更建议客户端使用game组件的对应接口SetPopupNotice |
| SetOneTipMessage | 服务端 | 在具体某个玩家的物品栏上方弹出tip类型通知，位置位于popup类型通知上方，此功能更建议在客户端使用game组件的对应接口SetTipMessage |
| SetPopupNotice | 服务端 | 在所有玩家物品栏上方弹出popup类型通知，位置位于tip类型消息下方 |
| SetPopupNotice | 客户端 | 在本地玩家的物品栏上方弹出popup类型通知，位置位于tip类型消息下方 |
| SetPopupState | 客户端 | 设置Popup消息栏状态 |
| SetTipMessage | 服务端 | 在所有玩家物品栏上方弹出tip类型通知，位置位于popup类型通知上方 |
| SetTipMessage | 客户端 | 在本地玩家的物品栏上方弹出tip类型通知，位置位于popup类型通知上方 |
# 记分板
| 接口 | 描述 | |
|---|---|---|
| GetAllPlayerScoreboardObjects | 服务端 | 获取玩家记分项 |
| GetAllPlayerScoreboardObjects | 客户端 | 获取玩家记分项 |
| GetAllScoreboardObjects | 服务端 | 获取所有记分板项 |
| GetAllScoreboardObjects | 客户端 | 获取所有记分板项 |
# 实体类型
| 接口 | 描述 | |
|---|---|---|
| GetEngineType | 服务端 | 获取实体类型，主要用于判断实体是否属于某一类型的生物。 |
| GetEngineType | 客户端 | 获取实体类型，主要用于判断实体是否属于某一类型的生物。 |
| GetEngineTypeStr | 服务端 | 获取实体的类型名称 |
| GetEngineTypeStr | 客户端 | 获取实体的类型名称 |
| GetEntityDefinitions | 服务端 | 获取实体的命名空间ID及其当前和之前的定义组件群 |
| GetEntityNBTTags | 服务端 | 获取实体的NBT标签 |
# 附加值
| 接口 | 描述 | |
|---|---|---|
| GetAuxValue | 服务端 | 获取射出的弓箭或投掷出的药水的附加值 |
| GetAuxValue | 客户端 | 获取射出的弓箭或投掷出的药水的附加值 |
# 属性
| 接口 | 描述 | |
|---|---|---|
| ChangeEntityDimension | 服务端 | 传送实体 |
| GetAllComponentsName | 服务端 | 获取实体所拥有的原版组件list |
| GetAttrMaxValue | 服务端 | 获取实体的引擎属性的最大值 |
| GetAttrMaxValue | 客户端 | 获取属性最大值，包括生命值，饥饿度，移速等 |
| GetAttrValue | 服务端 | 获取实体的引擎属性 |
| GetAttrValue | 客户端 | 获取属性值，包括生命值，饥饿度，移速 |
| GetBodyRot | 客户端 | 获取实体的身体的角度 |
| GetCurrentAirSupply | 服务端 | 生物当前氧气储备值 |
| GetCurrentAirSupply | 客户端 | 玩家当前氧气储备值 |
| GetDeathTime | 服务端 | 获取生物死亡后持续的时间（刻，1秒20刻），用于控制死亡动画。0表示生物未死亡。 |
| GetEntityDamage | 服务端 | 获取生物(包括玩家)的攻击力 |
| GetEntityDimensionId | 服务端 | 获取实体所在维度 |
| GetEntityFallDistance | 服务端 | 获取实体的坠落高度，越大的值会给予实体更大的坠落伤害，建议在OnGroundServerEvent事件中调用 |
| GetEntityLinksTag | 服务端 | 获取实体相连接的实体，如获取entityId为马，会返回骑乘者的信息 |
| GetEntityOwner | 服务端 | 获取实体的属主（包括可驯服生物的主人，或者掉落物的丢弃者，弹射物的发射者等） |
| GetFootPos | 服务端 | 获取实体脚所在的位置 |
| GetFootPos | 客户端 | 获取实体脚所在的位置 |
| GetGravity | 服务端 | 获取实体的重力因子，当生物重力因子为0时则应用世界的重力因子 |
| GetLoadActors | 服务端 | 获取已加载的实体id |
| GetMarkVariant | 服务端 | 获取实体的标记变种属性值 |
| GetMaxAirSupply | 服务端 | 获取生物最大氧气储备值 |
| GetMaxAirSupply | 客户端 | 玩家最大氧气储备值 |
| GetMobColor | 服务端 | 获取生物的颜色，截止至网易2.9版本，只对羊和热带鱼有效 |
| GetMobStrength | 服务端 | 获取生物的强度，截止至网易2.9版本，只对羊驼有效，强度越大羊驼驮运的箱子时格子数量越多 |
| GetMobStrengthMax | 服务端 | 获取生物强度的最大值，截止至网易2.9版本，只对羊驼有效，强度越大羊驼驮运的箱子时格子数量越多，SetMobStrength无法超过SetMobStrengthMax的值 |
| GetName | 服务端 | 获取生物的自定义名称（即使用命名牌或者SetName接口设置的名称），或者玩家的名字。 |
| GetName | 客户端 | 获取生物的自定义名称（即使用命名牌或者SetName接口设置的名称），或者玩家的名字。 |
| GetPos | 服务端 | 获取实体位置 |
| GetPos | 客户端 | 获取实体位置 |
| GetRiderId | 客户端 | 获取玩家坐骑entityid |
| GetRot | 服务端 | 获取实体头与水平方向的俯仰角度和竖直方向的旋转角度，获得角度后可用GetDirFromRot接口转换为朝向的单位向量 MC坐标系说明 |
| GetRot | 客户端 | 获取实体头与水平方向的俯仰角度和竖直方向的旋转角度，获得角度后可用GetDirFromRot接口转换为朝向的单位向量 MC坐标系说明 |
| GetSize | 服务端 | 获取实体的包围盒 |
| GetSize | 客户端 | 获取实体的包围盒 |
| GetTradeLevel | 服务端 | 获取村民的交易等级 |
| GetTypeFamily | 服务端 | 获取生物行为包字段 type_family |
| GetUnitBubbleAirSupply | 服务端 | 单位气泡数对应的氧气储备值 |
| GetVariant | 服务端 | 获取实体的变种属性值 |
| HasChest | 服务端 | 判断生物是否背负了箱子，截止至网易2.9版本，只对羊驼、驴、骡生效 |
| HasComponent | 服务端 | 判断实体是否有原版组件 |
| HasSaddle | 服务端 | 判断实体是否装备了鞍 |
| IsAngry | 服务端 | 判断实体是否处于激怒状态 |
| IsBaby | 服务端 | 判断实体是否为幼年 |
| IsConsumingAirSupply | 服务端 | 获取生物当前是否在消耗氧气 |
| IsIllagerCaptain | 服务端 | 判断实体是否为袭击队长，截止至网易2.9版本，只对掠夺者和卫道士有效 |
| IsNaturallySpawned | 服务端 | 获取生物是否为自然生成的 |
| IsOutOfControl | 服务端 | 判断实体是否处于失控状态，截止至网易2.9版本，只对船有效 |
| IsPregnant | 服务端 | 获取生物是否怀孕，截止至网易2.9版本，只对海龟有效 |
| IsSheared | 服务端 | 判断实体是否被剃毛，截止至网易2.9版本，只对羊有效 |
| IsSitting | 服务端 | 判断实体是否处于坐下状态 |
| IsTamed | 服务端 | 判断实体是否被驯服 |
| LockLocalPlayerRot | 客户端 | 在分离摄像机时，锁定本地玩家的头部角度 |
| PromoteToIllagerCaptain | 服务端 | 晋升实体为袭击队长，截止至网易2.9版本，只对掠夺者和卫道士有效 |
| ResetToDefaultValue | 服务端 | 重置实体引擎属性到默认值 |
| ResetToMaxValue | 服务端 | 重置实体引擎属性到最大值 |
| SetAngry | 服务端 | 设置实体是否处于激怒状态 |
| SetAsAdult | 服务端 | 设置实体为成年体 |
| SetAttrMaxValue | 服务端 | 设置实体的引擎属性的最大值 |
| SetAttrValue | 服务端 | 设置实体的引擎属性 |
| SetChest | 服务端 | 设置生物是否背负了箱子，截止至网易2.9版本，只对羊驼、驴、骡生效 |
| SetCurrentAirSupply | 服务端 | 设置生物氧气储备值 |
| SetEntityLookAtPos | 服务端 | 设置非玩家的实体看向某个位置 |
| SetEntityOwner | 服务端 | 设置实体的属主（包括可驯服生物的主人，或者掉落物的丢弃者，弹射物的发射者等） |
| SetFootPos | 服务端 | 设置实体脚底所在的位置 |
| SetGravity | 服务端 | 设置实体的重力因子，当生物重力因子为0时则应用世界的重力因子 |
| SetMarkVariant | 服务端 | 设置实体的标记变种属性值 |
| SetMaxAirSupply | 服务端 | 设置生物最大氧气储备值 |
| SetMobColor | 服务端 | 设置生物的颜色，截止至网易2.9版本，只对羊和热带鱼有效 |
| SetMobStrength | 服务端 | 设置生物的强度，截止至网易2.9版本，只对羊驼有效，强度越大羊驼驮运的箱子时格子数量越多 |
| SetMobStrengthMax | 服务端 | 设置生物强度的最大值，截止至网易2.9版本，只对羊驼有效，强度越大羊驼驮运的箱子时格子数量越多，SetMobStrength无法超过SetMobStrengthMax的值。由于引擎限制，在羊驼被打时候会reload组件，strengthMax会恢复成llama.json中的配置值(minecraft:strength) |
| SetName | 服务端 | 用于设置生物的自定义名称，跟原版命名牌作用相同，玩家和新版流浪商人暂不支持 |
| SetOutOfControl | 服务端 | 设置实体是否处于失控状态，截止至网易2.9版本，只对船有效 |
| SetPersistent | 服务端 | 设置实体不会因为离玩家太远而被清除 (opens new window) |
| SetPlayerLookAtPos | 客户端 | 设置本地玩家看向某个位置 |
| SetPos | 服务端 | 设置实体位置 |
| SetRecoverTotalAirSupplyTime | 服务端 | 设置恢复最大氧气量的时间，单位秒 |
| SetRot | 服务端 | 设置实体头与水平方向的俯仰角度和竖直方向的旋转角度 MC坐标系说明 |
| SetRot | 客户端 | 设置实体头与水平方向的俯仰角度和竖直方向的旋转角度 MC坐标系说明 |
| SetSheared | 服务端 | 设置实体是否被剃毛，截止至网易2.9版本，只对羊有效 |
| SetSitting | 服务端 | 设置生物是否坐下 |
| SetSize | 服务端 | 设置实体的包围盒 |
| SetTradeLevel | 服务端 | 设置村民的交易等级 |
| SetVariant | 服务端 | 设置实体的变种属性值 |
| isEntityInLava | 客户端 | 实体是否在岩浆中 |
| isEntityOnGround | 客户端 | 实体是否触地 |
# 行为
| 接口 | 描述 | |
|---|---|---|
| AddActorComponentGroup | 服务端 | 给指定实体添加实体json中配置的ComponentGroup |
| AddEntityAroundEntityMotion | 服务端 | 给实体（不含玩家）添加对实体环绕运动器 |
| AddEntityAroundPointMotion | 服务端 | 给实体（不含玩家）添加对点环绕运动器 |
| AddEntitySeat | 服务端 | 增加坐骑座位 |
| AddEntityTrackMotion | 服务端 | 给实体（不含玩家）添加轨迹运动器 |
| AddEntityVelocityMotion | 服务端 | 给实体（不含玩家）添加速度运动器 |
| ChangeRiderSeat | 服务端 | 设置骑乘者在当前坐骑上的序号 |
| DeleteEntitySeat | 服务端 | 删除坐骑座位 |
| GetAttackTarget | 服务端 | 获取仇恨目标 |
| GetAttackTarget | 客户端 | 获取仇恨目标 |
| GetBlockControlAi | 服务端 | 获取生物原生AI是否被屏蔽 |
| GetCustomGoalCls | 服务端 | 用于获取服务器自定义行为节点的基类。实现新的行为节点时，需要继承该接口返回的类 |
| GetEntityMotions | 服务端 | 获取实体（不含玩家）身上的所有运动器 |
| GetJumpPower | 服务端 | 获取生物跳跃力度，0.42表示正常水平 |
| GetLeashHolder | 服务端 | 获取实体被使用拴绳牵引时牵引者的ID |
| GetMotion | 服务端 | 获取生物（含玩家）的瞬时移动方向向量 |
| GetMotion | 客户端 | 获取生物的瞬时移动方向向量。与服务端不同，客户端不会计算摩擦等因素，获取到的是上一帧的向量，与服务器获取到的值会不相等 |
| GetOwnerId | 服务端 | 获取驯服生物的主人id |
| GetOwnerId | 客户端 | 获取驯服生物的主人id |
| GetRiders | 服务端 | 获取坐骑上的骑乘者信息 |
| GetStepHeight | 服务端 | 返回玩家前进非跳跃状态下能上的最大台阶高度 |
| Hurt | 服务端 | 设置实体伤害 |
| ImmuneDamage | 服务端 | 设置实体是否免疫伤害（该属性存档） |
| IsEating | 服务端 | 判断非玩家实体是否在进食 |
| IsEntityOnFire | 服务端 | 获取实体是否着火 |
| IsLootDropped | 服务端 | 获取生物是否生成掉落物 |
| IsPersistent | 服务端 | 判断是否为持久性生物 |
| IsRoaring | 服务端 | 判断是否处于咆哮状态，截止至网易2.9版本，仅对劫掠兽有效 |
| IsStunned | 服务端 | 判断是否处于眩晕状态，截止至网易2.9版本，仅对劫掠兽有效 |
| RemoveActorComponentGroup | 服务端 | 移除指定实体在实体json中配置的ComponentGroup |
| RemoveEntityMotion | 服务端 | 移除实体（不含玩家）身上的运动器 |
| ResetAttackTarget | 服务端 | 清除仇恨目标 |
| ResetMotion | 服务端 | 重置生物（不含玩家）的瞬时移动方向向量 |
| ResetStepHeight | 服务端 | 恢复引擎默认玩家前进非跳跃状态下能上的最大台阶高度 |
| SetActorCollidable | 服务端 | 设置实体是否可碰撞 |
| SetActorPushable | 服务端 | 设置实体是否可推动 |
| SetAttackTarget | 服务端 | 设置仇恨目标 |
| SetBlockControlAi | 服务端 | 设置屏蔽生物原生AI |
| SetCanOtherPlayerRide | 服务端 | 设置其他玩家是否有权限骑乘，True表示每个玩家都能骑乘，False只有驯服者才能骑乘 |
| SetControl | 服务端 | 设置该生物无需装备鞍就可以控制行走跳跃 |
| SetEntityInteractFilter | 服务端 | 设置与生物可交互的条件 |
| SetEntityLockRider | 服务端 | 设置坐骑上的实体是否锁定序号 |
| SetEntityOnFire | 服务端 | 设置实体着火 |
| SetEntityRide | 服务端 | 驯服可骑乘生物 |
| SetEntitySeat | 服务端 | 设置坐骑座位的位置、旋转以及允许实体旋转范围 |
| SetEntityShareablesItems | 服务端 | 设置生物可分享/可拾取的物品列表 |
| SetEntityTamed | 服务端 | 设置生物驯服，需要配合 entityEvent组件使用。该类驯服不包含骑乘功能。 |
| SetJumpPower | 服务端 | 设置生物跳跃力度，0.42表示正常水平 |
| SetLeashHolder | 服务端 | 为实体添加牵引者，与原版拴绳的作用相同，详见基岩版栓绳介绍 |
| SetLootDropped | 服务端 | 设置生物是否生成掉落物 |
| SetMobKnockback | 服务端 | 设置击退的初始速度，需要考虑阻力的影响 |
| SetMotion | 服务端 | 设置生物（不含玩家）的瞬时移动方向向量 |
| SetMotion | 客户端 | 设置瞬时的移动方向向量，用于本地玩家 |
| SetMoveSetting | 服务端 | 寻路组件 |
| SetPersistence | 服务端 | 设置实体是否持久化。 |
| SetRidePos | 服务端 | 设置生物骑乘位置 |
| SetRiderRideEntity | 服务端 | 设置实体骑乘生物（或者船与矿车） |
| SetStepHeight | 服务端 | 设置玩家前进非跳跃状态下能上的最大台阶高度, 默认值为0.5625，1的话表示能上一个台阶 |
| StartEntityMotion | 服务端 | 启动实体（不含玩家）身上的某个运动器 |
| StopEntityMotion | 服务端 | 停止实体（不含玩家）身上的某个运动器 |
| TriggerCustomEvent | 服务端 | 触发生物自定义事件 |
# 状态效果
| 接口 | 描述 | |
|---|---|---|
| AddEffectToEntity | 服务端 | 为实体添加指定状态效果，如果添加的状态已存在则有以下集中情况：1、等级大于已存在则更新状态等级及持续时间；2、状态等级相等且剩余时间duration大于已存在则刷新剩余时间；3、等级小于已存在则不做修改；4、粒子效果以新的为准 |
| GetAllEffects | 服务端 | 获取实体当前所有状态效果 |
| GetAllEffects | 客户端 | 获取实体当前所有状态效果 |
| HasEffect | 服务端 | 获取实体是否存在当前状态效果 |
| HasEffect | 客户端 | 获取实体是否存在当前状态效果 |
| RemoveEffectFromEntity | 服务端 | 为实体删除指定状态效果 |
# 渲染
| 接口 | 描述 | |
|---|---|---|
| AddActorAnimation | 客户端 | 增加生物渲染动画 |
| AddActorAnimationController | 客户端 | 增加生物渲染动画控制器 |
| AddActorBlockGeometry | 客户端 | 为实体添加方块几何体模型。 |
| AddActorGeometry | 客户端 | 增加生物渲染几何体 |
| AddActorParticleEffect | 客户端 | 增加生物特效资源 |
| AddActorRenderController | 客户端 | 增加生物渲染控制器 |
| AddActorRenderControllerArray | 客户端 | 增加生物渲染控制器列表中字典arrays元素 |
| AddActorRenderMaterial | 客户端 | 增加生物渲染需要的材质 |
| AddActorScriptAnimate | 客户端 | 在生物的客户端实体定义（minecraft:client_entity）json中的scripts/animate节点添加动画/动画控制器 |
| AddActorSoundEffect | 客户端 | 增加生物音效资源 |
| AddActorTexture | 客户端 | 增加生物渲染贴图 |
| BindEntityToEntity | 客户端 | 绑定骨骼模型跟随其他entity,如果当前entity是本地玩家，摄像机也跟随其他entity |
| ClearActorBlockGeometry | 客户端 | 删除实体中所有的方块几何体模型。 |
| CopyActorGeometryFromPlayer | 客户端 | 将渲染几何体从某个玩家拷贝到某类生物identifier上 |
| CopyActorRenderMaterialFromPlayer | 客户端 | 将渲染材质从某个玩家拷贝到某类生物identifier上 |
| CopyActorTextureFromPlayer | 客户端 | 将贴图从某个玩家拷贝到某类生物identifier上 |
| CopyPlayerGeometryToOneActor | 客户端 | 将渲染几何体从某个玩家拷贝到某个生物上 |
| CopyPlayerRenderMaterialToOneActor | 客户端 | 将渲染材质从某个玩家拷贝到某个生物上 |
| CopyPlayerTextureToOneActor | 客户端 | 将贴图从某个玩家拷贝到某个生物上 |
| DeleteActorBlockGeometry | 客户端 | 删除实体中指定方块几何体模型。 |
| GetActorRenderParams | 客户端 | 获取实体（包括玩家）渲染参数 |
| GetEntityExtraUniforms | 客户端 | 获取在实体shader当中使用的自定义变量的值。该自定义变量包含EXTRA_ACTOR_UNIFORM1,EXTRA_ACTOR_UNIFORM2,EXTRA_ACTOR_UNIFORM3,EXTRA_ACTOR_UNIFORM4，总共4组，每组为一个vec4(float, float, float ,float)类型的向量。 |
| GetEntityRenderDistance | 客户端 | 获取玩家的实体可渲染距离。玩家周围的实体指这个区块内的实体，也包含玩家自身。实体的渲染距离指，实体的位置到玩家相机位置的距离。可渲染距离指，如果实体的渲染距离在可渲染距离之内，则实体会被渲染出来，如果在距离以外，则实体不会被渲染出来。仅对本地玩家有效。 |
| GetEntityUIExtraUniforms | 客户端 | 获取在实体shader当中使用的UI自定义变量的值，该变量可在微软UI纸娃娃（paperdoll）及网易版纸娃娃（neteasepaperdoll)上使用identifier渲染某一类生物实体时使用。该自定义变量包含EXTRA_ACTOR_UNIFORM1,EXTRA_ACTOR_UNIFORM2,EXTRA_ACTOR_UNIFORM3,EXTRA_ACTOR_UNIFORM4，总共4组，每组为一个vec4(float, float, float ,float)类型的向量。 |
| GetNotRenderAtAll | 客户端 | 获取实体是否不渲染 |
| IsShowName | 客户端 | 获取生物名字是否按照默认游戏逻辑显示（包括玩家） |
| RebuildActorRender | 客户端 | 重建生物的数据渲染器（该接口不支持玩家，玩家请使用RebuildPlayerRender） |
| RebuildRenderForOneActor | 客户端 | 使用完entity类渲染接口后，重建单个生物渲染控制器（该接口不支持玩家，玩家请使用RebuildPlayerRender） |
| RemoveActorAnimationController | 客户端 | 移除生物渲染动画控制器 |
| RemoveActorGeometry | 客户端 | 删除生物渲染几何体 |
| RemoveActorRenderController | 客户端 | 删除生物渲染控制器 |
| RemoveActorTexture | 客户端 | 删除生物渲染贴图 |
| ResetActorRender | 客户端 | 重置实体渲染接口，包括动画、动画控制器、渲染控制器、贴图、材质、特效资源、音效资源等。 |
| ResetBindEntity | 客户端 | 取消目标entity的绑定实体，取消后不再跟随任何其他entity |
| ResetRenderForOneActor | 客户端 | 将调用OneActor类渲染接口(CopyPlayerTextureToOneActor、CopyPlayerRenderMaterialToOneActor等)的生物重置回种群 |
| SetActorAllBlockGeometryVisible | 客户端 | 设置实体中所有的方块几何体模型是否显示。 |
| SetActorBlockGeometryVisible | 客户端 | 设置实体中指定的方块几何体模型是否显示。 |
| SetAlwaysShowName | 客户端 | 设置生物名字是否一直显示，瞄准点不指向生物时也能显示 |
| SetColor | 客户端 | 设置血条的颜色及背景色 |
| SetEntityExtraUniforms | 客户端 | 设置可在实体shader当中使用的自定义变量的值。该自定义变量总共可设置EXTRA_ACTOR_UNIFORM1,EXTRA_ACTOR_UNIFORM2,EXTRA_ACTOR_UNIFORM3,EXTRA_ACTOR_UNIFORM4，总共4组，每组为一个vec4(float, float, float ,float)类型的向量，向量的默认值为(1.0,1.0,1.0,1.0)。 |
| SetEntityRenderDistance | 客户端 | 设置玩家周围的实体的可渲染距离。玩家周围的实体指这个区块内的实体，也包含玩家自身。实体的渲染距离指，实体的位置到玩家相机位置的距离。可渲染距离指，如果实体的渲染距离在可渲染距离之内，则实体会被渲染出来，如果在距离以外，则实体不会被渲染出来。仅对本地玩家有效。 |
| SetEntityUIExtraUniforms | 客户端 | 设置可在实体shader当中使用的UI自定义变量的值，可在微软UI纸娃娃（paperdoll）及网易版纸娃娃（neteasepaperdoll)上使用identifier渲染某一类生物实体时使用。该自定义变量总共可设置EXTRA_ACTOR_UNIFORM1,EXTRA_ACTOR_UNIFORM2,EXTRA_ACTOR_UNIFORM3,EXTRA_ACTOR_UNIFORM4，总共4组，每组为一个vec4(float, float, float ,float)类型的向量，向量的默认值为(1.0,1.0,1.0,1.0)。 |
| SetHealthBarDeviation | 客户端 | 设置某个entity血条的相对高度 |
| SetNameDeeptest | 客户端 | 设置名字是否透视 |
| SetNotRenderAtAll | 客户端 | 设置是否关闭实体渲染 |
| SetRenderLocalPlayer | 客户端 | 设置本地玩家是否渲染 |
| SetShowName | 客户端 | 设置生物名字是否按照默认游戏逻辑显示（包括玩家） |
| ShowHealth | 客户端 | 设置某个entity是否显示血条，默认为显示 |
| ShowHealthBar | 客户端 | 设置是否显示血条 |
# 背包
| 接口 | 描述 | |
|---|---|---|
| GetEntityItem | 服务端 | 获取生物物品，支持获取背包，盔甲栏，副手以及主手物品 |
| GetEquItemEnchant | 服务端 | 获取装备槽位中盔甲的附魔 |
| GetEquItemModEnchant | 服务端 | 获取装备槽位中盔甲的自定义附魔 |
| SetEntityItem | 服务端 | 设置生物物品，建议开发者根据生物特性来进行设置，部分生物设置装备后可能不显示但是死亡后仍然会掉落所设置的装备 |
# 自定义属性
| 接口 | 描述 | |
|---|---|---|
| GetAttr | 服务端 | 获取SetAttr设置的属性值 |
| GetAttr | 客户端 | 获取SetAttr设置的属性值 |
| RegisterUpdateFunc | 客户端 | 注册属性值变换时的回调函数，当属性变化时会调用该函数 |
| SaveAttr | 服务端 | 保存SetAttr设置的属性值 |
| SetAttr | 服务端 | 设置属性值。服务端设置后会自动同步到客户端，可以用客户端的GetAttr获取。默认不会存档，需要存档的话可以设置needRestore=True。 |
| SetAttr | 客户端 | 设置客户端属性值 |
| UnRegisterUpdateFunc | 客户端 | 反注册属性值变换时的回调函数 |
# 自定义数据
| 接口 | 描述 | |
|---|---|---|
| CleanExtraData | 服务端 | 清除实体的自定义数据或者世界的自定义数据，清除实体数据时使用对应实体id创建组件，清除世界数据时使用levelId创建组件 |
| GetExtraData | 服务端 | 获取实体的自定义数据或者世界的自定义数据，某个键所对应的值。获取实体数据时使用对应实体id创建组件，获取世界数据时使用levelId创建组件 |
| GetWholeExtraData | 服务端 | 获取完整的实体的自定义数据或者世界的自定义数据，获取实体数据时使用对应实体id创建组件，获取世界数据时使用levelId创建组件 |
| SaveExtraData | 服务端 | 用于保存实体的自定义数据或者世界的自定义数据 |
| SetExtraData | 服务端 | 用于设置实体的自定义数据或者世界的自定义数据，数据以键值对的形式保存。设置实体数据时使用对应实体id创建组件，设置世界数据时使用levelId创建组件 |
# molang
| 接口 | 描述 | |
|---|---|---|
| EvalMolangExpression | 服务端 | 在实体上下文上执行molang表达式 |
| EvalMolangExpression | 客户端 | 在实体上下文上执行molang表达式 |
| Get | 客户端 | 获取某一个实体计算节点的值，如果不存在返回注册时的默认值 |
| GetMolangValue | 客户端 | 获取实体molang变量的值 |
| GetStringHash64 | 客户端 | 返回字符串变量的hash64 |
| Register | 客户端 | 注册实体计算节点 |
| Set | 客户端 | 设置某一个实体计算节点的值 |
| UnRegister | 客户端 | 注销实体计算节点 |
# 标签
| 接口 | 描述 | |
|---|---|---|
| AddEntityTag | 服务端 | 增加实体标签 |
| EntityHasTag | 服务端 | 判断实体是否存在某个指定的标签 |
| GetEntityTags | 服务端 | 获取实体标签列表 |
| RemoveEntityTag | 服务端 | 移除实体某个指定的标签 |
# 抛射物
| 接口 | 描述 | |
|---|---|---|
| GetSourceEntityId | 服务端 | 获取抛射物发射者实体id |
# 经验球
| 接口 | 描述 | |
|---|---|---|
| GetOrbExperience | 服务端 | 获取经验球的经验 |
| SetOrbExperience | 服务端 | 设置经验球经验 |
# 官方伙伴
| 接口 | 描述 | |
|---|---|---|
| Disable | 服务端 | 关闭官方伙伴功能，单人游戏以及本地联机不支持该接口 |
| Enable | 服务端 | 启用官方伙伴功能，单人游戏以及本地联机不支持该接口 |
# 官方聊天扩展
| 接口 | 描述 | |
|---|---|---|
| AddCommonPhrases | 服务端 | 为官方聊天扩展功能添加常用短语。单人模式下单个模组最多添加12条，联机大厅和网络服无条数限制。 |
| Disable | 服务端 | 关闭官方聊天扩展功能。需要在ClientLoadAddonsFinishServerEvent事件中调用。仅在联机大厅和网络服中生效。 |
| Enable | 服务端 | 启用官方聊天扩展功能。需要在ClientLoadAddonsFinishServerEvent事件中调用。仅在联机大厅和网络服中生效。 |
| RegisterChatPrefix | 服务端 | 为游戏内指定玩家注册聊天前缀。仅在主界面消息框和聊天界面游戏频道生效。建议在AddServerPlayerEvent事件中调用，为新玩家添加前缀。 |
| RemoveCommonPhrases | 服务端 | 为官方聊天扩展功能移除常用短语。 |
| SetShowOfficialPhrases | 服务端 | 设置是否显示官方的常用聊天短语。仅在联机大厅和网络服中生效。 |
| SetShowSocialNearbyInfo | 服务端 | 设置是否显示官方聊天社交界面中同一游戏玩家是否在附近信息。 |
# 属性
| 接口 | 描述 | |
|---|---|---|
| AddPlayerExperience | 服务端 | 增加玩家经验值 |
| AddPlayerLevel | 服务端 | 修改玩家等级 |
| CollectOnlineClientData | 服务端 | 收集在线玩家客户端数据，用于判断玩家是否作弊 |
| GetArmorValue | 客户端 | 获取玩家护甲值 |
| GetEnchantmentSeed | 服务端 | 获取玩家的附魔种子，该种子会决定附魔台上准备附魔的装备的附魔项 |
| GetPlayerCurLevelExp | 客户端 | 获取玩家当前等级需要的经验值 |
| GetPlayerExp | 服务端 | 获取玩家当前等级下的经验值 |
| GetPlayerExp | 客户端 | 获取玩家当前等级下的经验值 |
| GetPlayerHealthLevel | 服务端 | 获取玩家健康临界值，当饥饿值大于等于健康临界值时会自动恢复血量，开启饥饿值且开启自然恢复时有效。原版默认值为18 |
| GetPlayerHealthTick | 服务端 | 获取玩家自然恢复速度，当饥饿值大于等于健康临界值时会自动恢复血量，开启饥饿值且开启自然恢复时有效。原版默认值为80刻（即每4秒）恢复1点血量 |
| GetPlayerHunger | 服务端 | 获取玩家饥饿度，展示在UI饥饿度进度条上，初始值为20，即每一个鸡腿代表2个饥饿度。 饱和度(saturation) ：玩家当前饱和度，初始值为5，最大值始终为玩家当前饥饿度(hunger)，该值直接影响玩家饥饿度(hunger)。 1）增加方法：吃食物。 2）减少方法：每触发一次消耗事件，该值减少1，如果该值不大于0，直接把玩家 饥饿度(hunger) 减少1。 |
| GetPlayerHunger | 客户端 | 获取玩家饥饿度，展示在UI饥饿度进度条上，初始值为20，即每一个鸡腿代表2个饥饿度。 饱和度(saturation) ：玩家当前饱和度，初始值为5，最大值始终为玩家当前饥饿度(hunger)，该值直接影响玩家饥饿度(hunger)。 1）增加方法：吃食物。 2）减少方法：每触发一次消耗事件，该值减少1，如果该值不大于0，直接把玩家 饥饿度(hunger) 减少1。 |
| GetPlayerLevel | 服务端 | 获取玩家等级 |
| GetPlayerMaxExhaustionValue | 服务端 | 获取玩家foodExhaustionLevel的归零值，常量值，默认为4。消耗度（exhaustion）是指玩家当前消耗度水平，初始值为0，该值会随着玩家一系列动作（如跳跃）的影响而增加，当该值大于最大消耗度（maxExhaustion）后归零，并且把饱和度（saturation）减少1（为了说明饥饿度机制，我们将此定义为消耗事件） |
| GetPlayerStarveLevel | 服务端 | 获取玩家饥饿临界值，当饥饿值小于饥饿临界值时会自动扣除血量，开启饥饿值且开启饥饿掉血时有效。原版默认值为1 |
| GetPlayerStarveTick | 服务端 | 获取玩家饥饿掉血速度，当饥饿值小于饥饿临界值时会自动扣除血量，开启饥饿值且开启饥饿掉血时有效。原版默认值为80刻（即每4秒）扣除1点血量 |
| GetPlayerTotalExp | 服务端 | 获取玩家的总经验值 |
| GetPlayerTotalExp | 客户端 | 获取玩家的总经验值 |
| IsPlayerNaturalRegen | 服务端 | 是否开启玩家自然恢复，当饥饿值大于等于健康临界值时会自动恢复血量，开启饥饿值且开启自然恢复时有效。原版默认开启 |
| IsPlayerNaturalStarve | 服务端 | 是否开启玩家饥饿掉血，当饥饿值小于饥饿临界值时会自动恢复血量，开启饥饿值且开启饥饿掉血时有效。原版默认开启 |
| SetEnchantmentSeed | 服务端 | 设置玩家的附魔种子，该种子会决定附魔台上准备附魔的装备的附魔项 |
| SetPlayerHealthLevel | 服务端 | 设置玩家健康临界值，当饥饿值大于等于健康临界值时会自动恢复血量，开启饥饿值且开启自然恢复时有效.原版默认值为18 |
| SetPlayerHealthTick | 服务端 | 设置玩家自然恢复速度，当饥饿值大于等于健康临界值时会自动恢复血量，开启饥饿值且开启自然恢复时有效.原版默认值为80刻（即每4秒）恢复1点血量 |
| SetPlayerHunger | 服务端 | 设置玩家饥饿度。 |
| SetPlayerMaxExhaustionValue | 服务端 | 设置玩家最大消耗度(maxExhaustion)，通过调整 最大消耗度(maxExhaustion) 的大小，就可以调整 饥饿度(hunger) 的消耗速度，当 最大消耗度(maxExhaustion) 很大时，饥饿度可以看似一直不下降 |
| SetPlayerNaturalRegen | 服务端 | 设置是否开启玩家自然恢复，当饥饿值大于等于健康临界值时会自动恢复血量，开启饥饿值且开启自然恢复时有效.原版默认开启 |
| SetPlayerNaturalStarve | 服务端 | 设置是否开启玩家饥饿掉血，当饥饿值小于饥饿临界值时会自动扣除血量，开启饥饿值且开启饥饿掉血时有效.原版默认开启 |
| SetPlayerPrefixAndSuffixName | 服务端 | 设置玩家前缀和后缀名字 |
| SetPlayerStarveLevel | 服务端 | 设置玩家饥饿临界值，当饥饿值小于饥饿临界值时会自动扣除血量，开启饥饿值且开启饥饿掉血时有效。原版默认值为1 |
| SetPlayerStarveTick | 服务端 | 设置玩家饥饿掉血速度，当饥饿值小于饥饿临界值时会自动扣除血量，开启饥饿值且开启饥饿掉血时有效.原版默认值为80刻（即每4秒）扣除1点血量 |
| SetPlayerTotalExp | 服务端 | 设置玩家的总经验值 |
| Swing | 客户端 | 本地玩家播放原版攻击动作 |
| getUid | 客户端 | 获取本地玩家的uid |
# 行为
| 接口 | 描述 | |
|---|---|---|
| AddPlayerAroundEntityMotion | 服务端 | 给玩家添加对实体环绕运动器 |
| AddPlayerAroundPointMotion | 服务端 | 给玩家添加对点环绕运动器 |
| AddPlayerTrackMotion | 服务端 | 给玩家添加轨迹运动器 |
| AddPlayerVelocityMotion | 服务端 | 给玩家添加速度运动器 |
| BeginSprinting | 客户端 | 使本地玩家进入并保持向前疾跑/冲刺状态 |
| ChangePlayerDimension | 服务端 | 传送玩家 |
| ChangePlayerFlyState | 服务端 | 给予/取消飞行能力, 并根据enterFly参数确定是否进入飞行状态 |
| EnableKeepInventory | 服务端 | 设置玩家死亡不掉落物品 |
| EndSprinting | 客户端 | 使本地玩家结束向前疾跑/冲刺状态 |
| GetEntityRider | 服务端 | 获取骑乘者正在骑乘的实体的id。 |
| GetEntityRider | 客户端 | 获取骑乘者正在骑乘的实体的id。 |
| GetInteracteCenterOffset | 服务端 | 获取玩家服务端交互中心的偏移 |
| GetIsBlocking | 服务端 | 获取玩家激活盾牌状态 |
| GetPickCenterOffset | 客户端 | 获取玩家设置的第三人称下客户端交互中心的偏移 |
| GetPickRange | 客户端 | 获取玩家客户端的交互距离 |
| GetPlayerExhaustionRatioByType | 服务端 | 获取玩家某行为饥饿度消耗倍率 |
| GetPlayerInteracteRange | 服务端 | 获取玩家服务端的交互距离 |
| GetPlayerMotions | 服务端 | 获取玩家身上的所有运动器 |
| GetPlayerRespawnPos | 服务端 | 获取玩家复活点 |
| GetRelevantPlayer | 服务端 | 获取附近玩家id列表 |
| IsEntityRiding | 服务端 | 检查玩家是否骑乘。 |
| IsPlayerCanFly | 服务端 | 获取玩家能否飞行 |
| IsPlayerFlying | 服务端 | 获取玩家是否在飞行 |
| OpenWorkBench | 服务端 | 在玩家当前位置打开工作台UI，不依赖于工作台方块 |
| PickUpItemEntity | 服务端 | 某个Player拾取物品ItemEntity |
| PlayerAttackEntity | 服务端 | 玩家使用手持武器攻击某个生物 |
| PlayerDestoryBlock | 服务端 | 使用手上工具破坏方块 |
| PlayerUseItemToEntity | 服务端 | 玩家使用手上物品对某个生物使用 |
| PlayerUseItemToPos | 服务端 | 模拟玩家对某个坐标使用物品 |
| RemovePlayerMotion | 服务端 | 移除玩家身上的运动器 |
| SetBanPlayerFishing | 服务端 | 设置是否屏蔽玩家钓鱼功能，屏蔽后玩家可以正常抛甩鱼竿，但无法钓起任何物品 |
| SetInteracteCenterOffset | 服务端 | 设置玩家服务端交互中心的偏移 |
| SetPickCenterOffset | 客户端 | 设置第三人称下，玩家客户端交互中心的偏移 |
| SetPickRange | 客户端 | 设置玩家客户端的交互距离 |
| SetPickUpArea | 服务端 | 设置玩家的拾取物品范围，设置后该玩家的拾取物品范围会在原版拾取范围的基础上进行改变。 |
| SetPlayerAttackSpeedAmplifier | 服务端 | 设置玩家攻击速度倍数，1.0表示正常水平，1.2表示速度减益20%，0.8表示速度增益20% |
| SetPlayerExhaustionRatioByType | 服务端 | 设置玩家某行为饥饿度消耗倍率 |
| SetPlayerInteracteRange | 服务端 | 设置玩家服务端的交互距离 |
| SetPlayerJumpable | 服务端 | 设置玩家是否可跳跃 |
| SetPlayerMotion | 服务端 | 设置玩家的瞬时移动方向向量(可解决SetMotion闪现问题) |
| SetPlayerMovable | 服务端 | 设置玩家是否可移动 |
| SetPlayerRespawnPos | 服务端 | 设置玩家复活的位置与维度 |
| SetPlayerRideEntity | 服务端 | 设置玩家骑乘生物（或者船与矿车） |
| StartPlayerMotion | 服务端 | 启动玩家身上的某个运动器 |
| StopEntityRiding | 服务端 | 强制骑乘者下坐骑。 |
| StopPlayerMotion | 服务端 | 停止玩家身上的某个运动器 |
| isGliding | 客户端 | 是否鞘翅飞行 |
| isInWater | 客户端 | 是否在水中 |
| isMoving | 客户端 | 是否在行走 |
| isRiding | 客户端 | 是否骑乘 |
| isSneaking | 服务端 | 获取玩家是否处于潜行状态 |
| isSneaking | 客户端 | 是否潜行 |
| isSprinting | 客户端 | 是否在疾跑 |
| isSwimming | 服务端 | 获取玩家是否处于游泳状态。 |
| isSwimming | 客户端 | 是否游泳 |
| setMoving | 客户端 | 设置是否行走，只能设置本地玩家（只适用于移动端） |
| setSneaking | 客户端 | 设置是否潜行，只能设置本地玩家（只适用于移动端） |
| setSprinting | 客户端 | 设置行走模式为疾跑/冲刺，只能设置本地玩家（只适用于移动端） |
| setUsingShield | 客户端 | 激活盾牌状态 |
# 渲染
| 接口 | 描述 | |
|---|---|---|
| AddPlayerAnimation | 客户端 | 增加玩家渲染动画 |
| AddPlayerAnimationController | 客户端 | 增加玩家渲染动画控制器 |
| AddPlayerAnimationIntoState | 客户端 | 在玩家的动画控制器中的状态添加动画或者动画控制器 |
| AddPlayerGeometry | 客户端 | 增加玩家渲染几何体 |
| AddPlayerParticleEffect | 客户端 | 增加玩家特效资源 |
| AddPlayerRenderController | 客户端 | 增加玩家渲染控制器 |
| AddPlayerRenderMaterial | 客户端 | 增加玩家渲染需要的材质 |
| AddPlayerScriptAnimate | 客户端 | 在玩家的客户端实体定义（minecraft:client_entity）json中的scripts/animate节点添加动画/动画控制器 |
| AddPlayerSoundEffect | 客户端 | 增加玩家音效资源 |
| AddPlayerTexture | 客户端 | 增加玩家渲染贴图 |
| RebuildPlayerRender | 客户端 | 重建玩家的数据渲染器 |
| RemovePlayerAnimationController | 客户端 | 移除玩家渲染动画控制器 |
| RemovePlayerGeometry | 客户端 | 删除玩家渲染几何体 |
| RemovePlayerRenderController | 客户端 | 删除玩家渲染控制器 |
| ResetSkin | 客户端 | 还原默认皮肤 |
| SetPlayerItemInHandVisible | 客户端 | 设置是否隐藏玩家的手持物品模型显示 |
| SetSkin | 客户端 | 更换原版自定义皮肤 |
# 背包
| 接口 | 描述 | |
|---|---|---|
| AddEnchantToInvItem | 服务端 | 给物品栏的物品添加附魔信息 |
| AddModEnchantToInvItem | 服务端 | 给物品栏中物品添加自定义附魔信息 |
| ChangePlayerItemTipsAndExtraId | 服务端 | 修改玩家物品的自定义tips和自定义标识符 |
| ChangeSelectSlot | 服务端 | 设置玩家当前选中快捷栏物品的index |
| GetCarriedItem | 客户端 | 获取右手物品的信息 |
| GetInvItemEnchantData | 服务端 | 获取物品栏的物品附魔信息 |
| GetInvItemModEnchantData | 服务端 | 获取物品栏的物品自定义附魔信息 |
| GetOffhandItem | 客户端 | 获取左手物品的信息 |
| GetPlayerAllItems | 服务端 | 获取玩家指定的槽位的批量物品信息 |
| GetPlayerAllItems | 客户端 | 获取玩家指定的槽位的批量物品信息，支持获取盔甲栏，副手以及主手物品，背包物品仅支持本地玩家 |
| GetPlayerItem | 服务端 | 获取玩家物品，支持获取背包，盔甲栏，副手以及主手物品 |
| GetPlayerItem | 客户端 | 获取玩家物品，支持获取背包（本地玩家），盔甲栏，副手以及主手物品 |
| GetSelectSlotId | 服务端 | 获取玩家当前选中槽位 |
| GetSlotId | 客户端 | 获取当前手持的快捷栏的槽id |
| RemoveEnchantToInvItem | 服务端 | 给物品栏的物品移除附魔信息 |
| RemoveModEnchantToInvItem | 服务端 | 给物品栏中物品移除自定义附魔信息 |
| SetInvItemExchange | 服务端 | 交换玩家背包物品 |
| SetInvItemNum | 服务端 | 设置玩家背包物品数目 |
| SetPlayerAllItems | 服务端 | 添加批量物品信息到指定槽位 |
| SpawnItemToPlayerCarried | 服务端 | 生成物品到玩家右手 |
| SpawnItemToPlayerInv | 服务端 | 生成物品到玩家背包 |
# 摄像机
| 接口 | 描述 | |
|---|---|---|
| AddCameraAroundEntityMotion | 客户端 | 给相机添加对实体环绕运动器 |
| AddCameraAroundPointMotion | 客户端 | 给相机添加对点环绕运动器 |
| AddCameraTrackMotion | 客户端 | 给相机添加轨迹运动器 |
| AddCameraVelocityMotion | 客户端 | 给相机添加速度运动器 |
| DepartCamera | 客户端 | 分离玩家与摄像机 |
| GetCameraAnchor | 客户端 | 获取相机锚点 |
| GetCameraMotions | 客户端 | 获取相机上的所有运动器 |
| GetCameraOffset | 客户端 | 获取摄像机偏移量 |
| GetCameraPitchLimit | 客户端 | 获取摄像机上下角度限制值 |
| GetCameraRotation | 客户端 | 获取摄像机的朝向 |
| GetForward | 客户端 | 返回相机向前的方向 |
| GetFov | 客户端 | 获取视野大小 |
| GetFpHeight | 客户端 | 获取本地玩家当前状态下，第一人称视角时的摄像机高度偏移量。游泳时，滑翔时以及普通状态下会有所不同 |
| GetPerspective | 客户端 | 获取当前的视角模式 |
| GetPosition | 客户端 | 返回相机中心 |
| IsModCameraLockPitch | 客户端 | 是否锁定摄像机上下角度 |
| IsModCameraLockYaw | 客户端 | 是否锁定摄像机左右角度 |
| LockCamera | 客户端 | 锁定摄像机 |
| LockModCameraPitch | 客户端 | 锁定摄像机上下角度（第三人称下生效，锁定后不能上下调整视角） |
| LockModCameraYaw | 客户端 | 锁定摄像机左右角度（第三人称下生效，锁定后不能通过鼠标左右调整视角） |
| LockPerspective | 客户端 | 锁定玩家的视角模式 |
| RemoveCameraMotion | 客户端 | 移除相机上的某个运动器 |
| ResetCameraBindActorId | 客户端 | 将摄像机重新绑定回主角身上 |
| SetCameraAnchor | 客户端 | 设置相机锚点 |
| SetCameraBindActorId | 客户端 | 将摄像机绑定到目标实体身上（调用者与目标必须在同一个dimension，同时需要在加载范围之内，若绑定后目标离开了范围或者死亡，则会自动解除绑定） |
| SetCameraDistanceFixed | 客户端 | 设置相机弹簧臂固定，即设置当相机遇到阻挡时是否压缩与人物之间的距离 |
| SetCameraOffset | 客户端 | 设置摄像机偏移量 |
| SetCameraPitchLimit | 客户端 | 设置摄像机上下角度限制值，默认是（-90，90） |
| SetCameraPos | 客户端 | 设置相机中心的位置 |
| SetCameraRotation | 客户端 | 设定摄像机的朝向 |
| SetFov | 客户端 | 设置视野大小 |
| SetPerspective | 客户端 | 设置视角模式 |
| SetSpeedFovLock | 客户端 | 是否锁定相机视野fov，锁定后不随速度变化而变化 |
| StartCameraMotion | 客户端 | 启动相机上的某个运动器 |
| StopCameraMotion | 客户端 | 停止相机上的某个运动器 |
| UnDepartCamera | 客户端 | 绑定玩家与摄像机 |
| UnLockCamera | 客户端 | 解除摄像机锁定 |
# 动画
| 接口 | 描述 | |
|---|---|---|
| PlayTpAnimation | 客户端 | 第三人称视角播放玩家通用动作 |
| StopAnimation | 客户端 | 停止播放玩家通用动作 |
# 游戏模式
| 接口 | 描述 | |
|---|---|---|
| GetPlayerGameType | 服务端 | 获取指定玩家的游戏模式 |
| GetPlayerGameType | 客户端 | 获取指定玩家的游戏模式 |
| SetPlayerGameType | 服务端 | 设置玩家个人游戏模式 |
# 权限
| 接口 | 描述 | |
|---|---|---|
| GetPlayerAbilities | 服务端 | 获取玩家具体权限 |
| GetPlayerOperation | 服务端 | 获取玩家权限类型信息 |
| SetAttackMobsAbility | 服务端 | 设置玩家能否攻击生物 |
| SetAttackPlayersAbility | 服务端 | 设置玩家能否攻击其他玩家 |
| SetBuildAbility | 服务端 | 设置玩家能否放置方块，该接口的设置会存档，且只影响生存模式 |
| SetMineAbility | 服务端 | 设置玩家能否摧毁方块，该接口的设置会存档，且只影响生存模式 |
| SetOpenContainersAbility | 服务端 | 设置玩家能否打开容器 |
| SetOperateDoorsAndSwitchesAbility | 服务端 | 设置玩家能否与门和开关交互 |
| SetOperatorCommandAbility | 服务端 | 设置玩家是否具有操作员命令权限 |
| SetPermissionLevel | 服务端 | 设置玩家权限等级 |
| SetPlayerMute | 服务端 | 设置玩家是否禁言，该接口的设置不存档 |
| SetTeleportAbility | 服务端 | 设置玩家能否使用TP指令 |
# 导航
| 接口 | 描述 | |
|---|---|---|
| GetNavPath | 客户端 | 获取本地玩家到目标点的寻路路径，开发者可以通过该接口定制自定义的导航系统。 |
| StartNavTo | 客户端 | 我们提供了一个基于GetNavPath的导航系统实现，做法是在路径上生成序列帧以引导玩家通向目标点，并且当玩家偏离路径会重新进行导航。 |
| StopNav | 客户端 | 终止当前的导航 |
# 方块状态与附加值
| 接口 | 描述 | |
|---|---|---|
| GetBlockAuxValueFromStates | 服务端 | 根据方块名称和方块状态获取方块附加值AuxValue |
| GetBlockStates | 服务端 | 获取方块状态 |
| GetBlockStatesFromAuxValue | 服务端 | 根据方块名称和方块附加值AuxValue获取方块状态 |
| SetBlockStates | 服务端 | 设置方块状态 |
# 属性
| 接口 | 描述 | |
|---|---|---|
| GetBlockBasicInfo | 服务端 | 获取方块基本信息 |
| GetLoadBlocks | 服务端 | 获取已经加载的方块id |
| SetBlockBasicInfo | 服务端 | 设置方块基本信息 |
| SetChestLootTable | 服务端 | 设置箱子战利品表 |
# 方块实体
| 接口 | 描述 | |
|---|---|---|
| CleanBlockTileEntityCustomData | 服务端 | 清空指定位置的特殊方块（箱子、头颅、熔炉、花盆等）绑定的TileEntity内存储的自定义数据。 |
| CreateFrameEffectForBlockEntity | 客户端 | 在自定义方块实体上创建序列帧特效，创建后该接口返回序列帧特效的Id，利用该Id可以使用特效/序列帧中的接口对该序列帧特效进行播放、设置位置、大小等操作。与实体的序列帧特效创建方式类似。 |
| CreateParticleEffectForBlockEntity | 客户端 | 在自定义方块实体上创建粒子特效，创建后该接口返回粒子特效的Id，利用该Id可以使用特效/粒子中的接口对该粒子特效进行播放、设置位置、大小等操作。与实体的粒子特效创建方式类似。若自定义方块实体已存在键值名称相同的特效，则不会创建新的特效，接口返回已有的特效Id。 |
| ExecuteCommandBlock | 服务端 | 执行一次命令方块 |
| GetBlockEntityData | 服务端 | 用于获取可操作某个自定义方块实体数据的对象，操作方式与dict类似 |
| GetBlockEntityData | 服务端 | 用于获取方块（包括自定义方块）的数据，数据只读不可写 |
| GetBlockEntityData | 客户端 | 用于获取客户端当前维度中方块（包括自定义方块）的数据，数据只读不可写，无法获取箱子内的物品信息。 |
| GetBlockEntityMolangValue | 客户端 | 获取自定义方块实体的Molang变量的值。 |
| GetBlockTileEntityCustomData | 服务端 | 读取指定位置的特殊方块（箱子、头颅、熔炉、花盆等）绑定的TileEntity内存储的自定义数据 |
| GetBlockTileEntityWholeCustomData | 服务端 | 读取指定位置的特殊方块（箱子、头颅、熔炉、花盆等）绑定的TileEntity内存储的自定义数据字典。 |
| GetCommandBlock | 服务端 | 获取命令方块的设置内容 |
| GetFrameEffectIdInBlockEntity | 客户端 | 获取在自定义方块实体中已创建的指定序列帧特效的Id，已创建的特效分为两种：一是通过resource_pack/entity/下的实体json文件中使用“netease_frame_effects”所定义的特效；二是使用接口CreateFrameEffectForBlockEntity创建的特效。 返回的特效Id可以使用特效/序列帧中的接口对该序列帧特效进行播放、设置位置、大小等操作。与实体的序列帧特效创建方式类似。 |
| GetFrameItem | 服务端 | 获取物品展示框的物品 |
| GetFrameItemDropChange | 服务端 | 获取物品展示框里物品的掉落几率 |
| GetFrameRotation | 服务端 | 获取物品展示框里物品的顺时针旋转角度 |
| GetHopperSpeed | 服务端 | 获取漏斗运输一个物品所需的时间（单位：刻） |
| GetParticleEffectIdInBlockEntity | 客户端 | 获取在自定义方块实体中已创建的指定粒子特效的Id，已创建的特效分为两种：一是通过resource_pack/entity/下的实体json文件中使用“netease_particle_effects”所定义的特效；二是使用接口CreateParticleEffectForBlockEntity创建的特效。 返回的特效Id可以使用特效/粒子中的接口对该粒子特效进行播放、设置位置、大小等操作。与实体的粒子特效创建方式类似。 |
| RemoveFrameEffectInBlockEntity | 客户端 | 移除在自定义方块实体上创建的序列帧特效。移除后的特效Id将会失效。 |
| RemoveParticleEffectInBlockEntity | 客户端 | 移除在自定义方块实体上创建的粒子特效。移除后的特效Id将会失效。 |
| SetBlockEntityMolangValue | 客户端 | 设置自定义方块实体的Molang变量，与实体的molang变量作用相同。目前主要用于控制自定义实体的动画状态转变。Molang变量的定义方式与原版实体的Molang变量定义方法相同。详细可参考自定义方块实体动画的教学文档。 |
| SetBlockTileEntityCustomData | 服务端 | 设置指定位置的特殊方块（箱子、头颅、熔炉、花盆等）绑定的TileEntity内存储的自定义数据。 |
| SetCommandBlock | 服务端 | 对命令方块进行内容设置 |
| SetEnableBlockEntityAnimations | 客户端 | 设置是否开启自定义方块实体的动画效果，开启之后，自定义实体方块会按照实体文件中animation_controller所定义的动画状态机进行动画播放。关闭之后，则会停止所有动画播放。 |
| SetFrameItem | 服务端 | 设置物品展示框的物品 |
| SetFrameItemDropChange | 服务端 | 设置点击物品展示框时生成掉落的几率，默认为1 |
| SetFrameRotation | 服务端 | 设置物品展示框里物品的顺时针旋转角度 |
| SetHopperSpeed | 服务端 | 设置漏斗运输一个物品所需的时间（单位：红石刻，1秒10刻），默认值为4刻，该设置存档 |
# 方块几何体模型
| 接口 | 描述 | |
|---|---|---|
| CombineBlockBetweenPosToGeometry | 客户端 | 根据输入的两个位置，搜索这两个位置之间的所有方块，并将这些方块合并和转换为能用于实体的几何体模型。 |
| CombineBlockFromPosListToGeometry | 客户端 | 根据输入的方块位置列表，搜索这些位置的所有方块，并将这些方块合并和转换为能用于实体的几何体模型。 |
| CombineBlockPaletteToGeometry | 客户端 | 将BlockPalette中的所有方块合并并转换为能用于实体的几何体模型。 |
| EnableActorBlockGeometryTransparent | 客户端 | 设置是否允许实体的方块几何体模型产生透明度，允许开启后通过调节方块几何体的透明度将会使得方块几何体模型变得透明。 |
| SetActorBlockGeometryOffset | 客户端 | 设置实体的方块几何体模型的位置偏移。 |
| SetActorBlockGeometryRotation | 客户端 | 设置实体的方块几何体模型的旋转角度。 |
| SetActorBlockGeometryTransparency | 客户端 | 设置实体的方块几何体模型的透明度。注意，只有调用接口EnableActorBlockGeometryTransparent开启了方块几何体模型的透明度后该接口才会生效。 |
# 方块调色板
| 接口 | 描述 | |
|---|---|---|
| DeleteBlockInBlockPalette | 服务端 客户端 | 删除方块调色板BlockPalette中某个类型的方块。 |
| DeserializeBlockPalette | 服务端 客户端 | 反序列化方块调色板数据字典中的数据，用于方块调色板在客户端及服务端的事件数据之间传输。 |
| GetBlockCountInBlockPalette | 服务端 客户端 | 获取方块调色板BlockPalette中某个类型的方块的数量。 |
| GetLocalPosListOfBlocks | 服务端 客户端 | 获取方块调色板中某种方块的相对位置列表。方块调色板记录了多个方块组成的一个三维空间下的方块组合，而相对位置则指的是，以这些方块中最小坐标的方块所在位置作为原点的坐标轴下的相对位置。 |
| GetVolumeOfBlockPalette | 服务端 客户端 | 获取方块调色板BlockPalette所占据的长方体的长宽高。长指的是在方块调色板BlockPalette在世界坐标中占据的x轴方向的长度，宽指的是z轴方向的长度，高指的是y轴方向的长度。 |
| ReplaceAirByStructureVoid | 服务端 客户端 | 设置是否将方块调色板BlockPalette中所有空气替换为结构空位。 |
| ReplaceBlockInBlockPalette | 服务端 客户端 | 替换方块调色板BlockPalette中某个类型的方块。 |
| SerializeBlockPalette | 服务端 客户端 | 序列化方块调色板中的数据，用于方块调色板在客户端及服务端的事件数据之间传输。 |
# 渲染
| 接口 | 描述 | |
|---|---|---|
| AddDropItemToWorld | 客户端 | 在客户端添加一个掉落物渲染 |
| ChangeBlockTextures | 客户端 | 替换方块贴图 |
| DeleteClientDropItemEntity | 客户端 | 删除AddDropItemToWorld创建的客户端掉落物 |
| GetBlockEntityExtraUniforms | 客户端 | 获取在自定义方块实体的shader当中使用的自定义变量的值，该自定义变量总共可设置EXTRA_ACTOR_UNIFORM1,EXTRA_ACTOR_UNIFORM2,EXTRA_ACTOR_UNIFORM3,EXTRA_ACTOR_UNIFORM4，总共4组，每组为一个vec4(float, float, float ,float)类型的向量。 |
| GetBlockRenderDistance | 客户端 | 获取玩家周围的可渲染距离 |
| GetBlockTextures | 客户端 | 获取方块的初始贴图信息 |
| GetClientDropItemEntityIdList | 客户端 | 获得所有通过AddDropItemToWorld创建的entityId的list |
| SetBlockEntityExtraUniforms | 客户端 | 设置可在自定义方块实体的shader当中使用的自定义变量的值，该自定义变量总共可设置EXTRA_ACTOR_UNIFORM1,EXTRA_ACTOR_UNIFORM2,EXTRA_ACTOR_UNIFORM3,EXTRA_ACTOR_UNIFORM4，总共4组，每组为一个vec4(float, float, float ,float)类型的向量，向量的默认值为(1.0,1.0,1.0,1.0)。 |
| SetBlockEntityFramePosOffset | 客户端 | 设置自定义方块实体中序列帧特效位置偏移值，用于调整序列帧特效相对于方块位置的偏移。与特效/序列帧/SetPos接口不同，该接口调整的是相对于方块位置的位置偏移值，而不是世界坐标。 |
| SetBlockEntityModelPosOffset | 客户端 | 设置自定义方块实体的实体模型位置偏移值，用于调整实体模型相对于方块位置的偏移。可通过该接口来调整自定义方块实体的实体模型的位置。只有自定义方块实体定义实体模型才生效，实体模型在resource_pack/entity/下定义，详细可参考自定义方块实体动画的教学文档。 |
| SetBlockEntityModelRotation | 客户端 | 设置自定义方块实体的实体模型在各个轴上的旋转值，可通过该接口来调整自定义方块实体的实体模型的旋转。只有自定义方块实体定义实体模型才生效，实体模型在resource_pack/entity/下定义，详细可参考自定义方块实体动画的教学文档。 |
| SetBlockEntityModelScale | 客户端 | 设置自定义方块实体的实体模型大小的缩放值，可通过该接口来调整自定义方块实体的实体模型的大小。只有自定义方块实体定义实体模型才生效，实体模型在resource_pack/entity/下定义，详细可参考自定义方块实体动画的教学文档。 |
| SetBlockEntityParticlePosOffset | 客户端 | 设置自定义方块实体中粒子特效位置偏移值，用于调整粒子特效相对于方块位置的偏移。与特效/粒子/SetPos接口不同，该接口调整的是相对于方块位置的位置偏移值，而不是世界坐标。 |
| SetBlockRenderDistance | 客户端 | 设置玩家周围方块的可渲染距离 |
# 容器
| 接口 | 描述 | |
|---|---|---|
| GetBrewingStandSlotItem | 服务端 | 获取酿造台指定槽位物品 |
| GetChestBoxSize | 服务端 | 获取箱子容量大小 |
| GetChestPairedPosition | 服务端 | 获取与箱子A合并成一个大箱子的箱子B的坐标 |
| GetContainerItem | 服务端 | 获取容器内的物品 |
| GetContainerSize | 服务端 | 获取容器容量大小 |
| GetEnderChestItem | 服务端 | 获取末影箱内的物品 |
| GetInputSlotItem | 服务端 | 获取熔炉输入栏物品, 支持使用下面参数清空特定槽位:itemDict为空，为{}, 或itemName为minecraft:air，或者count为0 |
| GetOpenContainerItem | 服务端 | 获取开放容器的物品 |
| GetOutputSlotItem | 服务端 | 获取熔炉输出栏物品 |
| GetPlayerUIItem | 服务端 | 获取合成容器的物品 |
| SetBrewingStandSlotItem | 服务端 | 设置酿造台指定槽位物品 |
| SetChestBoxItemExchange | 服务端 | 交换箱子里物品的槽位 |
| SetChestBoxItemNum | 服务端 | 设置箱子槽位物品数目 |
| SetInputSlotItem | 服务端 | 设置熔炉输入栏物品 |
| SetPlayerUIItem | 服务端 | 设置合成容器的物品 |
| SpawnItemToContainer | 服务端 | 生成物品到容器方块的物品栏 |
| SpawnItemToEnderChest | 服务端 | 生成物品到末影箱 |
# 红石
| 接口 | 描述 | |
|---|---|---|
| GetBlockPoweredState | 服务端 | 获取某个坐标方块的充能状态 |
| GetStrength | 服务端 | 获取某个坐标的红石信号强度 |
# 告示牌
| 接口 | 描述 | |
|---|---|---|
| GetSignBlockText | 服务端 | 获取告示牌（方块）的文本内容 |
| GetSignTextStyle | 服务端 | 获取告示牌的文本样式信息 |
| SetSignBlockText | 服务端 | 设置告示牌（方块）的文本内容 |
| SetSignTextStyle | 服务端 | 设置告示牌的文本样式 |
# 床
| 接口 | 描述 | |
|---|---|---|
| GetBedColor | 服务端 | 获取床（方块）的颜色 |
| SetBedColor | 服务端 | 设置床（方块）的颜色 |
# 物品
| 接口 | 描述 | |
|---|---|---|
| CancelShearsDestoryBlockSpeed | 服务端 | 取消剪刀对某一方块的破坏速度设置 |
| CancelShearsDestoryBlockSpeedAll | 服务端 | 取消剪刀对全部方块的破坏速度设置 |
| ChangeArmorTextures | 客户端 | 修改盔甲在场景中显示和在UI中显示的贴图 |
| ChangeItemTexture | 客户端 | 替换物品的贴图，修改后所有用到该贴图的物品都会被改变，后续创建的此类物品也会被改变。会同时修改物品在UI界面上的显示，手持时候的显示与场景掉落的显示。 |
| GetAllEnchantsInfo | 服务端 | 获取目前已注册的所有附魔信息 |
| GetAllEnchantsInfo | 客户端 | 获取目前已注册的所有附魔信息 |
| GetCustomName | 服务端 | 获取物品的自定义名称，与铁砧修改的名称一致 |
| GetItemBasicInfo | 服务端 | 获取物品的基础信息 |
| GetItemBasicInfo | 客户端 | 获取物品的基础信息 |
| GetItemDefenceAngle | 服务端 | 获取盾牌物品的抵挡角度范围 |
| GetItemDurability | 服务端 | 获取指定槽位的物品耐久 |
| GetItemEffectName | 客户端 | 获取物品的状态描述，如：§7保护 0§r |
| GetItemFormattedHoverText | 客户端 | 获取物品的格式化hover文本，如：§f灾厄旗帜§r |
| GetItemHoverName | 客户端 | 获取物品的hover名称，如：灾厄旗帜§r |
| GetItemLayer | 服务端 | 获取物品的叠加贴图。物品叠加贴图详见SetItemLayer |
| GetItemMaxDurability | 服务端 | 获取指定槽位的物品耐最大耐久 |
| GetItemTexture | 客户端 | 获取item_texture.json中物品的贴图路径。 |
| GetLoadItems | 服务端 | 获取已经加载的物品id |
| GetUserDataInEvent | 服务端 | 使物品相关服务端事件的物品信息字典参数带有userData。在mod初始化时调用即可 |
| GetUserDataInEvent | 客户端 | 使物品相关客户端事件的物品信息字典参数带有userData。在mod初始化时调用即可 |
| LookupItemByName | 服务端 | 判定指定identifier的物品是否存在 |
| RemoveItemLayer | 服务端 | 移除物品的叠加贴图。物品叠加贴图详见SetItemLayer |
| SetAttackDamage | 服务端 | 设置物品的攻击伤害值 |
| SetCustomName | 服务端 | 设置物品的自定义名称，与使用铁砧重命名一致 |
| SetItemDefenceAngle | 服务端 | 设置盾牌物品的抵挡角度范围 |
| SetItemDurability | 服务端 | 设置物品的耐久值 |
| SetItemLayer | 服务端 | 设置物品的叠加贴图，可以在物品的上层与下层叠加自定义贴图。具体使用可参考CustomItemsMod示例。 |
| SetItemMaxDurability | 服务端 | 设置物品的最大耐久值 |
| SetItemTierLevel | 服务端 | 设置工具类物品的挖掘等级 |
| SetItemTierSpeed | 服务端 | 设置工具类物品的挖掘速度 |
| SetMaxStackSize | 服务端 | 设置物品的最大堆叠数量（存档） |
| SetShearsDestoryBlockSpeed | 服务端 | 设置剪刀对某一方块的破坏速度 |
# 通用
| 接口 | 描述 | |
|---|---|---|
| DestroyEntity | 客户端 | 销毁特效 |
# 文字面板
| 接口 | 描述 | |
|---|---|---|
| CreateTextBoardInWorld | 客户端 | 创建文字面板 |
| RemoveTextBoard | 客户端 | 删除文字面板 |
| SetBoardBackgroundColor | 客户端 | 修改背景颜色 |
| SetBoardBindEntity | 客户端 | 文字面板绑定实体对象 |
| SetBoardDepthTest | 客户端 | 设置是否开启深度测试, 默认状态下是开启 |
| SetBoardFaceCamera | 客户端 | 设置文字面板的朝向 |
| SetBoardPos | 客户端 | 修改位置 |
| SetBoardRot | 客户端 | 修改旋转角度, 若设置了文本朝向相机，则旋转角度的修改不会生效 |
| SetBoardScale | 客户端 | 内容整体缩放 |
| SetBoardTextColor | 客户端 | 修改字体颜色 |
| SetText | 客户端 | 修改文字面板内容 |
# 序列帧
| 接口 | 描述 | |
|---|---|---|
| Bind | 客户端 | 绑定entity |
| Bind | 客户端 | 绑定骨骼模型 |
| CreateEngineSfx | 客户端 | 创建序列帧特效 |
| CreateEngineSfxFromEditor | 客户端 | 指使用资源包中effects/xxx.json，按照编辑器中编辑好的参数创建序列帧。支持环状序列帧 |
| GetPos | 客户端 | 获取序列帧特效的位置 |
| GetRot | 客户端 | 获取序列帧特效的旋转角度 |
| GetScale | 客户端 | 获取序列帧特效的缩放值 |
| Pause | 客户端 | 暂停播放，序列帧定格在当前时刻，再次调用Play时继续播放 |
| Play | 客户端 | 播放序列帧 |
| SetDeepTest | 客户端 | 设置序列帧是否透视，默认为否 |
| SetFaceCamera | 客户端 | 设置序列帧是否始终朝向摄像机，默认为是 |
| SetFadeDistance | 客户端 | 设置序列帧开始自动调整透明度的距离。序列帧与摄像机之间的距离小于该值时会自动调整序列帧的透明度，距离摄像机越近，序列帧越透明 |
| SetLayer | 客户端 | 设置序列帧渲染层级，默认层级为1，当层级不为1时表示该特效开启特效分层渲染功能。特效（粒子和帧动画）分层渲染时，层级越高渲染越靠后，层级大的会遮挡层级低的，且同一层级的特效会根据特效的相对位置产生正确的相互遮挡关系。 |
| SetLoop | 客户端 | 设置序列帧是否循环播放，默认为否 |
| SetMixColor | 客户端 | 设置序列帧混合颜色 |
| SetPos | 客户端 | 设置序列帧的位置 |
| SetRot | 客户端 | 设置序列帧的旋转 |
| SetRotUseZXY | 客户端 | 设置序列帧的旋转，旋转顺序按照绕z,x,y轴旋转 |
| SetScale | 客户端 | 设置序列帧的缩放 |
| SetUsePointFiltering | 客户端 | 设置序列帧是否使用点滤波 |
| Stop | 客户端 | 停止序列帧（不是暂停） |
# 粒子
| 接口 | 描述 | |
|---|---|---|
| Bind | 客户端 | 绑定entity |
| Bind | 客户端 | 绑定骨骼模型 |
| CreateEngineParticle | 客户端 | 用于创建粒子特效 |
| GetParticleEmissionRate | 客户端 | 获取粒子发射器每帧发射粒子的频率。 |
| GetParticleMaxNum | 客户端 | 获取粒子发射器包含的最大粒子数量。 |
| GetParticleMaxSize | 客户端 | 获取粒子特效中粒子大小的最大值。 |
| GetParticleMinSize | 客户端 | 获取粒子特效中粒子大小的最小值。 |
| GetParticleVolumeSize | 客户端 | 获取粒子发射器的体积大小缩放值。 |
| GetPos | 客户端 | 获取粒子发射器的世界坐标位置 |
| GetRot | 客户端 | 获取粒子发射器的旋转角度 |
| Pause | 客户端 | 暂停播放，粒子定格在当前时刻，再次调用Play时继续播放 |
| Play | 客户端 | 播放粒子特效 |
| SetFadeDistance | 客户端 | 设置粒子开始自动调整透明度的距离。粒子与摄像机之间的距离小于该值时会自动调整粒子的透明度，距离摄像机越近，粒子越透明 |
| SetLayer | 客户端 | 粒子默认层级为1，当层级不为1时表示该特效开启特效分层渲染功能。特效（粒子和帧动画）分层渲染时，层级越高渲染越靠后，层级大的会遮挡层级低的，且同一层级的特效会根据特效的相对位置产生正确的相互遮挡关系。 |
| SetParticleEmissionRate | 客户端 | 设置粒子发射器每帧发射粒子的频率，频率越大则每帧发射的粒子数量越多，但粒子数量不会超过粒子发射器的粒子容量，同时由于性能考虑，每帧发射的粒子数量也不会超过100个。 |
| SetParticleMaxNum | 客户端 | 设置粒子发射器的粒子容量，即粒子发射器所包含的最大粒子数量。该数量并不代表目前粒子发射器所发射的粒子数量，如需要增加发射的粒子数量，需同时改变粒子的发射频率。 |
| SetParticleSize | 客户端 | 设置粒子特效中粒子大小的最小值及最大值。 |
| SetParticleVolumeSize | 客户端 | 设置粒子发射器的体积大小缩放，不影响单个粒子的尺寸。粒子发射器的体积越大，则粒子的发射范围越大。 |
| SetPos | 客户端 | 设置粒子发射器的世界坐标位置 |
| SetRelative | 客户端 | 当粒子绑定了entity或骨骼模型时，发射出的粒子使用entity坐标系还是世界坐标系。与mcstudio特效编辑器中粒子的“相对挂点运动”选项功能相同。 |
| SetRotUseZXY | 客户端 | 设置粒子发射器的旋转，旋转顺序按照绕z,x,y轴旋转 |
| SetUsePointFiltering | 客户端 | 设置粒子材质的纹理滤波是否使用点滤波方法。默认为使用双线性滤波 |
| Stop | 客户端 | 停止粒子播放 |
# 模型特效
| 接口 | 描述 | |
|---|---|---|
| CreateEngineEffectBind | 客户端 | 指用编辑器保存资源包中models/bind/xxx_bind.json生成编辑好的所有挂点的所有特效。生成的特效会自动进行挂接及播放，编辑器中设为不可见的特效也会进行播放。并且使用这种方式创建的特效，开发者不用维护entity进出视野导致的挂接特效被移除，引擎会在entity每次进入视野时自动创建所有特效。 |
| Pause | 客户端 | 暂停模型特效（即使用CreateEngineEffectBind创建的特效） |
| Resume | 客户端 | 继续播放模型特效（即使用CreateEngineEffectBind创建的特效） |
# 微软粒子
| 接口 | 描述 | |
|---|---|---|
| BindEntity | 客户端 | 绑定粒子发射器到指定实体的指定骨骼上 |
| BindModel | 客户端 | 绑定粒子发射器到指定骨骼模型的指定骨骼上 |
| Create | 客户端 | 创建粒子发射器, 创建后立即播放 |
| CreateBindEntityNew | 客户端 | 创建粒子发射器并绑定到指定实体的指定骨骼上, 创建后立即播放 |
| EmitManually | 客户端 | 手动发射粒子一次 |
| Exist | 客户端 | 判断指定粒子发射器是否存在 |
| GetActiveDuration | 客户端 | 获取粒子发射器的激活周期 |
| GetBindingID | 客户端 | 返回粒子绑定的实体id，没有则返回"0" |
| GetBindingModelID | 客户端 | 返回绑定的骨骼模型id 没有则返回-1 |
| GetDuration | 客户端 | 获取粒子发射器的播放周期(激活+休眠时间) |
| GetFacingMode | 客户端 | 返回粒子发射器的粒子朝向模式 |
| GetLoopAge | 客户端 | 获取粒子发射器当前播放周期内已播放的时间 |
| GetPos | 客户端 | 获取粒子发射器位置 |
| GetRot | 客户端 | 获取粒子发射器局部旋转 |
| GetSleepDuration | 客户端 | 获取粒子发射器的休眠周期 |
| GetTimeScale | 客户端 | 获取粒子发射器的播放速度 |
| GetVariable | 客户端 | 获取粒子发射器的Molang变量值 |
| Hide | 客户端 | 隐藏粒子发射器(不渲染) |
| IsHiding | 客户端 | 返回粒子发射器是否正在被隐藏(不渲染) |
| IsPausing | 客户端 | 返回粒子发射器的逻辑是否正在被暂停 |
| Pause | 客户端 | 暂停粒子发射器的逻辑更新，但保持渲染状态 |
| Play | 客户端 | 播放粒子发射器 |
| PlayAt | 客户端 | 设置粒子发射器播放时间点 |
| Remove | 客户端 | 销毁指定粒子发射器 |
| RemoveByName | 客户端 | 销毁场景中指定名称(粒子发射器json中的identifier)的所有粒子发射器 |
| Replay | 客户端 | 重播粒子发射器 |
| Resume | 客户端 | 恢复粒子发射器的逻辑更新，不影响渲染状态 |
| SetPos | 客户端 | 设置粒子发射器位置 |
| SetRelative | 客户端 | 设置粒子是否在局部空间进行计算 |
| SetRot | 客户端 | 设置粒子发射器局部旋转 |
| SetRotUseZXY | 客户端 | 设置粒子发射器局部旋转，旋转顺序按照绕z,x,y轴旋转 |
| SetTimeScale | 客户端 | 设置粒子发射器的播放速度 |
| SetVariable | 客户端 | 设置粒子发射器的Molang变量值 |
| Show | 客户端 | 显示粒子发射器(开启渲染) |
| Stop | 客户端 | 停止粒子发射器播放(不渲染且不更新逻辑) |
| Unbind | 客户端 | 解除指定粒子发射器的绑定状态 |
# 模型
| 接口 | 描述 | |
|---|---|---|
| BindItemToBone | 客户端 | 将使用了骨骼模型的玩家的手持物绑定到指定的骨骼上 |
| BindModelToEntity | 客户端 | 实体替换骨骼模型后，再往上挂接其他骨骼模型。 |
| BindModelToModel | 客户端 | 在骨骼模型上挂接其他骨骼模型 |
| CancelAllBoneMask | 客户端 | 取消动画中的所有骨骼屏蔽。 |
| CreateFreeModel | 客户端 | 创建自由的模型（无需绑定Entity） |
| GetAllBindModelToEntity | 客户端 | 获取实体上某个骨骼上挂接的所有骨骼模型的id |
| GetAnimLength | 客户端 | 获取某个骨骼动画的长度，单位为秒 |
| GetBonePositionFromMinecraftObject | 客户端 | 获取原版模型的骨骼世界坐标 |
| GetBoneWorldPos | 客户端 | 获取骨骼的坐标 |
| GetEntityBoneWorldPos | 客户端 | 获取换了骨骼模型的实体的骨骼坐标 |
| GetEntityScale | 服务端 | 获取实体的放缩比例大小 |
| GetExtraUniformValue | 客户端 | 获取在骨骼模型shader中使用的自定义变量Uniform的值 |
| GetModelId | 客户端 | 获取骨骼模型的Id，主要用于特效绑定骨骼模型 |
| GetModelMaterial | 客户端 | 获取骨骼模型的正在使用的材质名称，也可获取骨骼模型中指定骨骼所使用的材质名称。如果获取指定骨骼所使用的材质，需要先在netease_model.json下设置"useSplitMeshes"字段为true。 |
| GetModelName | 服务端 | 获取实体的模型名称 |
| GetModelStyle | 客户端 | 获取模型类型 |
| GetPlayingAnimList | 客户端 | 获取指定的骨骼模型中正处于播放状态的骨骼动画名称列表 |
| GetTexture | 客户端 | 获取骨骼模型的贴图路径 |
| HideModel | 客户端 | 隐藏纯模型 |
| ModelPlayAni | 客户端 | 纯骨骼播放动作。 支持骨骼动画混合，可参考SetAnimationBoneMask接口以及RegisterAnim1DControlParam接口说明。 |
| ModelStopAni | 客户端 | 暂停指定的骨骼动画 |
| PlayAnim | 客户端 | 播放骨骼动画 |
| RegisterAnim1DControlParam | 客户端 | 当同时播放多个骨骼动画时，新建用于控制动画进行1D线性混合的参数。目前线性混合仅支持对两个动画进行混合。新建的参数值范围为[0,1]。指定的骨骼将会按照这个参数的值对两个动画进行线性混合。 |
| RegisterAnim1DMultiControlParam | 客户端 | 当同时播放多个骨骼动画时，注册用于根据权重控制多动画进行混合的参数 |
| RemoveAnim1DMultiControlParam | 客户端 | 删除用于根据权重控制多动画进行混合的参数 |
| RemoveFreeModel | 客户端 | 移除自由模型 |
| ResetModel | 客户端 | 恢复实体为原版模型 |
| SetAnim1DControlParam | 客户端 | 新建动画的1D控制参数后，使用该接口对相应的参数进行控制。 |
| SetAnim1DMultiControlParam | 客户端 | 新建动画的1D控制参数后，设置用于根据权重控制多动画进行混合的参数 |
| SetAnimLayer | 客户端 | 设置骨骼动画的层级，动画层级越大，则优先度越高，骨骼模型的骨骼优先播放优先度最高的动画，相同层级的动画则优先播放率先播放的动画。 |
| SetAnimSpeed | 客户端 | 设置某个骨骼动画的播放速度 |
| SetAnimationAllBoneMask | 客户端 | 设置是否屏蔽动画中所有骨骼的动画，若开启骨骼屏蔽后，该骨骼将不再播放该动画中的动作。该接口会对该动画中所有骨骼生效，可通过参数ignoreBoneList来指定不受影响的骨骼名称。通过屏蔽指定骨骼的动画可实现同一个骨骼模型同时在不同骨骼上播放不同的动作动画，从而实现快捷的动作融合。 |
| SetAnimationBoneMask | 客户端 | 设置是否屏蔽动画中指定的骨骼的动画，若开启骨骼屏蔽后，该骨骼将不再播放该动画中的动作。通过屏蔽指定骨骼的动画可实现同一个骨骼模型同时在不同骨骼上播放不同的动作动画，从而实现快捷的动作融合。 |
| SetBrightness | 客户端 | 设置实体的亮度 |
| SetEntityOpacity | 客户端 | 设置骨骼模型的透明度，只能对骨骼模型生效，如果设置的是原版模型，则模型的影子会被隐藏。 |
| SetEntityScale | 服务端 | 设置实体的放缩比例大小，设置比例过大会导致游戏卡顿，建议控制在20倍以内 |
| SetEntityShadowShow | 客户端 | 设置实体打开/关闭影子渲染 |
| SetExtraUniformValue | 客户端 | 设置shader中特定Uniform的值 |
| SetFreeModelAniSpeed | 客户端 | 设置自由模型动画的播放速度 |
| SetFreeModelBoundingBox | 客户端 | 设置自由模型的包围盒 |
| SetFreeModelPos | 客户端 | 设置自由模型的位置 |
| SetFreeModelRot | 客户端 | 设置自由模型的方向 |
| SetFreeModelScale | 客户端 | 设置自由模型的大小 |
| SetLegacyBindRot | 客户端 | 用于修复特效挂接到骨骼时的方向 |
| SetModel | 服务端 | 设置骨骼模型 |
| SetModel | 客户端 | 替换实体的骨骼模型 |
| SetModelMaterial | 客户端 | 设置骨骼模型所使用的的材质，除了可以设置骨骼模型所使用的自定义材质以外，也可对单个骨骼设置所使用的自定义材质。如果需要设置单个骨骼所使用的材质，需要先在netease_model.json下设置"useSplitMeshes"字段为true。 |
| SetModelMultiPassMaterial | 客户端 | 设置骨骼模型多pass中使用到的材质列表，也可对单个骨骼设置所使用的自定义多Pass材质。如果需要设置单个骨骼所使用的多Pass材质，需要先在netease_model.json下设置"useSplitMeshes"字段为true。 |
| SetModelOffset | 服务端 | 设置骨骼模型相对于局部坐标系的偏移量，初始值为(0, 0, 0) |
| SetModelOffset | 客户端 | 模型增加偏移量 |
| SetModelPartVisible | 客户端 | 对骨骼模型中指定的骨骼进行渲染屏蔽，屏蔽后该骨骼不会被渲染出来。 |
| SetModelPerspectiveEffect | 客户端 | 设置模型透视效果。注：只对自定义骨骼模型生效 |
| SetModelTexture | 服务端 | 设置骨骼模型贴图，该接口与SetTexture功能相同，但属于服务端接口。 |
| SetShowArmModel | 客户端 | 设置使用骨骼模型后切换至第一人称时是否显示手部模型。需要先为骨骼模型定义arm_model，arm_model的定义可参考demo示例-AwesomeMod中的resourcePack/models/netease_models.json中的大天狗模型定义 |
| SetTexture | 客户端 | 设置骨骼模型的贴图，该接口与SetModelTexture功能相同，但属于客户端接口。 |
| ShowCommonHurtColor | 服务端 | 设置挂接骨骼模型的实体是否显示通用的受伤变红效果 |
| ShowCommonHurtColor | 客户端 | 设置挂接骨骼模型的实体是否显示通用的受伤变红效果 |
| ShowModel | 客户端 | 显示纯模型 |
| UnBindModelToEntity | 客户端 | 取消实体上挂接的某个骨骼模型。取消挂接后，这个modelId的模型便会销毁，无法再使用，如果是临时隐藏可以使用HideModel |
| UnBindModelToModel | 客户端 | 取消骨骼模型上挂接的某个骨骼模型。取消挂接后，这个modelId的模型便会销毁，无法再使用，如果是临时隐藏可以使用HideModel |
# 原生UI
| 接口 | 描述 | |
|---|---|---|
| ChangeSneakState | 客户端 | 切换潜行状态 |
| ChangeWalkState | 客户端 | 切换行走/潜行/跑步状态 |
| ClickInteractGUI | 客户端 | 模拟点击交互按钮，交互按钮指的在喂食、钓鱼、交易等交互场景出现的按钮 |
| GetOriginAreaOffset | 客户端 | 获取指定原生UI的offset,包括左上角和右下角 |
| GetScreenSize | 客户端 | 获取游戏分辨率 |
| GetScreenViewInfo | 客户端 | 获取游戏视角信息。首先获得当前分辨率下UI放大倍数，计算方式可参考《我的世界》界面适配方法。则当前游戏视角的宽度的计算方式为：若当前分辨率的宽度能被该放大倍数整除，则等于当前分辨率，若不能，则等于当前分辨率加放大倍数再减去当前分辨率对放大倍数求余的结果，当前游戏视角的高度计算方法类似。例：以分辨率为1792，828的手机计算，画布是分辨率的3倍，所以x = 1792 + 3 - 1 = 1794；y = 828，该接口返回的结果为(1794.0, 828.0, 0.0, 0.0) |
| GetWalkState | 客户端 | 获取玩家行走/潜行/跑步状态 |
| HideAirSupplyGUI | 客户端 | 隐藏玩家氧气值界面 |
| HideArmorGui | 客户端 | 隐藏hud界面的护甲值显示 |
| HideChangePersonGui | 客户端 | 隐藏切换人称的按钮。隐藏后点击相应位置不会响应 |
| HideChatGUI | 客户端 | 隐藏聊天按钮原生UI。该接口在开启新版聊天时不生效 |
| HideCrossHairGUI | 客户端 | 隐藏hud界面的十字准心显示 |
| HideEmoteGUI | 客户端 | 设置是否开启表情功能，默认PC端关闭，手机端开启，且该接口只能在手机端使用。该接口在开启新版聊天时不生效 |
| HideExpGui | 客户端 | 非创造者模式下隐藏经验条显示 |
| HideFoldGUI | 客户端 | 隐藏下拉按钮原生UI。 |
| HideHealthGui | 客户端 | 隐藏hud界面的血量显示 |
| HideHorseHealthGui | 客户端 | 隐藏hud界面的坐骑的血量显示 |
| HideHudGUI | 客户端 | 隐藏HUD游戏界面的游戏原生UI。与原版F1按钮效果一致，只隐藏显示，但点击跳跃键等位置依然会响应 |
| HideHungerGui | 客户端 | 隐藏hud界面的饥饿值显示 |
| HideInteractGui | 客户端 | 隐藏交互按钮。隐藏后点击相应位置不会响应 |
| HideJumpGui | 客户端 | 隐藏游戏中右下角的跳跃按钮。隐藏后点击相应位置不会响应 |
| HideMoveGui | 客户端 | 隐藏游戏中左下角的移动按钮。隐藏后点击相应位置不会响应 |
| HideNeteaseStoreGui | 客户端 | 隐藏游戏中的网易商店按钮。隐藏后点击相应位置不会响应 |
| HidePauseGUI | 客户端 | 隐藏暂停按钮原生UI。 |
| HideReportGUI | 客户端 | 隐藏举报按钮原生UI。 |
| HideSlotBarGui | 客户端 | 隐藏游戏中底部中间的物品栏界面 |
| HideSneakGui | 客户端 | 隐藏游戏中左下角方向键的中心处潜行按钮。隐藏后点击相应位置不会响应 |
| HideSwimGui | 客户端 | 隐藏游戏中的浮潜按钮。隐藏后点击相应位置不会响应 |
| HideVoiceGUI | 客户端 | 隐藏语音按钮原生UI。该接口在开启新版聊天时不生效 |
| HideWalkGui | 客户端 | 隐藏游戏中右上角的移动类型按钮。隐藏后点击相应位置不会响应 |
| OpenChatGui | 客户端 | 打开原版聊天栏 |
| OpenEmoteGui | 客户端 | 打开表情界面 |
| OpenFoldGui | 客户端 | 打开原版下拉界面 |
| OpenInventoryGui | 客户端 | 打开原版背包界面，并支持选中某个分页(支持自定义分页名称) |
| OpenNeteaseStoreGui | 客户端 | 打开游戏中的网易商店购买商品界面 |
| OpenPauseGui | 客户端 | 打开原版暂停界面 |
| OpenReportGui | 客户端 | 打开原版举报界面 |
| OpenVoiceGui | 客户端 | 打开原版语音界面 |
| PlayHudHeartBlinkAnim | 客户端 | 播放原版受伤时血量变化的动效 |
| SetCrossHair | 客户端 | 设置是否使用“准星瞄准”，即设置->触摸屏->准星瞄准 |
| SetEmoteSwitch | 客户端 | 设置是否开启表情功能，默认PC端关闭，手机端开启，且该接口只能在手机端使用，在原生UI初始化前调用设置 |
| SetHudChatStackPosition | 客户端 | 设置HUD界面左上小聊天窗口位置 |
| SetHudChatStackVisible | 客户端 | 设置HUD界面左上小聊天窗口可见性 |
| SetResponse | 客户端 | 设置原生UI是否响应 |
| SimulateJump | 客户端 | 模拟跳跃 |
# 通用
| 接口 | 描述 | |
|---|---|---|
| CheckCanBindUI | 客户端 | 检查实体是否可以绑定头顶UI，如何将UI与实体绑定详见CreateUI接口 |
| CreateUI | 客户端 | 创建UI，详见界面创建流程及生命周期 |
| GetCustomUIControlProxyCls | 客户端 | 获得原生界面自定义UI代理基类 |
| GetMiniMapScreenNodeCls | 客户端 | 获取小地图ScreenNode基类 |
| GetNativeScreenManagerCls | 客户端 | 获得NativeScreenManager类 |
| GetScreenNodeCls | 客户端 | 获得ScreenNode类 |
| GetTopScreen | 客户端 | 获取UI堆栈栈顶的UI节点 |
| GetTopUI | 客户端 | 获取UI栈顶的UI名称 |
| GetTopUINode | 客户端 | 获取Push进来的最顶层界面，包括原生界面，详见 界面创建流程及生命周期 |
| GetUI | 客户端 | 获取UI节点，详见界面创建流程及生命周期 |
| GetUIScreenProxyCls | 客户端 | 获得原生界面Screen代理基类 |
| GetViewBinderCls | 客户端 | 获得ViewBinder类 |
| GetViewViewRequestCls | 客户端 | 获得ViewRequest类 |
| PopScreen | 客户端 | 使用堆栈管理的方式关闭UI |
| PopTopUI | 客户端 | 弹出UI栈顶的UI |
| PushScreen | 客户端 | 使用堆栈管理的方式创建UI |
| RegisterUI | 客户端 | 注册UI，创建UI前，需要先注册UI。同一UI只需要注册一次即可。详见界面创建流程及生命周期 |
| RegisterUIAnimations | 客户端 | 注册UI动画 |
| UnregisterUIAnimation | 客户端 | 取消UI动画的注册 |
# 自定义书本
| 接口 | 描述 | |
|---|---|---|
| GetBookManager | 客户端 | 获取书本管理对象 |
# 自定义成就系统
| 接口 | 描述 | |
|---|---|---|
| AddNodeProgress | 服务端 | 增加对应玩家的对应成就节点的成就进度 |
| GetAchievementGatePosition | 客户端 | 获取自定义成就系统的入口按钮位置 |
| GetChildrenNode | 服务端 | 获得该成就节点的下一级所有孩子节点的list |
| GetNodeDetailInfo | 服务端 | 获取对应玩家的对应节点信息 |
| SetAchievementGatePosition | 客户端 | 设置自定义成就系统的入口按钮位置 |
| SetNodeFinish | 服务端 | 设置对应玩家的对应成就节点完成 |
# UI界面
| 接口 | 描述 | |
|---|---|---|
| AddEntityMarker | 客户端 | 增加实体位置标记 |
| AddEntityTextMarker | 客户端 | 在小地图上增加实体文本标记 |
| AddStaticMarker | 客户端 | 增加地图上静态位置的标记 |
| AddStaticTextMarker | 客户端 | 在小地图上增加静态文本的标记 |
| BindVirtualWorldModel | 客户端 | 绑定虚拟世界中的模型 |
| ChangeBindAutoScale | 客户端 | 设置已绑定实体的UI是否根据绑定实体与本地玩家间的距离动态缩放，只对已绑定实体的UI界面生效，如何将UI与实体绑定详见CreateUI接口 |
| ChangeBindEntityId | 客户端 | 修改绑定的实体id，只对已绑定实体的UI界面生效，如何将UI与实体绑定详见CreateUI接口 |
| ChangeBindOffset | 客户端 | 修改与绑定实体之间的偏移量，只对已绑定实体的UI界面生效，如何将UI与实体绑定详见CreateUI接口 |
| Clone | 客户端 | 克隆一个已有的控件，修改它的名称，并将它挂接到指定的父节点上，目前文本、图片、按钮控件的克隆控件表现正常，其他复杂控件的克隆控件可能存在运行问题，建议在json编写的过程中，手动复制一份对应控件使用。 |
| Create | 客户端 | UI生命周期函数，当UI创建成功时调用。 |
| CreateChildControl | 客户端 | 在当前画布中创建子控件，如果该子控件已经存在则返回已存在的子控件 |
| Destroy | 客户端 | UI生命周期函数，当UI销毁时调用。 |
| GetAllChildrenPath | 客户端 | 获取所有子节点的路径list |
| GetBaseUIControl | 客户端 | 根据路径获取BaseUIControl实例 |
| GetBindAutoScale | 客户端 | 获取该绑定实体的UI是否动态缩放，未绑定的UI将传回默认值1 |
| GetBindEntityId | 客户端 | 获取该UI绑定的实体id，未绑定的UI将传回默认值None |
| GetBindOffset | 客户端 | 获取该UI绑定实体的偏移量，未绑定的UI将传回默认值(0, 0, 0) |
| GetBindWorldPosition | 客户端 | 获取该UI绑定的worldPosition，未绑定返回默认值None |
| GetChildrenName | 客户端 | 获取子节点的名称list |
| GetIsHud | 客户端 | 获得本界面的输入模式 |
| GetRichTextItem | 客户端 | 返回一个富文本控件实例 |
| GetScreenName | 客户端 | 获得本界面的名称 |
| GetSelf | 客户端 | 获取零件界面自身 |
| OnActive | 客户端 | UI生命周期函数，当UI重新回到栈顶时调用。 |
| OnDeactive | 客户端 | UI生命周期函数，当栈顶UI有其他UI入栈时调用。 |
| RemoveChildControl | 客户端 | 移除当前画布中的子控件 |
| RemoveComponent | 客户端 | 动态删除某一控件 |
| RemoveEntityMarker | 客户端 | 删除实体位置标记 |
| RemoveEntityTextMarker | 客户端 | 在小地图上删除实体文本标记 |
| RemoveStaticMarker | 客户端 | 删除静态位置标记 |
| RemoveStaticTextMarker | 客户端 | 在小地图上删除静态文本标记 |
| SetBindWorldPosition | 客户端 | 设置UI绑定的worldPosition |
| SetHighestY | 客户端 | 设置绘制地图的最大高度 |
| SetIsHud | 客户端 | 设置本界面的输入模式 |
| SetRemove | 客户端 | 删除本界面节点 |
| SetScreenVisible | 客户端 | 设置是否显示本界面 |
| SetSelectControl | 客户端 | 设置当前焦点所在的控件,当设置控件为文本输入框时会弹出系统小键盘 |
| SetStackGridCount | 客户端 | 设置StackGrid控件的大小 |
| SetUiEntity | 客户端 | 设置PaperDoll控件需要显示的生物模型,PaperDoll控件的配置方式详见控件介绍PaperDoll |
| SetUiModel | 客户端 | 设置PaperDoll控件需要显示的模型,PaperDoll控件的配置方式详见控件介绍PaperDoll |
| SetUiModelScale | 客户端 | 设置PaperDoll控件模型的缩放比例 |
| Update | 客户端 | 客户端每帧调用，1秒有30帧 |
| UpdateScreen | 客户端 | 刷新界面，重新计算各个控件的相关数据 |
| ZoomIn | 客户端 | 放大地图 |
| ZoomOut | 客户端 | 缩小地图 |
| ZoomReset | 客户端 | 恢复地图放缩大小为默认值 |
# UI控件
| 接口 | 描述 | |
|---|---|---|
| AddHoverEventParams | 客户端 | 开启按钮的悬浮回调功能，不调用该函数则按钮无悬浮回调 |
| AddOption | 客户端 | 添加下拉框项，若添加成功则返回True，否则返回False |
| AddTouchEventParams | 客户端 | 开启按钮回调功能，不调用该函数则按钮无回调 |
| ClearOptions | 客户端 | 清空下拉框 |
| ClearSelection | 客户端 | 清除当前选中，使下拉框恢复未选中内容状态 |
| DisableTextShadow | 客户端 | 关闭文本控件显示阴影 |
| EnableTextShadow | 客户端 | 使文本控件显示阴影 |
| GetAnchorFrom | 客户端 | 判断控件相对于父节点的哪个锚点来计算位置与大小 |
| GetAnchorTo | 客户端 | 获取控件自身锚点位置信息 |
| GetChildByName | 客户端 | 根据子控件的名称获取BaseUIControl实例 |
| GetChildByPath | 客户端 | 根据相对路径获取BaseUIControl实例 |
| GetClipDirection | 客户端 | 获取图片控件的裁剪方向 |
| GetClipOffset | 客户端 | 获取控件的裁剪偏移信息 |
| GetClipsChildren | 客户端 | 根据控件路径返回某控件是否开启裁剪内容 |
| GetCurrentSliceIndex | 客户端 | 获取轮盘当前选择的切片的index，一般是在SetHoverCallback和SetTouchUpCallback中使用，表示当前鼠标悬浮或者点击的轮盘切片index |
| GetEditText | 客户端 | 获取edit_box输入框的文本信息，获取失败会返回None |
| GetFullPosition | 客户端 | 获取控件的锚点坐标，支持比例值以及绝对值 |
| GetFullSize | 客户端 | 获取控件的大小，支持百分比以及绝对值 |
| GetGlobalPosition | 客户端 | 获取控件全局坐标 |
| GetGlobalRotateAngle | 客户端 | 获取图片通过RotateAround函数设置进去的角度值 |
| GetGlobalRotatePoint | 客户端 | 获取图片通过RotateAround函数设置进去的point值 |
| GetGridItem | 客户端 | 根据网格位置获取元素控件 |
| GetIsModal | 客户端 | 判断当前面板是否为模态框 |
| GetIsSwallow | 客户端 | 判断当前面板输入是否会吞噬事件，isSwallow为Ture时，点击时，点击事件不会穿透到世界。如破坏方块、镜头转向不会被响应 |
| GetMaxSize | 客户端 | 获取控件所允许的最大的大小值 |
| GetMinSize | 客户端 | 获取控件所允许的最小的大小值 |
| GetModelId | 客户端 | 获取渲染的骨骼模型Id |
| GetOffsetDelta | 客户端 | 获得点击面板的拖拽偏移量 |
| GetOptionCount | 客户端 | 获得选项数量 |
| GetOptionIndexByShowName | 客户端 | 根据展示文本查找对应下拉框项的索引位置，若找不到返回-1 |
| GetOptionShowNameByIndex | 客户端 | 根据索引位置查找当前栈式文本，若找不到返回None |
| GetOrientation | 客户端 | 获取stackPanel的排列方向 |
| GetPath | 客户端 | 返回当前控件的相对路径，路径从画布节点开始算起 |
| GetPosition | 客户端 | 获取控件相对父节点的坐标 |
| GetRotateAngle | 客户端 | 获取图片相对自身的旋转锚点旋转的角度 |
| GetRotatePivot | 客户端 | 获取图片相对自身的旋转锚点 |
| GetRotateRect | 客户端 | 获取图片当前的四个边角点 |
| GetScrollViewContentControl | 客户端 | 返回该scroll_view内容的BaseUIControl实例 |
| GetScrollViewContentPath | 客户端 | 返回该scroll_view内容的路径 |
| GetScrollViewPercentValue | 客户端 | 获取当前scroll_view内容的百分比位置 |
| GetScrollViewPos | 客户端 | 获得当前scroll_view最上方内容的位置 |
| GetSelectOptionIndex | 客户端 | 获得当前选中项的索引，所无选中项则返回-1 |
| GetSelectOptionShowName | 客户端 | 获得当前选中项的展示文本，所无选中项则返回None |
| GetSize | 客户端 | 获取控件的大小 |
| GetSliceCount | 客户端 | 获取轮盘可以选择的总切片数量 |
| GetSliderValue | 客户端 | 获取滑动条的值，失败返回0 |
| GetText | 客户端 | 获取Label的文本信息，获取失败会返回None |
| GetTextAlignment | 客户端 | 获取文本控件的文本对齐方式 |
| GetTextColor | 客户端 | 获取Label文本颜色 |
| GetTextLinePadding | 客户端 | 获取文本控件的行间距 |
| GetToggleState | 客户端 | 获取Toggle开关控件的状态 |
| GetUiItem | 客户端 | 获取ItemRenderer控件显示的物品，ItemRenderer控件的配置方式详见控件介绍ItemRenderer |
| GetVisible | 客户端 | 根据控件路径返回某控件是否已显示 |
| IsAnimEndCallbackRegistered | 客户端 | 控件是否对名称为animName的动画进行了注册回调 |
| IsTextShadowEnabled | 客户端 | 判断文本控件是否显示阴影 |
| PauseAnimation | 客户端 | 暂停动画，暂停后的动画会停在当前的状态 |
| PlayAnimation | 客户端 | 继续播放动画，从动画当前状态开始播放 |
| RegisterCloseComboBoxCallback | 客户端 | 注册关闭下拉框事件回调 |
| RegisterOpenComboBoxCallback | 客户端 | 注册展开下拉框事件回调 |
| RegisterSelectItemCallback | 客户端 | 注册选中下拉框内容事件回调 |
| RemoveAnimEndCallback | 客户端 | 移除动画播放结束后的回调 |
| RemoveAnimation | 客户端 | 删除单一属性的动画，删除后的值与当前状态有关，建议删除后重新设置该属性值 |
| RemoveOptionByIndex | 客户端 | 根据提供的索引移除对应下拉框项，移除成功则返回True，否则返回False |
| RemoveOptionByShowName | 客户端 | 根据提供的展示文本移除对应下拉框项，移除成功则返回True，否则返回False |
| RenderBlockGeometryModel | 客户端 | 渲染网格体模型 |
| RenderEntity | 客户端 | 渲染实体 |
| RenderSkeletonModel | 客户端 | 渲染骨骼模型（不依赖实体） |
| Rotate | 客户端 | 图片相对自身的旋转锚点进行旋转 |
| RotateAround | 客户端 | 图片相对全局坐标系中某个固定的点进行旋转 |
| SetAlpha | 客户端 | 设置节点的透明度，仅对image和label控件生效 |
| SetAnchorFrom | 客户端 | 设置控件相对于父节点的锚点 |
| SetAnchorTo | 客户端 | 设置控件自身锚点位置 |
| SetAnimEndCallback | 客户端 | 设置动画播放结束后的回调，每次设置都会覆盖上一次的设置 |
| SetAnimation | 客户端 | 给单一属性设置动画，已有重复的会设置失败，需要先remove |
| SetButtonHoverInCallback | 客户端 | 设置鼠标进入按钮时触发的悬浮回调函数 |
| SetButtonHoverOutCallback | 客户端 | 设置鼠标退出按钮时触发的悬浮回调函数 |
| SetButtonScreenExitCallback | 客户端 | 设置按钮所在画布退出时若鼠标仍未抬起时触发回调函数 |
| SetButtonTouchCancelCallback | 客户端 | 设置触控在按钮范围外弹起时触发的回调函数 |
| SetButtonTouchDownCallback | 客户端 | 设置按钮按下时触发的回调函数 |
| SetButtonTouchMoveCallback | 客户端 | 设置按下后触控移动时触发的回调函数 |
| SetButtonTouchMoveInCallback | 客户端 | 设置按下按钮后进入控件时触发的回调函数 |
| SetButtonTouchMoveOutCallback | 客户端 | 设置按下按钮后退出控件时触发的回调函数 |
| SetButtonTouchUpCallback | 客户端 | 设置触控在按钮范围内弹起时的回调函数 |
| SetClipDirection | 客户端 | 设置图片控件的裁剪方向 |
| SetClipOffset | 客户端 | 设置控件的裁剪偏移信息 |
| SetClipsChildren | 客户端 | 设置控件是否开启裁剪内容 |
| SetCurrentSliceIndex | 客户端 | 设置轮盘选择的切片 |
| SetEditText | 客户端 | 设置edit_box输入框的文本信息 |
| SetEditTextMaxLength | 客户端 | 设置输入框的最大输入长度 |
| SetFullPosition | 客户端 | 设置控件的锚点坐标（全局坐标），支持比例值以及绝对值 |
| SetFullSize | 客户端 | 设置控件的大小，支持比例形式以及绝对值 |
| SetGridDimension | 客户端 | 设置Grid控件的大小 |
| SetHighestY | 客户端 | 设置绘制地图的最大高度 |
| SetHoverCallback | 客户端 | 设置轮盘选择切片触发回调函数 |
| SetImageAdaptionType | 客户端 | 设置图片控件的图片适配方式以及信息 |
| SetIsModal | 客户端 | 设置当前面板是否为模态框 |
| SetIsSwallow | 客户端 | 设置当前面板输入是否会吞噬事件，isSwallow为Ture时，点击时，点击事件不会穿透到世界。如破坏方块、镜头转向不会被响应 |
| SetLayer | 客户端 | 设置控件节点的层级，可以通过传入空字符串（""）的方式来调整整个JSON的基础层级 |
| SetMaxSize | 客户端 | 设置控件所允许的最大的大小值 |
| SetMinSize | 客户端 | 设置控件所允许的最小的大小值 |
| SetOffsetDelta | 客户端 | 设置点击面板的拖拽偏移量 |
| SetOrientation | 客户端 | 设置stackPanel的排列方向 |
| SetPosition | 客户端 | 设置控件相对父节点的坐标 |
| SetRotatePivot | 客户端 | 设置图片自身旋转锚点，该点并不是固定的点，而是相对于自身位置的点 |
| SetScrollViewPercentValue | 客户端 | 设置当前scroll_view内容的百分比位置 |
| SetScrollViewPos | 客户端 | 设置当前scroll_view内容的位置 |
| SetSelectOptionByIndex | 客户端 | 根据提供的索引选中对应下拉框项 |
| SetSelectOptionByShowName | 客户端 | 根据提供的展示文本选中对应下拉框项 |
| SetSize | 客户端 | 设置控件的大小 |
| SetSliderValue | 客户端 | 设置滑动条的值 |
| SetSprite | 客户端 | 给图片控件换指定贴图 |
| SetSpriteClipRatio | 客户端 | 设置图片的裁剪区域比例（不改变控件尺寸）。可以配合image控件的clip_ratio属性控制方向。 |
| SetSpriteColor | 客户端 | 设置图片颜色 |
| SetSpriteGray | 客户端 | 给图片控件置灰，比直接SetSprite一张灰图片效率要高 |
| SetSpritePlatformFrame | 客户端 | 设置图片为我的世界移动端启动器当前帐号的头像框 |
| SetSpritePlatformHead | 客户端 | 设置图片为我的世界移动端启动器当前帐号的头像 |
| SetSpriteUV | 客户端 | 设置图片的起始uv，与json中的"uv"属性作用一致 |
| SetSpriteUVSize | 客户端 | 设置图片的uv大小，与json中的"uv_size"属性作用一致 |
| SetText | 客户端 | 设置Label的文本信息 |
| SetTextAlignment | 客户端 | 设置文本控件的文本对齐方式 |
| SetTextColor | 客户端 | 设置Label文本的颜色 |
| SetTextFontSize | 客户端 | 设置Label中文本字体的大小 |
| SetTextLinePadding | 客户端 | 设置文本控件的行间距 |
| SetToggleState | 客户端 | 设置Toggle开关控件的值 |
| SetTouchEnable | 客户端 | 设置控件是否可点击交互 |
| SetTouchUpCallback | 客户端 | 设置轮盘选择切片并且鼠标按下抬起后触发回调函数 |
| SetUiItem | 客户端 | 设置ItemRenderer控件显示的物品，ItemRenderer控件的配置方式详见控件介绍ItemRenderer |
| SetValue | 客户端 | 设置进度条的进度 |
| SetVisible | 客户端 | 根据控件路径选择是否显示某控件，可以通过传入空字符串（""）的方式来调整整个JSON的显示/隐藏 |
| StopAnimation | 客户端 | 停止动画，动画将恢复到第一段动画片段的from状态 |
| ZoomIn | 客户端 | 放大地图 |
| ZoomOut | 客户端 | 缩小地图 |
| ZoomReset | 客户端 | 恢复地图放缩大小为默认值 |
| asButton | 客户端 | 将当前BaseUIControl转换为ButtonUIControl实例，如当前控件非button类型则返回None |
| asGrid | 客户端 | 将当前BaseUIControl转换为GridUIControl实例，如当前控件非grid类型则返回None |
| asImage | 客户端 | 将当前BaseUIControl转换为ImageUIControl实例，如当前控件非image类型则返回None |
| asInputPanel | 客户端 | 将当前BaseUIControl转换为InputPanelUIControl实例，如当前控件非inputPanel类型则返回None |
| asItemRenderer | 客户端 | 将当前BaseUIControl转换为ItemRenderer实例，如当前控件非custom类型则返回None |
| asLabel | 客户端 | 将当前BaseUIControl转换为LabelUIControl实例，如当前控件非Label类型则返回None |
| asMiniMap | 客户端 | 将当前BaseUIControl转换为MiniMapUIControl实例，如当前控件非小地图类型则返回None |
| asNeteaseComboBox | 客户端 | 将当前BaseUIControl转换为NeteaseComboBoxUIControl实例，如当前控件非panel类型则返回None |
| asNeteasePaperDoll | 客户端 | 将当前BaseUIControl转换为NeteasePaperDollUIControl实例，如当前控件非custom类型则返回None |
| asProgressBar | 客户端 | 将当前BaseUIControl转换为ProgressBarUIControl实例，如当前控件非panel类型则返回None |
| asScrollView | 客户端 | 将当前BaseUIControl转换为ScrollViewUIControl实例，如当前控件非scrollview类型则返回None |
| asSelectionWheel | 客户端 | 将当前BaseUIControl转换为SelectionWheelUIControl实例，如当前控件非selectionWheel类型则返回None |
| asSlider | 客户端 | 将当前BaseUIControl转换为SliderUIControl实例，如当前控件非滑动条类型则返回None |
| asStackPanel | 客户端 | 将当前BaseUIControl转换为StackPanelUIControl实例，如当前控件非stackPanel类型则返回None |
| asSwitchToggle | 客户端 | 将当前BaseUIControl转换为SwitchToggleUIControl实例，如当前控件非panel类型或非toggle则返回None |
| asTextEditBox | 客户端 | 将当前BaseUIControl转换为TextEditBoxUIControl实例，如当前控件非editbox类型则返回None |
| resetAnimation | 客户端 | 重置该控件的动画 |
# 音效
| 接口 | 描述 | |
|---|---|---|
| DisableOriginMusic | 客户端 | 停止原生背景音乐 |
| PlayCustomMusic | 客户端 | 播放场景音效，包括原版音效及自定义音效 |
| PlayCustomUIMusic | 客户端 | 播放UI音效，包括原版音效及自定义音效 |
| PlayGlobalCustomMusic | 客户端 | 播放背景音乐 |
| SetCustomMusicLoop | 客户端 | 设定指定音乐是否循环播放，包括场景音效与背景音乐 |
| SetCustomMusicLoopById | 客户端 | 设定指定音乐是否循环播放 |
| StopCustomMusic | 客户端 | 停止音效，包括场景音效与背景音乐，将依据fadeOutTime触发OnMusicStopClientEvent事件 |
| StopCustomMusicById | 客户端 | 停止场景音效 |
# 控制
| 接口 | 描述 | |
|---|---|---|
| AddPickBlacklist | 客户端 | 添加使用camera组件（例如GetChosen接口、PickFacing接口）选取实体时的黑名单，即该实体不会被选取到 |
| ClearPickBlacklist | 客户端 | 清除使用camera组件（例如GetChosen接口、PickFacing接口）选取实体的黑名单 |
| GetChosen | 客户端 | 获取屏幕点击位置的实体或方块信息，通常与GetEntityByCoordEvent配合使用 |
| GetChosenEntity | 客户端 | 获取屏幕点击位置的实体id，通常与GetEntityByCoordEvent配合使用 |
| GetHoldTimeThresholdInMs | 客户端 | 获取长按判定时间，即按着屏幕多长时间会触发长按操作 |
| GetInputVector | 客户端 | 获取方向键（移动轮盘）的输入 |
| GetMousePosition | 客户端 | 获取鼠标位置 |
| GetTouchPos | 客户端 | 获取点击的屏幕坐标。可以监听TapBeforeClientEvent或TapOrHoldReleaseClientEvent事件，调用本API获取点击坐标。 |
| IsCanAttack | 客户端 | 获取玩家是否响应攻击 |
| IsCanChat | 客户端 | 获取玩家是否响应聊天按钮 |
| IsCanDrag | 客户端 | 获取玩家是否响应屏幕拖动 |
| IsCanInair | 客户端 | 获取玩家是否响应打上升下降按钮 |
| IsCanJump | 客户端 | 获取玩家是否响应跳跃（以及在水中浮起） |
| IsCanMove | 客户端 | 获取玩家是否响应移动 |
| IsCanOpenInv | 客户端 | 获取玩家是否响应打开背包按钮 |
| IsCanPause | 客户端 | 获取玩家是否响应暂停按钮 |
| IsCanPauseScreen | 客户端 | 获取玩家是否可以打开暂停界面 |
| IsCanPerspective | 客户端 | 获取玩家是否响应切换视角 |
| IsCanScreenShot | 客户端 | 获取玩家是否响应截图按钮 |
| IsCanWalkMode | 客户端 | 获取玩家是否响应切换行走模式 |
| IsTouchWithMouse | 客户端 | 获取是否正在使用鼠标点击模拟触屏 |
| LockInputVector | 客户端 | 锁定本地玩家方向键（移动轮盘）的输入，可使本地玩家持续向指定方向前行，且不会再受玩家输入影响 |
| LockVerticalMove | 客户端 | 模拟上升或下降，调用后一直上升或下降 |
| PickFacing | 客户端 | 获取准星选中的实体或者方块 |
| SetCanAll | 客户端 | 同时设置SetCanMove，SetCanJump，SetCanAttack，SetCanWalkMode，SetCanPerspective，SetCanPause，SetCanChat，SetCanScreenShot，SetCanOpenInv，SetCanDrag，SetCanInair |
| SetCanAttack | 客户端 | 设置是否响应攻击 |
| SetCanChat | 客户端 | 设置是否响应聊天按钮 |
| SetCanDrag | 客户端 | 设置是否响应屏幕拖动 |
| SetCanInair | 客户端 | 设置是否响应上升下降按钮（飞在空中时右下角的三个按钮） |
| SetCanJump | 客户端 | 设置是否响应跳跃（以及在水中浮起） |
| SetCanMove | 客户端 | 设置是否响应移动 |
| SetCanOpenInv | 客户端 | 设置是否响应打开背包按钮 |
| SetCanPause | 客户端 | 设置是否响应暂停按钮 |
| SetCanPauseScreen | 客户端 | 设置是否可以打开暂停界面 |
| SetCanPerspective | 客户端 | 设置是否响应切换视角 |
| SetCanScreenShot | 客户端 | 设置是否响应截图按钮 |
| SetCanWalkMode | 客户端 | 设置是否响应切换行走模式 |
| SetDeviceVibrate | 客户端 | 设置设备震动 |
| SetHoldTimeThreshold | 客户端 | 设置长按判定时间，即按着屏幕多长时间会触发长按操作 |
| SetMoveLock | 客户端 | 设置是否锁住移动。实际上为是否响应十字键与遥感的操作。 |
| SetShowRideUI | 服务端 | 设置是否显示马匹的UI界面 |
| SimulateTouchWithMouse | 客户端 | 模拟使用鼠标控制UI（PC F11快捷键） |
| UnLockVerticalMove | 客户端 | 解除上升或下降状态 |
| UnlockInputVector | 客户端 | 解锁本地玩家方向键（移动轮盘）的输入 |
# 游戏设置
| 接口 | 描述 | |
|---|---|---|
| GetControllerLayout | 客户端 | 获取玩家控制器绑定映射 |
| GetSliderOption | 客户端 | 获得某个滑动条设置选项的值 |
| GetToggleOption | 客户端 | 获得某个开关设置值的接口 |
| GetUIProfile | 客户端 | 获取"UI 档案"模式 |
| HighlightBoxSelection | 客户端 | 镜头移动时高亮当前视角中心所指的方块 |
| SetSliderOption | 客户端 | 设置某个滑动条设置选项的值 |
| SetSplitControlCanChange | 客户端 | 设置是否允许使用准星瞄准按钮 |
| SetToggleOption | 客户端 | 修改开关型设置的接口 |
| SetUIProfile | 客户端 | 设置"UI 档案"模式 |
# 世界
| 接口 | 描述 | |
|---|---|---|
| VirtualWorldCreate | 客户端 | 创建虚拟世界，虚拟世界只允许存在一个，已经存在虚拟世界的情况下再调用此方法则无效 |
| VirtualWorldDestroy | 客户端 | 销毁虚拟世界 |
| VirtualWorldSetCollidersVisible | 客户端 | 设置虚拟世界中模型的包围盒是否显示,主要用于调试,默认为不显示 |
| VirtualWorldSetSkyBgColor | 客户端 | 设置虚拟世界中天空背景的颜色 |
| VirtualWorldSetSkyTexture | 客户端 | 设置虚拟世界中天空的贴图 |
| VirtualWorldToggleVisibility | 客户端 | 设置虚拟世界是否显示 |
# 相机
| 接口 | 描述 | |
|---|---|---|
| CameraGetClickModel | 客户端 | 获取相机当前指向的模型的id，会返回离相机最近的，通常与GetEntityByCoordEvent配合使用 |
| CameraGetFov | 客户端 | 获取相机视野大小 |
| CameraGetPos | 客户端 | 返回相机位置 |
| CameraGetZoom | 客户端 | 获取相机的缩放值 |
| CameraLookAt | 客户端 | 修改相机朝向 |
| CameraMoveTo | 客户端 | 设置相机移动动画, 会根据当前相机状态与传入参数按时间进行插值显示 |
| CameraSetFov | 客户端 | 设置相机视野大小 |
| CameraSetPos | 客户端 | 设置相机位置 |
| CameraSetZoom | 客户端 | 设置相机缩放 |
| CameraStopActions | 客户端 | 停止相机移动动画 |
# 模型
| 接口 | 描述 | |
|---|---|---|
| ModelCancelAllBoneMask | 客户端 | 取消动画中的所有骨骼屏蔽。 |
| ModelCreateMinecraftObject | 客户端 | 在虚拟世界中创建微软原版模型 |
| ModelCreateObject | 客户端 | 在虚拟世界中创建网易骨骼模型 |
| ModelGetPos | 客户端 | 获取模型的坐标 |
| ModelGetRot | 客户端 | 返回模型的旋转角度 |
| ModelIsVisible | 客户端 | 返回模型可见性 |
| ModelMoveTo | 客户端 | 设置模型平移运动 |
| ModelPlayAnimation | 客户端 | 模型播放动画，支持动作融合，其功能与模型接口ModelPlayAni相同。 |
| ModelRegisterAnim1DControlParam | 客户端 | 当同时播放多个骨骼动画时，新建用于控制动画进行1D线性混合的参数。目前线性混合仅支持对两个动画进行混合。新建的参数值范围为[0,1]。指定的骨骼将会按照这个参数的值对两个动画进行线性混合。 |
| ModelRemove | 客户端 | 销毁虚拟世界中的模型 |
| ModelRotate | 客户端 | 模型绕某个轴旋转多少度 |
| ModelRotateTo | 客户端 | 设置模型旋转运动 |
| ModelSetAnim1DControlParam | 客户端 | 新建动画的1D控制参数后，使用该接口对相应的参数进行控制。 |
| ModelSetAnimAllBoneMask | 客户端 | 设置是否屏蔽动画中所有骨骼的动画，若开启骨骼屏蔽后，该骨骼将不再播放该动画中的动作。该接口会对该动画中所有骨骼生效，可通过参数ignoreBoneList来指定不受影响的骨骼名称。通过屏蔽指定骨骼的动画可实现同一个骨骼模型同时在不同骨骼上播放不同的动作动画，从而实现快捷的动作融合。 |
| ModelSetAnimBoneMask | 客户端 | 设置是否屏蔽动画中指定的骨骼的动画，若开启骨骼屏蔽后，该骨骼将不再播放该动画中的动作。通过屏蔽指定骨骼的动画可实现同一个骨骼模型同时在不同骨骼上播放不同的动作动画，从而实现快捷的动作融合。 |
| ModelSetAnimLayer | 客户端 | 设置骨骼动画的层级，动画层级越大，则优先度越高，骨骼模型的骨骼优先播放优先度最高的动画，相同层级的动画则优先播放率先播放的动画。 |
| ModelSetBoxCollider | 客户端 | 设置模型的包围盒 |
| ModelSetPos | 客户端 | 设置模型坐标 |
| ModelSetRot | 客户端 | 设置模型的旋转角度 |
| ModelSetScale | 客户端 | 设置模型的缩放值 |
| ModelSetVisible | 客户端 | 设置模型可见性 |
| ModelStopActions | 客户端 | 停止模型的移动和旋转运动 |
| ModelStopAnimation | 客户端 | 停止播放指定的模型动画。 |
| ModelUpdateAnimationMolangVariable | 客户端 | 更新微软原版模型表达式变量，可控制动作的改变 |
# 其它对象
| 接口 | 描述 | |
|---|---|---|
| BindModel | 客户端 | 把对象绑定到模型上, 支持绑定序列帧，粒子，文本和其它模型 |
| MoveToVirtualWorld | 客户端 | 把对象从主世界移到虚拟世界, 非绑定的序列帧，文本，粒子需要调用该方法后才会出现在虚拟世界中，绑定的可以省略调用该方法。 |
# 渐晕
| 接口 | 描述 | |
|---|---|---|
| CheckVignetteEnabled | 客户端 | 检测是否开启了屏幕渐晕（Vignette）效果。 |
| SetEnableVignette | 客户端 | 设置是否开启屏幕渐晕（Vignette）效果，开启后玩家屏幕周围将出现渐晕，可通过Vignette其他接口设置效果参数。 |
| SetVignetteCenter | 客户端 | 设置渐晕（Vignette）的渐晕中心位置，可改变屏幕渐晕的位置。 |
| SetVignetteRGB | 客户端 | 设置渐晕（Vignette）的渐晕颜色，可改变屏幕渐晕的颜色。 |
| SetVignetteRadius | 客户端 | 设置渐晕（Vignette）的渐晕半径，半径越大，渐晕越小，玩家的视野范围越大。 |
| SetVignetteSmoothness | 客户端 | 设置渐晕（Vignette）的渐晕模糊系数，模糊系数越大，则渐晕边缘越模糊，模糊的范围也越大 |
# 模糊
| 接口 | 描述 | |
|---|---|---|
| CheckGaussianBlurEnabled | 客户端 | 检测是否开启了高斯模糊效果。 |
| SetEnableGaussianBlur | 客户端 | 设置是否开启高斯模糊效果，开启后玩家屏幕周围被模糊，可通过高斯模糊其他接口设置效果参数。 |
| SetGaussianBlurRadius | 客户端 | 设置高斯模糊效果的模糊半径，半径越大，模糊程度越大，反之则模糊程度越小。 |
# 色彩
| 接口 | 描述 | |
|---|---|---|
| CheckColorAdjustmentEnabled | 客户端 | 检测是否开启了色彩校正效果。 |
| SetColorAdjustmentBrightness | 客户端 | 调整屏幕色彩亮度，亮度值越大，屏幕越亮，反之则越暗。 |
| SetColorAdjustmentContrast | 客户端 | 调整屏幕色彩对比度，屏幕对比度值越大，色彩差异则越明显，反之则色彩差异越小。 |
| SetColorAdjustmentSaturation | 客户端 | 调整屏幕色彩饱和度，屏幕饱和度值越大，色彩则越明显，反之则越灰暗。 |
| SetColorAdjustmentTint | 客户端 | 调整屏幕色彩的色调，根据输入的色调和强度来调整屏幕色彩，当强度越大时，屏幕整体颜色越偏向输入的色调。 |
| SetEnableColorAdjustment | 客户端 | 设置是否开启色彩校正效果，开启后可进行屏幕色彩调整，可通过色彩校正效果其他接口设置效果参数。 |
# 镜头效果
| 接口 | 描述 | |
|---|---|---|
| CheckDepthOfFieldEnabled | 客户端 | 检测是否开启了景深效果。 |
| CheckLensStainEnabled | 客户端 | 检测是否开启了镜头污迹效果。 |
| ResetLensStainTexture | 客户端 | 重置污迹效果使用的贴图为系统默认贴图。 |
| SetDepthOfFieldBlurRadius | 客户端 | 调整景深效果模糊半径，模糊半径越大，模糊程度越大，反之则越小。 |
| SetDepthOfFieldFarBlurScale | 客户端 | 调整景深效果远景模糊大小，远景模糊大小越大，远景的模糊程度越大，反之则越小。注意，远景模糊程度的调节依赖于焦点距离，如果焦点处于较近的距离，那么此时远景处于较清晰的状态，模糊程度大小调节不会很明显。 |
| SetDepthOfFieldFocusDistance | 客户端 | 调整景深效果焦点距离，距离越小，则远处模糊，近处清晰；距离越大，则远处清晰，近处模糊。该距离为实际距离，即以玩家相机为起点的世界坐标距离。 |
| SetDepthOfFieldNearBlurScale | 客户端 | 调整景深效果近景模糊大小，近景模糊大小越大，近景的模糊程度越大，反之则越小。注意，近景模糊程度的调节依赖于焦点距离，如果焦点处于较近的距离，那么此时近景处于较清晰的状态，模糊程度大小调节不会很明显。 |
| SetDepthOfFieldUseCenterFocus | 客户端 | 设置景深效果是否开启屏幕中心聚焦模式，开启后聚焦距离将被自动设置为屏幕中心所对应的物体所在的距离。在第一人称视角下，聚焦距离将被自动设置为屏幕准心所对应的物体与相机的距离，即自动聚焦准心所对应的物体。在第三人称视角下，由于屏幕中心总是对应着玩家，因此聚焦距离将被自动设置为玩家与相机的距离，即自动聚焦在玩家自己。 |
| SetEnableDepthOfField | 客户端 | 设置是否开启景深效果，开启后屏幕出现景深效果，根据焦点距离呈现远处模糊近处清晰或者近处模糊远处清晰的效果。 |
| SetEnableLensStain | 客户端 | 设置是否开启镜头污迹效果，开启后镜头出现污迹效果，可改变使用的污迹贴图及污迹颜色。 |
| SetLensStainColor | 客户端 | 调整镜头污迹颜色，根据输入的颜色和强度来调整污迹色彩，当强度越大时，污迹颜色越偏向输入的颜色。 |
| SetLensStainIntensity | 客户端 | 调整镜头污迹强度，强度越大，污迹越明显，反之则越透明。 |
| SetLensStainTexture | 客户端 | 开启镜头污迹效果后，污迹效果使用的为系统默认贴图。该接口可改变镜头污迹所使用的贴图。注意贴图最好使用透明背景，否则屏幕将被贴图覆盖。 |
# 自定义
| 接口 | 描述 | |
|---|---|---|
| AddPostProcess | 客户端 | 添加后处理效果，与graphics_settings/post_process.json定义的process等效 |
| CheckEnabledByName | 客户端 | 查询是否开启了自定义后处理效果 |
| GetParameter | 客户端 | 获取指定自定义后处理参数的值 |
| GetPostProcessOrder | 客户端 | 获取后处理效果的渲染顺序 |
| InsertPassToPostprocess | 客户端 | 往自定义后处理的多pass中的指定位置插入自定义pass。多pass指定的是graphics_settings/post_process.json中的"pass_array"渲染pass数组。这个后处理会按照这个数组所定义的pass来逐个渲染，每个pass之间的像素输入输出相互连接，即pass数组中第一个pass所使用的fragment shader中的TEXTURE_0为游戏原始输出到屏幕的像素信息。下一个pass所使用的fragment shader中的TEXTURE_0为上一个Pass的fragment shader的输出。最后一个pass的fragment shader的输出即为输出到游戏屏幕的像素信息。 |
| PopBackPassInPostprocess | 客户端 | 删除自定义后处理的多pass的最末尾的pass。多pass指定的是graphics_settings/post_process.json中的"pass_array"渲染pass数组。这个后处理会按照这个数组所定义的pass来逐个渲染，每个pass之间的像素输入输出相互连接，即pass数组中第一个pass所使用的fragment shader中的TEXTURE_0为游戏原始输出到屏幕的像素信息。下一个pass所使用的fragment shader中的TEXTURE_0为上一个Pass的fragment shader的输出。最后一个pass的fragment shader的输出即为输出到游戏屏幕的像素信息。 |
| PostPassResultToOtherPass | 客户端 | 将自定义pass的纹理结果传递到其他自定义pass的fragmentShader指定纹理单元槽位 |
| PushBackPassToPostprocess | 客户端 | 往自定义后处理的多pass最末尾插入自定义pass。多pass指定的是graphics_settings/post_process.json中的"pass_array"渲染pass数组。这个后处理会按照这个数组所定义的pass来逐个渲染，每个pass之间的像素输入输出相互连接，即pass数组中第一个pass所使用的fragment shader中的TEXTURE_0为游戏原始输出到屏幕的像素信息。下一个pass所使用的fragment shader中的TEXTURE_0为上一个Pass的fragment shader的输出。最后一个pass的fragment shader的输出即为输出到游戏屏幕的像素信息。 |
| RemovePassInPostprocess | 客户端 | 删除自定义后处理的多pass中指定位置的pass。多pass指定的是graphics_settings/post_process.json中的"pass_array"渲染pass数组。这个后处理会按照这个数组所定义的pass来逐个渲染，每个pass之间的像素输入输出相互连接，即pass数组中第一个pass所使用的fragment shader中的TEXTURE_0为游戏原始输出到屏幕的像素信息。下一个pass所使用的fragment shader中的TEXTURE_0为上一个Pass的fragment shader的输出。最后一个pass的fragment shader的输出即为输出到游戏屏幕的像素信息。 |
| SetEnableByName | 客户端 | 设置是否开启自定义后处理效果 |
| SetParameter | 客户端 | 设置自定义后处理shader的自定义参数值 |
# 联机大厅
| 接口 | 描述 | |
|---|---|---|
| GetPlayerUid | 服务端 | 获取玩家的uid。只有在线玩家才可获取 |
| LobbyGetStorage | 服务端 | 获取存储的数据。仅联机大厅可用 |
| LobbyGetStorageBySort | 服务端 | 排序获取存储的数据。仅联机大厅可用 |
| LobbySetStorageAndUserItem | 服务端 | 设置订单已发货或者存数据。仅联机大厅可用 |
| QueryLobbyUserItem | 服务端 | 查询还没发货的订单。仅联机大厅可用 |
# 成就
| 接口 | 描述 | |
|---|---|---|
| LobbyGetAchievementStorage | 服务端 | 获取成就节点的存储的数据。 |
| LobbySetAchievementStorage | 服务端 | 添加成就节点的进度。 |
# 商城
| 接口 | 描述 | |
|---|---|---|
| CloseShopWindow | 客户端 | 关闭网易商城窗口 |
| HideShopGate | 客户端 | 隐藏网易商城入口 |
| OpenItemDetailWindow | 客户端 | 打开特定商品的详情界面 |
| OpenShopWindow | 客户端 | 打开网易商城窗口。PC端无效（Apollo的PC端请使用商城插件） |
| ShowShopGate | 客户端 | 显示网易商城入口 |
# 魔法指令
| 接口 | 描述 | |
|---|---|---|
| Disable | 服务端 | 关闭官方魔法指令功能。需要在ClientLoadAddonsFinishServerEvent事件中调用。仅在联机大厅中生效。 |
| Enable | 服务端 | 启用官方魔法指令功能。需要在ClientLoadAddonsFinishServerEvent事件中调用。仅在联机大厅中生效。 |
# 字体
| 接口 | 描述 | |
|---|---|---|
| EnableFontBatchRender | 客户端 | 是否开启字体合批 |
网易大神
扫码下载网易大神