开发者技术手册

哇叽叽哇 · 发表于 2021-3-17 15:07:11

ModAPI
接口
通用-索引

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	服务端	服务器发送事件到指定客户端
NotifyToServer	客户端	客户端发送事件到服务器
UnDefineEvent	服务端客户端	取消自定义事件
UnListenAllEvents	服务端客户端	反注册监听某个系统抛出的所有事件，即不再监听。
UnListenForEvent	服务端客户端	反注册监听某个系统抛出的事件，即不再监听。若是引擎事件，则namespace和systemName分别为GetEngineNamespace和GetEngineSystemName。与ListenForEvent对应。

本地设备

接口		描述
GetIP	客户端	获取本地玩家的ip地址
GetPlatform	服务端	获取脚本运行的平台
GetPlatform	客户端	获取脚本运行的平台
IsInApollo	服务端	返回当前游戏Mod是否运行在Apollo网络服
IsInServer	服务端	获取当前游戏是否跑在服务器环境下

本地存储

接口		描述
GetConfigData	客户端	获取本地配置文件中存储的数据
SetConfigData	客户端	以本地配置文件的方式存储数据

数学

接口		描述
GetDirFromRot	服务端	通过旋转角度获取朝向
GetDirFromRot	客户端	通过旋转角度获取朝向

工具

接口		描述
AddRepeatedTimer	服务端	添加服务端触发的定时器，重复执行
AddRepeatedTimer	客户端	添加客户端触发的定时器，重复执行
AddTimer	服务端	添加服务端触发的定时器，非重复
AddTimer	客户端	添加客户端触发的定时器，非重复
CancelTimer	服务端	取消定时器
CancelTimer	客户端	取消定时器
CheckNameValid	服务端	检查昵称是否合法，即不包含敏感词
CheckNameValid	客户端	检查昵称是否合法，即不包含敏感词
CheckWordsValid	服务端	检查语句是否合法，即不包含敏感词
CheckWordsValid	客户端	检查语句是否合法，即不包含敏感词
GetMinecraftEnum	服务端	用于获取枚举值文档中的枚举值
GetMinecraftEnum	客户端	用于获取枚举值文档中的枚举值

调试

接口		描述
StartMultiProfile	服务端	开始启动服务端与客户端双端脚本性能分析，启动后调用StopMultiProfile即可在路径path生成函数性能火焰图。双端采集时数据误差较大，建议优先使用StartProfile单端版本，此接口只支持PC端
StartMultiProfile	客户端	开始启动服务端与客户端双端脚本性能分析，启动后调用StopMultiProfile即可在路径path生成函数性能火焰图。双端采集时数据误差较大，建议优先使用StartProfile单端版本，此接口只支持PC端
StartProfile	服务端	开始启动服务端脚本性能分析，启动后调用StopProfile即可在路径path生成函数性能火焰图，此接口只支持PC端。生成的火焰图可以用浏览器打开，推荐chrome浏览器。
StartProfile	客户端	开始启动客户端脚本性能分析，启动后调用StopProfile即可在路径path生成函数性能火焰图，此接口只支持PC端。生成的火焰图可以用浏览器打开，推荐chrome浏览器。
StartRecordEvent	Apollo	开始启动服务端与客户端之间的脚本事件收发统计，启动后调用StopRecordEvent即可获取两个函数调用之间脚本事件收发的统计信息，仅支持租赁服与Apollo网络服环境（不支持单机环境）
StartRecordPacket	Apollo	开始启动服务端与客户端之间的引擎收发包统计，启动后调用StopRecordPacket即可获取两个函数调用之间引擎收发包的统计信息，仅支持租赁服与Apollo网络服环境（不支持单机环境）
StopMultiProfile	服务端	停止双端脚本性能分析并生成火焰图，与StartMultiProfile配合使用，此接口只支持PC端
StopMultiProfile	客户端	停止双端脚本性能分析并生成火焰图，与StartMultiProfile配合使用，此接口只支持PC端
StopProfile	服务端	停止服务端脚本性能分析并生成火焰图，与StartProfile配合使用，此接口只支持PC端
StopProfile	客户端	停止客户端脚本性能分析并生成火焰图，与StartProfile配合使用，此接口只支持PC端
StopRecordEvent	Apollo	停止服务端与客户端之间的脚本事件收发统计并输出结果，与StartRecordEvent配合使用，输出结果为字典，key为网络包名，value字典中记录收发信息，具体见示例，仅支持租赁服与Apollo网络服环境（不支持单机环境）
StopRecordPacket	Apollo	停止服务端与客户端之间的引擎收发包统计并输出结果，与StartRecordPacket配合使用，输出结果为字典，key为网络包名，value字典中记录收发信息，具体见示例，仅支持租赁服与Apollo网络服环境（不支持单机环境）

世界-索引

地图

接口		描述
CanSee	服务端	判断起始对象是否可看见目标对象,基于对象的Head位置判断
CheckBlockToPos	服务端	判断位置之间是否有方块
CheckChunkState	服务端	判断指定位置的chunk是否加载完成
CreateDimension	服务端	创建新的dimension
CreateExplosion	服务端	用于生成爆炸
DeleteAllArea	服务端	删除所有常加载区域
DeleteArea	服务端	删除一个常加载区域
DetectStructure	服务端	检测自定义门的结构
GetAllAreaKeys	服务端	获取所有常加载区域名称列表
GetBiomeName	服务端	获取某一位置所属的生物群系信息
GetBlockLightLevel	服务端	获取方块位置的光照等级
GetChunkMaxPos	服务端	获取某区块最大点的坐标
GetChunkMinPos	服务端	获取某区块最小点的坐标
GetChunkMobNum	服务端	获取某区块中的生物数量（不包括玩家，但包括盔甲架）
GetChunkPosFromBlockPos	服务端	通过方块坐标获得该方块所在区块坐标
GetChunkPosFromBlockPos	客户端	通过方块坐标获得该方块所在区块坐标
GetCurrentDimension	客户端	获取客户端当前维度
GetEntitiesAround	服务端	获取区域内的entity列表
GetEntitiesAroundByType	服务端	获取区域内的某类型的entity列表
GetEntitiesInSquareArea	服务端	获取区域内的entity列表
GetEntityInArea	客户端	返回区域内的实体，可获取到区域范围内已加载的实体列表
GetLevelId	服务端	获取levelId。某些组件需要levelId创建，可以用此接口获取levelId。其中level即为当前地图的游戏。
GetLevelId	客户端	获取levelId。某些组件需要levelId创建，可以用此接口获取levelId。其中level即为当前地图的游戏。
GetSpawnPosition	服务端	获取世界出生点坐标
IsChunkGenerated	服务端	获取某个区块是否生成过。
LocateNeteaseFeature	服务端	与/locate指令 (opens new window)相似，用于定位由网易自定义特征放置的结构，通过PlaceStructure接口、/placestructure指令或结构方块手动放置的结构无法被定位到。如有需要，建议开发者自行记录这些手动放置的结构位置
LocateStructureFeature	服务端	与/locate指令 (opens new window)相似，用于定位原版的部分结构，如海底神殿、末地城等。
MayPlace	服务端	判断方块是否可以放置
MayPlaceOn	服务端	判断物品是否可以放到指定的位置上
MirrorDimension	服务端	复制不同dimension的地形
PlaceStructure	服务端	放置结构
SetAddArea	服务端	设置区块的常加载
UpgradeMapDimensionVersion	服务端	提升指定地图维度的版本号，版本号不符的维度，地图存档信息将被废弃。使用后存档的地图版本均会同步提升至最新版本，假如希望使用此接口清理指定维度的地图存档，建议仅在游戏启动初始化的时期调用（即所有地图区块的信息均存在于地图文件中，而不存在于内存中时）。

实体管理

接口		描述
CreateEngineEntityByTypeStr	服务端	创建指定identifier的实体
CreateEngineItemEntity	服务端	用于创建物品实体（即掉落物），返回物品实体的entityId
CreateExperienceOrb	服务端	创建专属经验球
CreateProjectileEntity	服务端	创建抛射物（直接发射）
DestroyEntity	服务端	销毁实体
GetDroppedItem	服务端	获取掉落在世界的指定entityid的物品信息
GetEngineActor	服务端	获取所有实体。
GetLocalPlayerId	客户端	获取本地玩家的id
GetPlayerList	服务端	获取level中所有玩家的id列表
HasEntity	客户端	判断 entity 是否存在
KillEntity	服务端	杀死某个Entity
SpawnItemToLevel	服务端	生成物品掉落物，如果需要获取物品的entityId，可以调用服务端系统接口CreateEngineItemEntity
SpawnLootTable	服务端	使用生物类型模拟一次随机掉落，生成的物品与json定义的概率有关
SpawnLootTableWithActor	服务端	使用生物实例模拟一次随机掉落，生成的物品与json定义的概率有关
SpawnResources	服务端	产生方块随机掉落（该方法不适用于实体方块）
SpawnResourcesSilkTouched	服务端	模拟方块精准采集掉落

方块管理

接口		描述
GetBlock	客户端	获取某一位置的block
GetBlockNew	服务端	获取某一位置的block
GetDestroyTotalTime	服务端	获取使用物品破坏方块需要的时间
GetDestroyTotalTime	客户端	获取使用物品破坏方块需要的时间
GetTopBlockHeight	服务端	获取某一位置最高的非空气方块的高度
GetTopBlockHeight	客户端	获取当前维度某一位置最高的非空气方块的高度
SetBlockNew	服务端	设置某一位置的方块

生物生成

接口		描述
GetEntityLimit	服务端	获取当前level最大实体数量（上限值，非现有值）
SetEntityLimit	服务端	设置以玩家为中心，6个chunk范围内的最大实体数量，实体数量超过该值后将不再随机生成实体，不影响summon指令和sdk相关生成实体接口
SpawnCustomModule	服务端	设置自定义刷怪

配方

接口		描述
GetRecipeResult	服务端	根据配方id获取配方结果。仅支持合成配方
GetRecipesByInput	服务端	通过输入物品查询配方
GetRecipesByInput	客户端	通过输入物品查询配方
GetRecipesByResult	服务端	通过输出物品查询配方所需要的输入材料
GetRecipesByResult	客户端	通过输出物品查询配方所需要的输入材料

方块组合

接口		描述
RegisterBlockPatterns	服务端	注册特殊方块组合

渲染

接口		描述
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	客户端	隐藏场景内所有名字显示，包括玩家名字，生物的自定义名称，物品展示框与命令方块的悬浮文本等
ResetAmbientBrightness	客户端	重置环境光亮度
ResetFogColor	客户端	重置雾效颜色
ResetFogLength	客户端	重置雾效范围
ResetMoonRot	客户端	重置月亮角度
ResetSkyColor	客户端	重置天空颜色
ResetSkyTextures	客户端	重置当前维度天空盒贴图。如果有使用addon配置贴图则会使用配置的贴图，否则为游戏内默认无贴图的情况
ResetStarBrightness	客户端	重置星星亮度
ResetSunRot	客户端	重置太阳角度
SetAmbientBrightness	客户端	设置环境光亮度，影响天空亮度，不影响实体与方块光照
SetFogColor	客户端	设置雾效颜色
SetFogLength	客户端	设置雾效范围
SetMoonRot	客户端	设置月亮所在角度
SetSkyColor	客户端	设置天空颜色
SetSkyTextures	客户端	设置当前维度天空盒贴图，天空盒需要6张贴图
SetStarBrightness	客户端	设置星星亮度，白天也可以显示星星
SetSunRot	客户端	设置太阳所在角度
SkyTextures	客户端	修改太阳、月亮、云层分布、天空盒的贴图。使用addon配置，非python接口。

时间

接口		描述
GetTime	服务端	获取当前世界时间
SetTime	服务端	设置当前世界时间

天气

接口		描述
IsRaining	服务端	获取是否下雨
IsThunder	服务端	获取是否打雷
SetRaining	服务端	设置是否下雨
SetThunder	服务端	设置是否打雷

游戏规则

接口		描述
AddBannedItem	服务端	增加禁用物品
ClearBannedItems	服务端	清空禁用物品
DisableVineBlockSpread	服务端	设置是否禁用藤曼蔓延生长
ForbidLiquidFlow	Apollo	禁止/允许地图中的流体流动
GetBannedItemList	服务端	获取禁用物品列表
GetGameDiffculty	服务端	获取游戏难度
GetGameRulesInfoServer	服务端	获取游戏规则
GetGameType	服务端	获取游戏类型
GetLevelGravity	服务端	获取重力因子
IsLockDifficulty	服务端	获取当前世界的游戏难度是否被锁定
LockDifficulty	服务端	锁定当前世界游戏难度（仅本次游戏有效），锁定后任何玩家在游戏内都无法通过指令或暂停菜单修改游戏难度
OpenCityProtect	Apollo	开启城市保护，包括禁止破坏方块，禁止对方块使用物品，禁止怪物攻击玩家，禁止玩家之间互相攻击，禁止日夜切换，禁止天气变化，禁止怪物群落刷新
RemoveBannedItem	服务端	移除禁用物品
SetCanActorSetOnFireByLightning	服务端	禁止/允许闪电点燃实体
SetCanBlockSetOnFireByLightning	服务端	禁止/允许闪电点燃方块，当前仅限租赁服、联机大厅、Apollo环境使用
SetDefaultGameType	服务端	设置默认游戏模式
SetDisableContainers	服务端	禁止所有容器界面的打开，包括玩家背包，各种包含背包界面的容器方块如工作台与箱子，以及包含背包界面的实体交互如马背包与村民交易
SetDisableDropItem	服务端	设置禁止丢弃物品
SetDisableGravityInLiquid	服务端	是否屏蔽所有实体在液体（水、岩浆）中的重力
SetDisableHunger	服务端	设置是否屏蔽*度
SetGameDifficulty	服务端	设置游戏难度
SetGameRulesInfoServer	服务端	设置游戏规则。所有参数均可选。
SetHurtCD	服务端	设置伤害CD
SetLevelGravity	服务端	设置重力因子

自定义数据

接口		描述
CleanExtraData	服务端	清除实体的自定义数据或者世界的自定义数据，清除实体数据时使用对应实体id创建组件，清除世界数据时使用levelId创建组件
GetExtraData	服务端	获取实体的自定义数据或者世界的自定义数据，某个键所对应的值。获取实体数据时使用对应实体id创建组件，获取世界数据时使用levelId创建组件
GetWholeExtraData	服务端	获取完整的实体的自定义数据或者世界的自定义数据，获取实体数据时使用对应实体id创建组件，获取世界数据时使用levelId创建组件
SetExtraData	服务端	用于设置实体的自定义数据或者世界的自定义数据，数据以键值对的形式保存。设置实体数据时使用对应实体id创建组件，设置世界数据时使用levelId创建组件

指令

接口		描述
SetCommand	服务端	使用游戏内指令

消息

接口		描述
NotifyOneMessage	服务端	给指定玩家发送聊天框消息
SendMsg	服务端	创建消息实体
SendMsgToPlayer	服务端	创建消息实体，然后发送给某个玩家
SetLeftCornerNotify	客户端	客户端设置左上角通知信息
SetNotifyMsg	服务端	设置消息通知
SetOnePopupNotice	服务端	在具体某个玩家的物品栏上方弹出popup类型通知，位置位于tip类型消息下方，此功能更建议客户端使用game组件的对应接口SetPopupNotice
SetOneTipMessage	服务端	在具体某个玩家的物品栏上方弹出tip类型通知，位置位于popup类型通知上方，此功能更建议在客户端使用game组件的对应接口SetTipMessage
SetPopupNotice	服务端	在所有玩家物品栏上方弹出popup类型通知，位置位于tip类型消息下方
SetPopupNotice	客户端	在本地玩家的物品栏上方弹出popup类型通知，位置位于tip类型消息下方
SetTipMessage	服务端	在所有玩家物品栏上方弹出tip类型通知，位置位于popup类型通知上方
SetTipMessage	客户端	在本地玩家的物品栏上方弹出tip类型通知，位置位于popup类型通知上方

实体-索引

包括实体属性与行为的接口，实体的获取、生成和销毁见世界/实体管理

实体类型

接口		描述
GetEngineType	服务端	获取实体类型
GetEngineType	客户端	获取实体类型
GetEngineTypeStr	服务端	获取实体的类型名称
GetEngineTypeStr	客户端	获取实体的类型名称

附加值

接口		描述
GetAuxValue	服务端	获取射出的弓箭或投掷出的药水的附加值
GetAuxValue	客户端	获取射出的弓箭或投掷出的药水的附加值

属性

接口		描述
ChangeEntityDimension	服务端	传送实体
GetAttrMaxValue	服务端	获取属性最大值
GetAttrValue	服务端	获取属性值
GetBodyRot	客户端	获取实体的身体的角度
GetCurrentAirSupply	服务端	生物当前氧气储备值
GetEntityDimensionId	服务端	获取实体dimension
GetFootPos	服务端	获取实体脚所在的位置
GetFootPos	客户端	获取实体脚所在的位置
GetGravity	服务端	获取实体的重力因子，当生物重力因子为0时则应用世界的重力因子
GetMaxAirSupply	服务端	获取生物最大氧气储备值
GetName	服务端	获取生物的自定义名称，即使用命名牌或者SetName接口设置的名称
GetPos	服务端	获取实体位置
GetPos	客户端	获取实体位置
GetRot	服务端	获取实体角度
GetRot	客户端	获取实体的头的角度
GetSize	服务端	获取实体的包围盒
GetUnitBubbleAirSupply	服务端	单位气泡数对应的氧气储备值
IsConsumingAirSupply	服务端	获取生物当前是否在消耗氧气
LockLocalPlayerRot	客户端	在分离摄像机时，锁定本地玩家的头部角度
SetAttrMaxValue	服务端	设置属性最大值
SetAttrValue	服务端	设置属性值
SetCurrentAirSupply	服务端	设置生物氧气储备值
SetEntityLookAtPos	服务端	设置非玩家的实体看向某个位置
SetFootPos	服务端	设置实体脚所在的位置
SetGravity	服务端	设置实体的重力因子，当生物重力因子为0时则应用世界的重力因子
SetMaxAirSupply	服务端	设置生物最大氧气储备值
SetName	服务端	用于设置生物的自定义名称，跟原版命名牌作用相同，玩家和新版流浪商人暂不支持
SetPlayerLookAtPos	客户端	设置本地玩家看向某个位置
SetPos	服务端	设置实体位置
SetRecoverTotalAirSupplyTime	服务端	设置恢复最大氧气量的时间，单位秒
SetRot	服务端	设置实体角度
SetRot	客户端	设置实体的头的角度
SetSize	服务端	设置实体的包围盒
isEntityInLava	客户端	实体是否在岩浆中
isEntityOnGround	客户端	实体是否触地

行为

接口		描述
GetAttackTarget	服务端	获取仇恨目标
GetHurtBy	服务端	获取上一次攻击自己的实体。该标记的解释见SetHurtBy
GetMotion	服务端	获取生物（含玩家）的瞬时移动方向向量
GetMotion	客户端	获取生物的瞬时移动方向向量
GetOwnerId	服务端	获取驯服生物的主人id
GetStepHeight	服务端	返回玩家前进非跳跃状态下能上的最大台阶高度
Hurt	服务端	设置实体伤害
ImmuneDamage	服务端	设置实体是否免疫伤害（该属性存档）
IsEntityOnFire	服务端	获取实体是否着火
ResetAttackTarget	服务端	清除仇恨目标
ResetHurtBy	服务端	清除上一次攻击自己的实体的标记。该标记的解释见SetHurtBy
ResetStepHeight	服务端	恢复引擎默认玩家前进非跳跃状态下能上的最大台阶高度
SetActorCollidable	客户端	设置实体是否可碰撞
SetActorPushable	服务端	设置实体是否可推动
SetAttackTarget	服务端	设置仇恨目标
SetBlockControlAi	服务端	设置屏蔽生物原生AI
SetCanOtherPlayerRide	服务端	设置其他玩家受否有权限骑乘，True表示每个玩家都能骑乘，False只有驯服者才能骑乘
SetControl	服务端	设置该生物无需装备鞍就可以控制行走跳跃
SetEntityOnFire	服务端	设置实体着火
SetEntityRide	服务端	驯服可骑乘生物
SetEntityTamed	服务端	设置生物驯服，需要配合 entityEvent组件使用。该类驯服不包含骑乘功能。
SetHurtBy	服务端	设置上一次攻击自己的实体，即让他认为某个实体刚才对他发起了攻击（虽然实际上没有）。该标记会驱动一些生物行为，例如minecraft:behavior.panic会使生物远离标记的实体，minecraft:angry会使将该标记转为自身的仇恨目标等等。
SetMobKnockback	服务端	设置击退的初始速度，需要考虑阻力的影响
SetMotion	服务端	设置生物（不含玩家）的瞬时移动方向向量
SetMotion	客户端	设置瞬时的移动方向向量，用于本地玩家
SetMoveSetting	服务端	寻路组件
SetPersistence	服务端	设置实体是否存盘
SetRidePos	服务端	设置生物骑乘位置
SetRiderRideEntity	服务端	设置实体骑乘生物
SetStepHeight	服务端	设置玩家前进非跳跃状态下能上的最大台阶高度, 默认值为0.5625，1的话表示能上一个台阶
TriggerCustomEvent	服务端	触发生物自定义事件

状态效果

接口		描述
AddEffectToEntity	服务端	为实体添加指定状态效果，如果添加的状态已存在则有以下集中情况：1、等级大于已存在则更新状态等级及持续时间；2、状态等级相等且剩余时间duration大于已存在则刷新剩余时间；3、等级小于已存在则不做修改；4、粒子效果以新的为准
GetAllEffects	服务端	获取实体当前所有状态效果
RemoveEffectFromEntity	服务端	为实体删除指定状态效果

渲染

接口		描述
AddActorAnimation	客户端	增加生物渲染动画
AddActorAnimationController	客户端	增加生物渲染动画控制器
AddActorParticleEffect	客户端	增加生物特效资源
AddActorRenderController	客户端	增加生物渲染控制器
AddActorRenderMaterial	客户端	增加生物渲染需要的材质
AddActorScriptAnimate	客户端	在生物的客户端实体定义（minecraft:client_entity）json中的scripts/animate节点添加动画/动画控制器
AddActorSoundEffect	客户端	增加生物音效资源
BindEntityToEntity	客户端	绑定骨骼模型跟随其他entity,摄像机也跟随其他entity
GetNotRenderAtAll	客户端	获取实体是否不渲染
RebuildActorRender	客户端	重建生物的数据渲染器（该接口不支持玩家，玩家请使用RebuildPlayerRender）
RemoveActorAnimationController	客户端	移除生物渲染动画控制器
RemoveActorRenderController	客户端	删除生物渲染控制器
ResetBindEntity	客户端	取消目标entity的绑定实体，取消后不再跟随任何其他entity
SetAlwaysShowName	客户端	设置生物名字是否一直显示，瞄准点不指向生物时也能显示
SetColor	客户端	设置血条的颜色及背景色
SetNameDeeptest	客户端	设置名字是否透视
SetNotRenderAtAll	客户端	设置是否关闭实体渲染
SetRenderLocalPlayer	客户端	设置本地玩家是否渲染
SetShowName	客户端	设置生物名字是否按照默认游戏逻辑显示
ShowHealth	客户端	设置某个entity是否显示血条，默认为显示
ShowHealthBar	客户端	设置是否显示血条

背包

接口		描述
GetEntityItem	服务端	获取生物物品，支持获取背包，盔甲栏，副手以及主手物品
GetEquItemDurability	服务端	获取装备槽位中盔甲的耐久值
GetEquItemEnchant	服务端	获取装备槽位中盔甲的附魔
SetEntityItem	服务端	设置生物物品，建议开发者根据生物特性来进行设置，部分生物设置装备后可能不显示但是死亡后仍然会掉落所设置的装备
SetEquItemDurability	服务端	设置装备槽位中盔甲的耐久值

自定义属性

接口		描述
GetAttr	服务端	获取属性值
GetAttr	客户端	获取属性值
RegisterUpdateFunc	客户端	注册属性值变换时的回调函数，当属性变化时会调用该函数
SetAttr	服务端	设置属性值
SetAttr	客户端	设置客户端属性值
UnRegisterUpdateFunc	客户端	反注册属性值变换时的回调函数

自定义数据

接口		描述
CleanExtraData	服务端	清除实体的自定义数据或者世界的自定义数据，清除实体数据时使用对应实体id创建组件，清除世界数据时使用levelId创建组件
GetExtraData	服务端	获取实体的自定义数据或者世界的自定义数据，某个键所对应的值。获取实体数据时使用对应实体id创建组件，获取世界数据时使用levelId创建组件
GetWholeExtraData	服务端	获取完整的实体的自定义数据或者世界的自定义数据，获取实体数据时使用对应实体id创建组件，获取世界数据时使用levelId创建组件
SetExtraData	服务端	用于设置实体的自定义数据或者世界的自定义数据，数据以键值对的形式保存。设置实体数据时使用对应实体id创建组件，设置世界数据时使用levelId创建组件

molang

接口		描述
Get	客户端	获取某一个实体计算节点的值，如果不存在返回注册时的默认值
GetMolangValue	客户端	获取实体molang变量的值
Register	客户端	注册实体计算节点
Set	客户端	设置某一个实体计算节点的值
UnRegister	客户端	注销实体计算节点

抛射物

接口		描述
GetSourceEntityId	服务端	获取抛射物发射者实体id

经验球

接口		描述
GetOrbExperience	服务端	获取经验球的经验
SetOrbExperience	服务端	设置经验球经验

官方伙伴

接口		描述
Disable	服务端	关闭官方伙伴功能，单人游戏以及本地联机不支持该接口
Enable	服务端	启用官方伙伴功能，单人游戏以及本地联机不支持该接口

玩家-索引

包括玩家属性与行为的接口，玩家的获取见世界/实体管理。玩家也属于实体，因此实体分类下的接口同样适用于玩家

属性

接口		描述
AddPlayerExperience	服务端	增加玩家经验值
AddPlayerLevel	服务端	修改玩家等级
GetPlayerExp	服务端	获取玩家当前等级下的经验值
GetPlayerHunger	服务端	获取玩家度，展示在UI度进度条上，初始值为20，即每一个鸡腿代表2个度。饱和度(saturation) ：玩家当前饱和度，初始值为5，最大值始终为玩家当前度(hunger)，该值直接影响玩家度(hunger)。 1）增加方法：吃食物。 2）减少方法：每触发一次消耗事件，该值减少1，如果该值不大于0，直接把玩家度(hunger) 减少1。
GetPlayerLevel	服务端	获取玩家等级
GetPlayerMaxExhaustionValue	服务端	获取玩家foodExhaustionLevel的归零值，常量值，默认为4。消耗度（exhaustion）是指玩家当前消耗度水平，初始值为0，该值会随着玩家一系列动作（如跳跃）的影响而增加，当该值大于最大消耗度（maxExhaustion）后归零，并且把饱和度（saturation）减少1（为了说明*度机制，我们将此定义为消耗事件）
GetPlayerTotalExp	服务端	获取玩家的总经验值
SetPlayerHunger	服务端	设置玩家*度。
SetPlayerMaxExhaustionValue	服务端	设置玩家foodExhaustionLevel的归零值，通过调整最大消耗度(maxExhaustion) 的大小，就可以加快或者减慢度(hunger) 的消耗，当最大消耗度(maxExhaustion) 很大时，度可以看似一直不下降
SetPlayerPrefixAndSuffixName	服务端	设置玩家前缀和后缀名字
SetPlayerTotalExp	服务端	设置玩家的总经验值
getUid	客户端	获取本地玩家的uid

行为

接口		描述
BeginSprinting	客户端	使本地玩家进入并保持向前冲刺状态
ChangePlayerDimension	服务端	传送玩家
ChangePlayerFlyState	服务端	改变玩家的飞行状态
EnableKeepInventory	服务端	设置玩家死亡不掉落物品
EndSprinting	客户端	使本地玩家结束向前冲刺状态
GetEntityRider	服务端	获取玩家的直接骑乘对象。
IsEntityRiding	服务端	检查玩家是否骑乘。
IsPlayerFlying	服务端	获取玩家是否在飞行
PickUpItemEntity	服务端	某个Player拾取物品ItemEntity
PlayerDestoryBlock	服务端	使用手上工具破坏方块
SetPickUpArea	服务端	设置玩家的拾取物品范围，设置后该玩家的拾取物品范围会在原版拾取范围的基础上进行改变。
SetPlayerJumpable	服务端	设置玩家是否可跳跃
SetPlayerMovable	服务端	设置玩家是否可移动
SetPlayerRespawnPos	服务端	设置玩家复活的位置与维度
SetPlayerRideEntity	服务端	设置玩家骑乘生物
StopEntityRiding	服务端	强制玩家下坐骑。
isGliding	客户端	是否鞘翅飞行
isInWater	客户端	是否在水中
isMoving	客户端	是否在行走
isRiding	客户端	是否骑乘
isSneaking	服务端	获取玩家是否处于潜行状态
isSneaking	客户端	是否潜行
isSprinting	客户端	是否在疾跑
isSwimming	服务端	获取玩家是否处于游泳状态。
isSwimming	客户端	是否游泳
setMoving	客户端	设置是否行走，只能设置本地玩家（只适用于移动端）
setSneaking	客户端	设置是否潜行，只能设置本地玩家（只适用于移动端）
setSprinting	客户端	设置是否疾跑，只能设置本地玩家（只适用于移动端）

渲染

接口		描述
AddPlayerAnimation	客户端	增加玩家渲染动画
AddPlayerAnimationController	客户端	增加玩家渲染动画控制器
AddPlayerAnimationIntoState	客户端	在玩家的动画控制器中的状态添加动画
AddPlayerGeometry	客户端	增加玩家渲染几何体
AddPlayerParticleEffect	客户端	增加玩家特效资源
AddPlayerRenderController	客户端	增加玩家渲染控制器
AddPlayerRenderMaterial	客户端	增加玩家渲染需要的材质
AddPlayerSoundEffect	客户端	增加玩家音效资源
AddPlayerTexture	客户端	增加玩家渲染贴图
RebuildPlayerRender	客户端	重建玩家的数据渲染器
RemovePlayerAnimationController	客户端	移除玩家渲染动画控制器
RemovePlayerGeometry	客户端	删除玩家渲染几何体
RemovePlayerRenderController	客户端	删除玩家渲染控制器
SetSkin	客户端	更换原版自定义皮肤

背包

接口		描述
AddEnchantToInvItem	服务端	给物品栏的物品添加附魔信息
ChangePlayerItemTipsAndExtraId	服务端	修改玩家物品的自定义tips和自定义标识符
ChangeSelectSlot	服务端	设置玩家当前选中快捷栏物品的index
ClearPlayerOffHand	服务端	清除玩家左手物品
GetCarriedItem	客户端	获取右手物品的信息
GetInvItemDurability	服务端	获取背包物品的耐久值
GetInvItemEnchantData	服务端	获取物品栏的物品附魔信息
GetOffhandItem	客户端	获取左手物品的信息
GetPlayerAllItems	服务端	获取玩家指定的槽位的批量物品信息
GetPlayerItem	服务端	获取玩家物品，支持获取背包，盔甲栏，副手以及主手物品
GetSelectSlotId	服务端	获取玩家当前选中槽位
GetSlotId	客户端	获取当前手持的快捷栏的槽id
SetInvItemDurability	服务端	设置背包物品的耐久值
SetInvItemExchange	服务端	交换玩家背包物品
SetInvItemNum	服务端	设置玩家背包物品数目
SetPlayerAllItems	服务端	添加批量物品信息到指定槽位
SpawnItemToPlayerCarried	服务端	生成物品到玩家右手
SpawnItemToPlayerInv	服务端	生成物品到玩家背包

摄像机

接口		描述
DepartCamera	客户端	分离玩家与摄像机
GetCameraAnchor	客户端	获取相机锚点
GetCameraOffset	客户端	获取摄像机偏移量
GetCameraPitchLimit	客户端	获取摄像机上下角度限制值
GetCameraRot	客户端	获取相机转向
GetForward	客户端	返回相机向前的方向
GetFov	客户端	获取视野大小
GetFpHeight	客户端	获取本地玩家当前状态下，第一人称视角时的摄像机高度偏移量。游泳时，滑翔时以及普通状态下会有所不同
GetPerspective	客户端	获取当前的视角模式
GetPosition	客户端	返回相机中心
IsModCameraLockPitch	客户端	是否锁定摄像机上下角度
IsModCameraLockYaw	客户端	是否锁定摄像机左右角度
LockCamera	客户端	锁定摄像机
LockModCameraPitch	客户端	锁定摄像机上下角度（第三人称下生效，锁定后不能上下调整视角）
LockModCameraYaw	客户端	锁定摄像机左右角度（第三人称下生效，锁定后不能通过鼠标左右调整视角）
LockPerspective	客户端	锁定玩家的视角模式
ResetCameraBindActorId	客户端	将摄像机重新绑定回主角身上
SetCameraAnchor	客户端	设置相机锚点,暂时只支持高度,其他维度无效
SetCameraBindActorId	客户端	将摄像机绑定到目标实体身上（调用者与目标必须在同一个dimension，同时需要在加载范围之内，若绑定后目标离开了范围或者死亡，则会自动解除绑定）
SetCameraOffset	客户端	设置摄像机偏移量
SetCameraPitchLimit	客户端	设置摄像机上下角度限制值，默认是（-90，90）
SetCameraPos	客户端	设置相机中心的位置
SetCameraRot	客户端	设定相机转向
SetFov	客户端	设置视野大小
SetPerspective	客户端	设置视角模式
SetSpeedFovLock	客户端	是否锁定相机视野fov，锁定后不随速度变化而变化
UnDepartCamera	客户端	绑定玩家与摄像机
UnLockCamera	客户端	解除摄像机锁定

游戏模式

接口		描述
GetPlayerGameType	服务端	获取指定玩家的游戏模式
SetPlayerGameType	服务端	设置玩家个人游戏模式

权限

接口		描述
GetPlayerAbilities	服务端	获取玩家具体权限
GetPlayerOperation	服务端	获取玩家权限类型信息

导航

接口		描述
GetNavPath	客户端	获取本地玩家到目标点的寻路路径，开发者可以通过该接口定制自定义的导航系统。
StartNavTo	客户端	我们提供了一个基于GetNavPath的导航系统实现，做法是在路径上生成序列帧以引导玩家通向目标点，并且当玩家偏离路径会重新进行导航。
StopNav	客户端	终止当前的导航

动画

接口		描述
PlayTpAnimation	客户端	第三人称视角播放玩家通用动作
StopAnimation	客户端	停止播放玩家通用动作

方块-索引

包括方块及方块实体属性的接口，方块的放置和获取见世界/方块管理

方块状态与附加值

接口		描述
GetBlockAuxValueFromStates	服务端	根据方块名称和方块状态获取方块附加值AuxValue
GetBlockStates	服务端	获取方块状态
GetBlockStatesFromAuxValue	服务端	根据方块名称和方块附加值AuxValue获取方块状态
SetBlockStates	服务端	设置方块状态

方块实体

接口		描述
CleanBlockTileEntityCustomData	服务端	清空指定位置的特殊方块（箱子、头颅、熔炉、花盆等）绑定的TileEntity内存储的自定义数据。
GetBlockEntityData	服务端	用于获取可操作某个自定义方块实体数据的对象，操作方式与dict类似
GetBlockEntityData	服务端	用于获取方块（包括自定义方块）的数据，数据只读不可写
GetBlockTileEntityCustomData	服务端	读取指定位置的特殊方块（箱子、头颅、熔炉、花盆等）绑定的TileEntity内存储的自定义数据
GetBlockTileEntityWholeCustomData	服务端	读取指定位置的特殊方块（箱子、头颅、熔炉、花盆等）绑定的TileEntity内存储的自定义数据字典。
SetBlockTileEntityCustomData	服务端	设置指定位置的特殊方块（箱子、头颅、熔炉、花盆等）绑定的TileEntity内存储的自定义数据。

渲染

接口		描述
ChangeBlockTextures	客户端	替换方块贴图

容器

接口		描述
GetChestBoxSize	服务端	获取箱子容量大小
GetChestPairedPosition	服务端	获取与箱子A合并成一个大箱子的箱子B的坐标
GetContainerItem	服务端	获取容器内的物品
GetContainerSize	服务端	获取容器容量大小
GetEnderChestItem	服务端	获取末影箱内的物品
SetChestBoxItemExchange	服务端	交换箱子里物品的槽位
SetChestBoxItemNum	服务端	设置箱子槽位物品数目
SpawnItemToChestBlock	服务端	生成物品到箱子
SpawnItemToContainer	服务端	生成物品到容器
SpawnItemToEnderChest	服务端	生成物品到末影箱

红石

接口		描述
GetBlockPoweredState	服务端	获取某个坐标方块的充能状态
GetStrength	服务端	获取某个坐标的红石信号强度

告示牌

接口		描述
GetSignBlockText	服务端	获取告示牌（方块）的文本内容
SetSignBlockText	服务端	设置告示牌（方块）的文本内容

床

接口		描述
GetBedColor	服务端	获取床（方块）的颜色
SetBedColor	服务端	设置床（方块）的颜色

物品-索引

包括物品属性的接口，物品的生成与获取见玩家/背包，实体/背包，方块/容器，物品实体的生成与获取见世界/实体管理

[td]

接口		描述
ChangeArmorTextures	客户端	修改盔甲在场景中显示和在UI中显示的贴图
ChangeItemTexture	客户端	替换物品的贴图，修改后所有用到该贴图的物品都会被改变，后续创建的此类物品也会被改变。会同时修改物品在UI界面上的显示，手持时候的显示与场景掉落的显示。
GetCustomName	服务端	获取物品的自定义名称，与铁砧修改的名称一致
GetItemBasicInfo	服务端	获取物品的基础信息
GetItemBasicInfo	客户端	获取物品的基础信息
GetItemDurability	服务端	获取指定槽位的物品耐久
GetItemEffectName	客户端	获取物品的状态描述，如：§7保护 0§r
GetItemFormattedHoverText	客户端	获取物品的格式化hover文本，如：§f灾厄旗帜§r
GetItemHoverName	客户端	获取物品的hover名称，如：灾厄旗帜§r
GetUserDataInEvent	服务端	使物品相关服务端事件的物品信息字典参数带有userData。在mod初始化时调用即可
GetUserDataInEvent	客户端	使物品相关客户端事件的物品信息字典参数带有userData。在mod初始化时调用即可
LookupItemByName	服务端	判定指定identifier的物品是否存在
SetAttackDamage	服务端	设置物品的攻击伤害值
SetCustomName	服务端	设置物品的自定义名称，与使用铁砧重命名一致
SetItemDurability	服务端	设置物品的耐久值
SetItemTierLevel	服务端	设置工具类物品的挖掘等级
SetItemTierSpeed	服务端	设置工具类物品的挖掘速度
SetMaxStackSize	服务端	设置物品的最大堆叠数量（存档）

特效-索引

通用

接口		描述
DestroyEntity	客户端	销毁特效

文字面板

接口		描述
CreateTextBoardInWorld	客户端	创建文字面板
RemoveTextBoard	客户端	删除文字面板
SetBoardBackgroundColor	客户端	修改背景颜色
SetBoardBindEntity	客户端	文字面板绑定实体对象
SetBoardDepthTest	客户端	设置是否开启深度测试, 默认状态下是开启
SetBoardFaceCamera	客户端	设置文字面板的朝向
SetBoardPos	客户端	修改位置
SetBoardRot	客户端	修改旋转角度, 若设置了文本朝向相机，则旋转角度的修改不会生效
SetBoardScale	客户端	内容整体缩放
SetBoardTextColor	客户端	修改字体颜色

序列帧

接口		描述
Bind	客户端	绑定entity
Bind	客户端	绑定骨骼模型
CreateEngineSfx	客户端	创建序列帧特效
CreateEngineSfxFromEditor	客户端	指使用资源包中effects/xxx.json，按照编辑器中编辑好的参数创建序列帧。支持环状序列帧
Play	客户端	播放序列帧
SetDeepTest	客户端	设置序列帧是否透视，默认为否
SetFaceCamera	客户端	设置序列帧是否始终朝向摄像机，默认为是
SetFadeDistance	客户端	设置序列帧开始自动调整透明度的距离。序列帧与摄像机之间的距离小于该值时会自动调整序列帧的透明度，距离摄像机越近，序列帧越透明
SetLayer	客户端	设置序列帧渲染层级，默认层级为1，当层级不为1时表示该特效开启特效分层渲染功能。特效（粒子和帧动画）分层渲染时，层级越高渲染越靠后，层级大的会遮挡层级低的，且同一层级的特效会根据特效的相对位置产生正确的相互遮挡关系。
SetLoop	客户端	设置序列帧是否循环播放，默认为否
SetMixColor	客户端	设置序列帧混合颜色
SetPos	客户端	设置序列帧的位置
SetRot	客户端	设置序列帧的旋转
SetScale	客户端	设置序列帧的缩放
SetUsePointFiltering	客户端	设置序列帧是否使用点滤波
Stop	客户端	停止序列帧（不是暂停）

粒子

接口		描述
Bind	客户端	绑定entity
Bind	客户端	绑定骨骼模型
CreateEngineParticle	客户端	用于创建粒子特效
Play	客户端	播放粒子特效
SetFadeDistance	客户端	设置粒子开始自动调整透明度的距离。粒子与摄像机之间的距离小于该值时会自动调整粒子的透明度，距离摄像机越近，粒子越透明
SetLayer	客户端	粒子默认层级为1，当层级不为1时表示该特效开启特效分层渲染功能。特效（粒子和帧动画）分层渲染时，层级越高渲染越靠后，层级大的会遮挡层级低的，且同一层级的特效会根据特效的相对位置产生正确的相互遮挡关系。
SetPos	客户端	设置粒子的位置
SetRelative	客户端	当粒子绑定了entity或骨骼模型时，发射出的粒子使用entity坐标系还是世界坐标系。与mcstudio特效编辑器中粒子的“相对挂点运动”选项功能相同。
SetRot	客户端	设置粒子的旋转
Stop	客户端	停止粒子播放

模型特效

接口		描述
CreateEngineEffect	客户端	指用编辑器保存资源包中models/effect/xxx_effect.json生成编辑好的所有挂点的所有特效。生成的特效会自动进行挂接及播放，编辑器中设为不可见的特效也会进行播放。并且使用这种方式创建的特效，开发者不用维护entity进出视野导致的挂接特效被移除，引擎会在entity每次进入视野时自动创建所有特效。

模型-索引

包括骨骼模型相关接口

[td]

接口		描述
BindModelToEntity	客户端	实体替换骨骼模型后，再往上其他挂接骨骼模型。对实体播骨骼动作时，其上面挂接的模型也会播相同的动作。
BindModelToModel	客户端	在骨骼模型上挂接其他骨骼模型
CreateFreeModel	客户端	创建自由的模型（无需绑定Entity）
GetAllBindModelToEntity	客户端	获取实体上某个骨骼上挂接的所有骨骼模型的id
GetAnimLength	客户端	获取某个骨骼动画的长度，单位为秒
GetBoneWorldPos	客户端	获取骨骼的坐标
GetEntityBoneWorldPos	客户端	获取换了骨骼模型的实体的骨骼坐标
GetEntityScale	服务端	获取实体的放缩比例大小
GetModelId	客户端	获取骨骼模型的Id，主要用于特效绑定骨骼模型
GetModelName	服务端	获取实体的模型名称
GetPlayingAnim	客户端	获取当前播放的骨骼动画名称
HideModel	客户端	隐藏纯模型
ModelPlayAni	客户端	纯骨骼播放动作
PlayAnim	客户端	播放骨骼动画
PlayBodyAnim	客户端	上下半身分离时，对上半身播放动画
PlayLegAnim	客户端	上下半身分离时，对下半身播放动画
RemoveFreeModel	客户端	移除自由模型
ResetModel	客户端	恢复实体为原版模型
SetAnimSpeed	客户端	设置某个骨骼动画的播放速度
SetBrightness	客户端	设置实体的亮度
SetEntityOpacity	客户端	设置生物模型的透明度
SetEntityScale	服务端	设置实体的放缩比例大小，设置比例过大会导致游戏卡顿，建议控制在20倍以内
SetFreeModelBoundingBox	客户端	设置模型包围盒
SetFreeModelPos	客户端	设置自由模型的位置
SetFreeModelRot	客户端	设置自由模型的方向
SetFreeModelScale	客户端	设置自由模型的大小
SetLegacyBindRot	客户端	用于修复特效挂接到骨骼时的方向
SetModel	服务端	设置骨骼模型
SetModel	客户端	替换实体的骨骼模型
SetModelOffset	服务端	设置骨骼模型相对于局部坐标系的偏移量，初始值为(0, 0, 0)
SetModelOffset	客户端	模型增加偏移量
SetModelPerspectiveEffect	客户端	设置模型透视效果。注：只对自定义骨骼模型生效
SetModelTexture	服务端	设置骨骼模型贴图
SetTexture	客户端	替换骨骼模型的贴图
ShowCommonHurtColor	服务端	设置挂接骨骼模型的实体是否显示通用的受伤变红效果（广播）
ShowCommonHurtColor	客户端	设置挂接骨骼模型的实体是否显示通用的受伤变红效果
ShowModel	客户端	显示纯模型
StopBodyAnim	客户端	停止上半身动画
StopLegAnim	客户端	停止下半身动画
UnBindModelToEntity	客户端	取消实体上挂接的某个骨骼模型。取消挂接后，这个modelId的模型便会销毁，无法再使用，如果是临时隐藏可以使用HideModel
UnBindModelToModel	客户端	取消骨骼模型上挂接的某个骨骼模型。取消挂接后，这个modelId的模型便会销毁，无法再使用，如果是临时隐藏可以使用HideModel

原生UI-索引

包括原版HUD界面的相关接口

[td]

接口		描述
GetScreenSize	客户端	获取游戏分辨率
GetScreenViewInfo	客户端	获取游戏视角信息。分辨率为1313，618时，画布是376，250的2倍，所以viewport得到的是1313 + (2-(1313%2))，y值类似，可参考《我的世界》界面适配方法
HideAirSupplyGUI	客户端	隐藏玩家氧气值界面
HideArmorGui	客户端	隐藏hud界面的护甲值显示
HideChangePersonGui	客户端	隐藏切换人称的按钮。隐藏后点击相应位置不会响应
HideExpGui	客户端	非创造者模式下隐藏经验条显示
HideHealthGui	客户端	隐藏hud界面的血量显示
HideHorseHealthGui	客户端	隐藏hud界面的坐骑的血量显示
HideHudGUI	客户端	隐藏HUD游戏界面的游戏原生UI。与原版F1按钮效果一致，只隐藏显示，但点击跳跃键等位置依然会响应
HideHungerGui	客户端	隐藏hud界面的*值显示
HideInteractGui	客户端	隐藏交互按钮。隐藏后点击相应位置不会响应
HideJumpGui	客户端	隐藏游戏中右下角的跳跃按钮。隐藏后点击相应位置不会响应
HideMoveGui	客户端	隐藏游戏中左下角的移动按钮。隐藏后点击相应位置不会响应
HideNeteaseStoreGui	客户端	隐藏游戏中的网易商店按钮。隐藏后点击相应位置不会响应
HideSlotBarGui	客户端	隐藏游戏中底部中间的物品栏界面
HideSneakGui	客户端	隐藏游戏中左下角方向键的中心处潜行按钮。隐藏后点击相应位置不会响应
HideSwimGui	客户端	隐藏游戏中的浮潜按钮。隐藏后点击相应位置不会响应
HideWalkGui	客户端	隐藏游戏中右上角的移动类型按钮。隐藏后点击相应位置不会响应
OpenNeteaseStoreGui	客户端	打开游戏中的网易商店购买商品界面
SetCrossHair	客户端	设置屏幕中心的十字是否显示
SetHudChatStackPosition	客户端	设置HUD界面左上小聊天窗口位置
SetHudChatStackVisible	客户端	设置HUD界面左上小聊天窗口可见性
SetResponse	客户端	设置原生UI是否响应

自定义UI-索引

通用

通用

接口		描述
CheckCanBindUI	客户端	检查实体是否可以绑定头顶UI，如何将UI与实体绑定详见创建UI界面
CreateUI	客户端	创建UI，详见创建ui界面
GetCustomUIControlProxyCls	客户端	获得原生界面自定义UI代理基类
GetMiniMapScreenNodeCls	客户端	获取小地图ScreenNode基类
GetNativeScreenManagerCls	客户端	获得NativeScreenManager类
GetScreenNodeCls	客户端	获得ScreenNode类
GetUI	客户端	获取UI节点，详见获取ui界面
GetViewBinderCls	客户端	获得ViewBinder类
GetViewViewRequestCls	客户端	获得ViewRequest类
PopScreen	客户端	使用堆栈管理的方式关闭UI
PushScreen	客户端	使用堆栈管理的方式创建UI
RegisterUI	客户端	注册UI，创建UI前，需要先注册UI。同一UI只需要注册一次即可。详见注册ui界面

UI界面 ScreenNode

函数	描述
SetScreenVisible	设置是否显示本界面
ChangeBindEntityId	修改绑定的实体id，只对已绑定实体的UI界面生效，如何将UI与实体绑定详见创建UI界面
BindVirtualWorldModel	绑定虚拟世界中的模型
ChangeBindOffset	修改与绑定实体之间的偏移量，只对已绑定实体的UI界面生效，如何将UI与实体绑定详见创建UI界面
ChangeBindAutoScale	设置已绑定实体的UI是否根据绑定实体与本地玩家间的距离动态缩放，只对已绑定实体的UI界面生效，如何将UI与实体绑定详见创建UI界面
GetBindEntityId	获取该UI绑定的实体id，未绑定的UI将传回默认值None
GetBindOffset	获取该UI绑定实体的偏移量，未绑定的UI将传回默认值(0, 0, 0)
GetBindAutoScale	获取该绑定实体的UI是否动态缩放，未绑定的UI将传回默认值1
Clone	克隆一个已有的控件，修改它的名称，并将它挂接到指定的父节点上，目前文本、图片、按钮控件的克隆控件表现正常，其他复杂控件的克隆控件可能存在运行问题，建议在json编写的过程中，手动复制一份对应控件使用。
GetChildrenName	获取子节点的名称list
GetAllChildrenPath	获取所有子节点的路径list
RemoveComponent	动态删除某一控件
SetRemove	删除本界面节点
SetUiModel	设置PaperDoll控件需要显示的模型,PaperDoll控件的配置方式详见控件介绍PaperDoll
SetUiEntity	设置PaperDoll控件需要显示的生物模型,PaperDoll控件的配置方式详见控件介绍PaperDoll
SetUiModelScale	设置PaperDoll控件模型的缩放比例
SetUiItem	设置ItemRenderer控件显示的物品，ItemRenderer控件的配置方式详见控件介绍ItemRenderer
UpdateScreen	刷新界面，重新计算各个控件的相关数据
SetStackGridCount	设置StackGrid控件的大小
SetSelectControl	设置当前焦点所在的控件
GetRichTextItem	返回一个富文本控件实例
SetIsHud	设置本界面的输入模式
GetIsHud	获得本界面的输入模式
GetBaseUIControl	根据路径获取BaseUIControl实例

MiniMapBaseScreen

函数	描述
AddEntityMarker	增加实体位置标记
RemoveEntityMarker	删除实体位置标记
AddStaticMarker	增加地图上静态位置的标记
RemoveStaticMarker	删除静态位置标记
ZoomIn	放大地图
ZoomOut	缩小地图
ZoomReset	恢复地图放缩大小为默认值
SetHighestY	设置绘制地图的最大高度

UI控件 BaseUIControl

函数	描述
SetPosition	设置控件相对父节点的坐标
GetPosition	获取控件相对父节点的坐标
SetSize	设置控件的大小
GetSize	获取控件的大小
SetVisible	根据控件路径选择是否显示某控件
GetVisible	根据控件路径返回某控件是否已显示
SetTouchEnable	设置控件是否可点击交互
SetAlpha	设置节点的透明度，仅对image和label控件生效
SetLayer	设置控件节点的层级
GetChildByName	根据子控件的名称获取BaseUIControl实例
GetChildByPath	根据相对路径获取BaseUIControl实例
asLabel	将当前BaseUIControl转换为LabelUIControl实例，如当前控件非Label类型则返回None
asButton	将当前BaseUIControl转换为ButtonUIControl实例，如当前控件非button类型则返回None
asImage	将当前BaseUIControl转换为ImageUIControl实例，如当前控件非image类型则返回None
asGrid	将当前BaseUIControl转换为GridUIControl实例，如当前控件非grid类型则返回None
asScrollView	将当前BaseUIControl转换为ScrollViewUIControl实例，如当前控件非scrollview类型则返回None
asSwitchToggle	将当前BaseUIControl转换为SwitchToggleUIControl实例，如当前控件非panel类型则返回None
asTextEditBox	将当前BaseUIControl转换为TextEditBoxUIControl实例，如当前控件非editbox类型则返回None
asProgressBar	将当前BaseUIControl转换为TextEditBoxUIControl实例，如当前控件非panel类型则返回None
asNeteasePaperDoll	将当前BaseUIControl转换为NeteasePaperDollUIControl实例，如当前控件非custom类型则返回None
asMiniMap	将当前BaseUIControl转换为MiniMapUIControl实例，如当前控件非小地图类型则返回None

ButtonUIControl

函数	描述
AddTouchEventParams	开启按钮回调功能，不调用该函数则按钮无回调
SetButtonTouchDownCallback	设置按钮按下时触发的回调函数
SetButtonTouchUpCallback	设置触控在按钮范围内弹起时的回调函数
SetButtonTouchCancelCallback	设置触控在按钮范围外弹起时触发的回调函数
SetButtonTouchMoveCallback	设置按下后触控移动时触发的回调函数
SetButtonTouchMoveInCallback	设置按下按钮后进入控件时触发的回调函数
SetButtonTouchMoveOutCallback	设置按下按钮后退出控件时触发的回调函数

GridUIControl

函数	描述
SetGridDimension	设置Grid控件的大小

ImageUIControl

函数	描述
SetSprite	给图片控件换指定贴图
SetSpriteColor	设置图片颜色
SetSpriteGray	给图片控件置灰，比直接SetSprite一张灰图片效率要高
SetSpriteUV	设置图片的起始uv，与json中的"uv"属性作用一致
SetSpriteUVSize	设置图片的uv大小，与json中的"uv_size"属性作用一致
SetSpriteClipRatio	设置图片的裁剪区域比例（不改变控件尺寸）。可以配合image控件的clip_ratio属性控制方向。

LabelUIControl

函数	描述
SetText	设置Label的文本信息
GetText	获取Label的文本信息，获取失败会返回None
SetTextColor	设置Label文本的颜色
GetTextColor	获取Label文本颜色
SetTextFontSize	设置Label中文本字体的大小

MiniMapUIControl

函数	描述
ZoomIn	放大地图
ZoomOut	缩小地图
ZoomReset	恢复地图放缩大小为默认值
SetHighestY	设置绘制地图的最大高度

NeteasePaperDollUIControl

函数	描述
GetModelId	获取渲染的骨骼模型Id
RenderEntity	渲染实体
RenderSkeletonModel	渲染骨骼模型（不依赖实体）

ProgressBarUIControl

函数	描述
SetValue	设置进度条的进度

ScrollViewUIControl

函数	描述
SetScrollViewPos	设置当前scroll_view内容的位置
GetScrollViewPos	获得当前scroll_view最上方内容的位置
SetScrollViewPercentValue	设置当前scroll_view内容的百分比位置
GetScrollViewContentPath	返回该scroll_view内容的路径
GetScrollViewContentControl	返回该scroll_view内容的BaseUIControl实例

SwitchToggleUIControl

函数	描述
SetToggleState	设置Toggle开关控件的值

TextEditBoxUIControl

函数	描述
GetEditText	获取edit_box输入框的文本信息，获取失败会返回None
SetEditText	设置edit_box输入框的文本信息
SetEditTextMaxLength	设置输入框的最大输入长度

音效-索引

[td]

接口		描述
DisableOriginMusic	客户端	停止原生背景音乐
Play	客户端	播放场景音效
Play	客户端	播放原版音效
PlayCustomMusic	客户端	播放场景音效
PlayGlobalCustomMusic	客户端	播放背景音乐
PlaySystemSound	服务端	播放游戏内原有内容
SetCustomMusicLoop	客户端	设定指定音乐是否循环播放，包括场景音效与背景音乐
SetCustomMusicLoopById	客户端	设定指定音乐是否循环播放
StopCustomMusic	客户端	停止音效，包括场景音效与背景音乐，将依据fadeOutTime触发OnMusicStopClientEvent事件
StopCustomMusicById	客户端	停止场景音效

控制-索引

包括屏幕操作的相关接口

[td]

接口		描述
AddPickBlacklist	客户端	添加使用camera组件选取实体时的黑名单，即该实体不会被选取到
ClearPickBlacklist	客户端	清除使用camera组件选取实体的黑名单
GetChosen	客户端	获取屏幕点击位置的实体或方块信息，通常与GetEntityByCoordEvent配合使用
GetChosenEntity	客户端	获取屏幕点击位置的实体id，通常与GetEntityByCoordEvent配合使用
GetHoldTimeThresholdInMs	客户端	获取长按判定时间，即按着屏幕多长时间会触发长按操作
GetInputVector	客户端	获取方向键（移动轮盘）的输入
GetTouchPos	客户端	获取点击的屏幕坐标
LockInputVector	客户端	锁定本地玩家方向键（移动轮盘）的输入，可使本地玩家持续向指定方向前行，且不会再受玩家输入影响
PickFacing	客户端	获取准星选中的实体或者方块
SetCanAll	客户端	同时设置SetCanMove，SetCanJump，SetCanAttack，SetCanWalkMode，SetCanPerspective，SetCanPause，SetCanChat，SetCanScreenShot，SetCanOpenInv，SetCanDrag，SetCanInair
SetCanAttack	客户端	设置是否响应攻击
SetCanChat	客户端	设置是否响应聊天按钮
SetCanDrag	客户端	设置是否响应屏幕拖动
SetCanInair	客户端	设置是否响应上升下降按钮（飞在空中时右下角的三个按钮）
SetCanJump	客户端	设置是否响应跳跃（以及在水中浮起）
SetCanMove	客户端	设置是否响应移动
SetCanOpenInv	客户端	设置是否响应打开背包按钮
SetCanPause	客户端	设置是否响应暂停按钮
SetCanPerspective	客户端	设置是否响应切换视角
SetCanScreenShot	客户端	设置是否响应截图按钮
SetCanWalkMode	客户端	设置是否响应切换行走模式
SetHoldTimeThreshold	客户端	设置长按判定时间，即按着屏幕多长时间会触发长按操作
SetMoveLock	客户端	设置是否锁住移动。实际上为是否响应十字键与遥感的操作。与SetCanMove的区别：使用SetCanMove禁止移动后，使用SetMotion也不能移动。而用这个接口设为不能移动，SetMotion可以控制玩家移动
SetShowRideUI	服务端	设置是否显示马匹的UI界面
SimulateTouchWithMouse	客户端	模拟使用鼠标控制UI（PC F11快捷键）
UnlockInputVector	客户端	解锁本地玩家方向键（移动轮盘）的输入

游戏设置-索引

暂停菜单->设置页面的相关接口

[td]

接口		描述
GetToggleOption	客户端	获得某个开关设置值的接口
GetUIProfile	客户端	获取"UI 档案"模式
HighlightBoxSelection	客户端	镜头移动时高亮当前视角中心所指的方块
SetToggleOption	客户端	修改开关型设置的接口
SetUIProfile	客户端	设置"UI 档案"模式

虚拟世界-索引

世界

接口		描述
VirtualWorldCreate	客户端	创建虚拟世界，虚拟世界只允许存在一个，已经存在虚拟世界的情况下再调用此方法则无效
VirtualWorldDestroy	客户端	销毁虚拟世界
VirtualWorldSetCollidersVisible	客户端	设置虚拟世界中模型的包围盒是否显示,主要用于调试,默认为不显示
VirtualWorldToggleVisibility	客户端	设置虚拟世界是否显示

相机

接口		描述
CameraGetClickModel	客户端	获取相机当前指向的模型的id，会返回离相机最近的，通常与GetEntityByCoordEvent配合使用
CameraGetFov	客户端	获取相机视野大小
CameraGetPos	客户端	返回相机位置
CameraGetZoom	客户端	获取相机的缩放值
CameraLookAt	客户端	修改相机朝向
CameraMoveTo	客户端	设置相机移动动画, 会根据当前相机状态与传入参数按时间进行插值显示
CameraSetFov	客户端	设置相机视野大小
CameraSetPos	客户端	设置相机位置
CameraSetZoom	客户端	设置相机缩放
CameraStopActions	客户端	停止相机移动动画

模型

接口		描述
ModelCreateObject	客户端	在虚拟世界中创建模型
ModelGetPos	客户端	获取模型的坐标
ModelGetRot	客户端	返回模型的旋转角度
ModelIsVisible	客户端	返回模型可见性
ModelMoveTo	客户端	设置模型平移运动
ModelPlayAnimation	客户端	模型播放动画
ModelRemove	客户端	销毁虚拟世界中的模型
ModelRotate	客户端	模型绕某个轴旋转多少度
ModelRotateTo	客户端	设置模型旋转运动
ModelSetBoxCollider	客户端	设置模型的包围盒
ModelSetPos	客户端	设置模型坐标
ModelSetRot	客户端	设置模型的旋转角度
ModelSetScale	客户端	设置模型的缩放值
ModelSetVisible	客户端	设置模型可见性
ModelStopActions	客户端	停止模型的移动和旋转运动

其它对象

接口		描述
BindModel	客户端	把对象绑定到模型上, 支持绑定序列帧，粒子，文本和其它模型
MoveToVirtualWorld	客户端	把对象从主世界移到虚拟世界, 非绑定的序列帧，文本，粒子需要调用该方法后才会出现在虚拟世界中，绑定的可以省略调用该方法。

事件 世界-索引[td]

事件		描述
AddEntityClientEvent	客户端	actor实体增加，事件触发
AddEntityServerEvent	服务端	actor实体增加，事件触发，对应客户端AddEntityEvent
AddPlayerAOIClientEvent	客户端	玩家加入游戏或者其余玩家进入当前玩家所在的区块时触发的AOI事件，替换AddPlayerEvent
AddServerPlayerEvent	服务端	触发时机：玩家加入时触发该事件。
ChunkAcquireDiscardedClientEvent	客户端	触发时机：通过AddChunkPosWhiteList接口添加监听的客户端区块即将被卸载时
ChunkAcquireDiscardedServerEvent	服务端	触发时机：通过AddChunkPosWhiteList接口添加监听的服务端区块即将被卸载时
ChunkGeneratedServerEvent	服务端	触发时机：区块创建完成时触发
ChunkLoadedClientEvent	客户端	触发时机：通过AddChunkPosWhiteList接口添加监听的客户端区块加载完成时
ChunkLoadedServerEvent	服务端	触发时机：通过AddChunkPosWhiteList接口添加监听的服务端区块加载完成时
ClientLoadAddonsFinishServerEvent	服务端	触发时机：客户端mod加载完成时，服务端触发此事件。服务器可以使用此事件，往客户端发送数据给其初始化。
CommandEvent	服务端	玩家请求执行指令时触发
DelServerPlayerEvent	服务端	触发时机：删除玩家时触发该事件。
EntityRemoveEvent	服务端	实体被删除时触发
ExplosionServerEvent	服务端	当发生爆炸时触发。
LoadClientAddonScriptsAfter	客户端	客户端加载mod完成事件
LoadServerAddonScriptsAfter	服务端	服务器加载完mod时触发
OnCommandOutputClientEvent	客户端	当command命令有成功消息输出时触发
OnCommandOutputServerEvent	服务端	Command命令执行成功事件
OnContainerFillLoottableServerEvent	服务端	触发时机：随机奖励箱第一次打开根据loottable生成物品时
OnEntityAreaEvent	服务端	触发时机：通过RegisterEntityAOIEvent注册过AOI事件后，当有实体进入或离开注册感应区域时触发该事件。
OnLightningLevelChangeServerEvent	服务端	打雷强度发生改变
OnLocalPlayerStopLoading	客户端	触发时机：玩家进入存档，出生点地形加载完成时触发。该事件触发时可以进行切换维度的操作。
OnRainLevelChangeServerEvent	服务端	下雨强度发生改变
OnScriptTickClient	客户端	客户端tick事件,1秒30次
OnScriptTickServer	服务端	服务器tick时触发,1秒有30个tick
PlaceNeteaseStructureFeatureEvent	服务端	触发时机：首次生成地形时，结构特征即将生成时服务端抛出该事件。
PlayerJoinMessageEvent	服务端	触发时机：准备显示“xxx加入游戏”的玩家登录提示文字时服务端抛出的事件。
PlayerLeftMessageServerEvent	服务端	触发时机：准备显示“xxx离开游戏”的玩家离开提示文字时服务端抛出的事件。
RemoveEntityClientEvent	客户端	实体被移除时，事件触发
RemovePlayerAOIClientEvent	客户端	玩家离开当前玩家同一个区块时触发AOI事件
ServerChatEvent	服务端	玩家发送聊天信息时触发
ServerPostBlockPatternEvent	服务端	触发时机：用方块组合生成生物，生成生物之后触发该事件。
ServerPreBlockPatternEvent	服务端	触发时机：用方块组合生成生物，在放置最后一个组成方块时触发该事件。
ServerSpawnMobEvent	服务端	游戏内自动生成怪物时触发
UnLoadClientAddonScriptsBefore	客户端	客户端卸载mod之前触发

实体-索引[td]

事件		描述
ActorHurtServerEvent	服务端	触发时机：生物（包括玩家）受伤时触发
ActuallyHurtServerEvent	服务端	实体实际受到伤害时触发，相比于DamageEvent，该伤害为经过护甲及buff计算后，实际的扣血量
AddEffectServerEvent	服务端	触发时机：实体获得状态效果时
ApproachEntityClientEvent	客户端	玩家靠近生物时触发
ChangeSwimStateServerEvent	服务端	触发时机：实体开始或者结束游泳时
DamageEvent	服务端	实体被攻击时触发
EntityChangeDimensionServerEvent	服务端	实体维度改变时服务端抛出
EntityDefinitionsEventServerEvent	服务端	触发时机：生物定义json文件中设置的event触发时同时触发。生物行为变更事件
EntityDieLoottableServerEvent	服务端	触发时机：生物死亡掉落物品时
EntityEffectDamageServerEvent	服务端	生物受到状态伤害/回复事件。
EntityLoadScriptEvent	服务端	数据库加载实体自定义数据时触发
EntityStartRidingEvent	服务端	当实体骑乘上另一个实体时触发
EntityStopRidingEvent	服务端	触发时机：当实体停止骑乘时
EntityStopRidingEvent	客户端	触发时机：当实体停止骑乘时
EntityTickServerEvent	服务端	实体tick时触发。该事件为20帧每秒。需要使用AddEntityTickEventWhiteList添加触发该事件的实体类型白名单。
LeaveEntityClientEvent	客户端	玩家远离生物时触发
MobDieEvent	服务端	实体被玩家杀死时触发
MobGriefingBlockServerEvent	服务端	环境生物改变方块时触发，触发的时机与mobgriefing游戏规则影响的行为相同
OnFireHurtEvent	服务端	生物受到火焰伤害时触发
OnGroundClientEvent	客户端	实体着地时触发。除了玩家落地之外，沙子，铁砧，掉落的物品，点燃的TNT掉落地面时也会触发
OnKnockBackServerEvent	服务端	实体被击退时触发
ProjectileCritHitEvent	服务端	触发时机：当抛射物与头部碰撞时触发该事件。注：需调用OpenPlayerCritBox开启玩家爆头后才能触发。
ProjectileDoHitEffectEvent	服务端	触发时机：当抛射物碰撞时触发该事件
RefreshEffectServerEvent	服务端	触发时机：实体身上状态效果更新时触发，更新条件1、新增状态等级较高，更新状态等级及时间；2、新增状态等级不变，时间较长，更新状态持续时间
RemoveEffectServerEvent	服务端	触发时机：实体身上状态效果被移除时
SpawnProjectileServerEvent	服务端	触发时机：抛射物生成时触发
StartRidingClientEvent	客户端	触发时机：一个实体即将骑乘另外一个实体
StartRidingServerEvent	服务端	触发时机：一个实体即将骑乘另外一个实体
StepOnBlockClientEvent	客户端	触发时机：生物脚踩红石矿
StepOnBlockServerEvent	服务端	触发时机：生物脚踩压力板、踩红石矿、踩拌线钩。
WillAddEffectServerEvent	服务端	触发时机：实体即将获得状态效果前
WillTeleportToServerEvent	服务端	触发时机：一个实体即将传送/被传送前

玩家-索引[td]

事件		描述
AddExpEvent	服务端	触发时机：当玩家增加经验时触发该事件。
AddLevelEvent	服务端	触发时机：当玩家升级时触发该事件。
ChangeLevelUpCostServerEvent	服务端	触发时机：获取玩家下一个等级升级经验时，用于重载玩家的升级经验，每个等级在重置之前都只会触发一次
DimensionChangeClientEvent	客户端	玩家维度改变时客户端抛出
DimensionChangeFinishServerEvent	服务端	玩家维度改变完成后服务端抛出
DimensionChangeServerEvent	服务端	玩家维度改变时服务端抛出
ExtinguishFireClientEvent	客户端	玩家扑灭火焰时触发。下雨，倒水等方式熄灭火焰不会触发。
ExtinguishFireServerEvent	服务端	玩家扑灭火焰时触发。下雨，倒水等方式熄灭火焰不会触发。
GameTypeChangedClientEvent	客户端	个人游戏模式发生变化时客户端触发。
GameTypeChangedServerEvent	服务端	个人游戏模式发生变化时服务端触发。
OnPlayerHitBlockClientEvent	客户端	触发时机：通过OpenPlayerHitBlockDetection打开方块碰撞检测后，当玩家碰撞到方块时触发该事件。玩家着地时会触发OnGroundClientEvent，而不是该事件。客户端和服务端分别作碰撞检测，可能两个事件返回的结果略有差异。
OnPlayerHitBlockServerEvent	服务端	触发时机：通过OpenPlayerHitBlockDetection打开方块碰撞检测后，当玩家碰撞到方块时触发该事件。监听玩家着地请使用客户端的OnGroundClientEvent。客户端和服务端分别作碰撞检测，可能两个事件返回的略有差异。
OnPlayerHitMobClientEvent	客户端	触发时机：通过OpenPlayerHitMobDetection打开生物碰撞检测后，当有生物与玩家碰撞时触发该事件。注：客户端和服务端分别作碰撞检测，可能两个事件返回的结果略有差异。
OnPlayerHitMobServerEvent	服务端	触发时机：通过OpenPlayerHitMobDetection打开生物碰撞检测后，当有生物与玩家碰撞时触发该事件。注：客户端和服务端分别作碰撞检测，可能两个事件返回的略有差异。
PerspChangeClientEvent	客户端	视角切换时会触发的事件
PlayerAttackEntityEvent	服务端	触发时机：当玩家攻击时触发该事件。
PlayerDieEvent	服务端	触发时机：当玩家死亡时触发该事件。
PlayerEatFoodServerEvent	服务端	触发时机：玩家吃下食物时触发
PlayerHurtEvent	服务端	触发时机：当玩家受伤害前触发该事件。
PlayerInteractServerEvent	服务端	触发时机：玩家即将和某个实体交互
PlayerRespawnEvent	服务端	触发时机：玩家复活时触发该事件。
PlayerRespawnFinishServerEvent	服务端	触发时机：玩家复活完毕时触发
PlayerTeleportEvent	服务端	触发时机：当玩家传送时触发该事件，如：玩家使用末影珍珠或tp指令时。
ServerPlayerGetExperienceOrbEvent	服务端	触发时机：玩家获取经验球时触发的事件
StoreBuySuccServerEvent	服务端	触发时机:玩家游戏内购买商品时服务端抛出的事件

方块-索引[td]

事件		描述
BlockNeighborChangedServerEvent	服务端	触发时机：自定义方块周围的方块发生变化时，需要配置netease:neighborchanged_sendto_script，详情请查阅《自定义农作物》文档
BlockRandomTickServerEvent	服务端	触发时机：自定义方块配置netease:random_tick随机tick时
BlockRemoveServerEvent	服务端	触发时机：监听该事件的方块在销毁时触发，可以通过ListenOnBlockRemoveEvent方法进行监听，或者通过json组件netease:listen_block_remove进行配置
BlockStrengthChangedServerEvent	服务端	触发时机：自定义机械元件方块红石信号量发生变化时触发
ChestBlockTryPairWithServerEvent	服务端	触发时机：两个并排的小箱子方块准备组合为一个大箱子方块时
ClientBlockUseEvent	客户端	触发时机：玩家右键点击新版自定义方块（或者通过接口AddBlockItemListenForUseEvent增加监听的MC原生游戏方块）时客户端抛出该事件（该事件tick执行，需要注意效率问题）。
DestroyBlockEvent	服务端	触发时机：当方块已经被玩家破坏时触发该事件。
EntityPlaceBlockAfterServerEvent	服务端	触发时机：当生物成功放置方块后触发
HopperTryPullInServerEvent	服务端	触发时机：漏斗放在容器下方，放置成功时触发事件
HopperTryPullOutServerEvent	服务端	触发时机：漏斗放在容器旁边，放置成功时触发事件
PistonActionServerEvent	服务端	触发时机：活塞或者粘性活塞推送/缩回影响附近方块时
PlayerTryDestroyBlockClientEvent	客户端	当玩家试图破坏方块时，客户端线程触发该事件。主要用于床，旗帜，箱子这些根据方块实体数据进行渲染的方块，一般情况下请使用ServerPlayerTryDestroyBlockEvent
ServerBlockEntityTickEvent	服务端	触发时机：自定义方块配置了netease:block_entity组件并设tick为true，玩家进入该方块的tick范围时触发
ServerBlockUseEvent	服务端	触发时机：玩家右键点击新版自定义方块（或者通过接口AddBlockItemListenForUseEvent增加监听的MC原生游戏方块）时服务端抛出该事件（该事件tick执行，需要注意效率问题）。
ServerEntityTryPlaceBlockEvent	服务端	触发时机：当生物试图放置方块时触发该事件。
ServerPlaceBlockEntityEvent	服务端	触发时机：手动放置或通过接口创建含自定义方块实体的方块时触发，此时可向该方块实体中存放数据
ServerPlayerTryDestroyBlockEvent	服务端	当玩家即将破坏方块时，服务端线程触发该事件。
StartDestroyBlockClientEvent	客户端	玩家开始挖方块时触发。创造模式下不触发。
StartDestroyBlockServerEvent	服务端	玩家开始挖方块时触发。创造模式下不触发。

物品-索引[td]

事件		描述
ActorAcquiredItemClientEvent	客户端	触发时机：玩家获得物品时客户端抛出的事件（有些获取物品方式只会触发客户端事件，有些获取物品方式只会触发服务端事件，在使用时注意一点。）
ActorAcquiredItemServerEvent	服务端	触发时机：玩家获得物品时服务端抛出的事件（有些获取物品方式只会触发客户端事件，有些获取物品方式只会触发服务端事件，在使用时注意一点。）
ActorUseItemClientEvent	客户端	触发时机：玩家使用物品时客户端抛出的事件（比较特殊不走该事件的例子：1）喝牛奶；2）染料对有水的炼药锅使用；3）盔甲架装备盔甲）
ActorUseItemServerEvent	服务端	触发时机：玩家使用物品生效之前服务端抛出的事件（比较特殊不走该事件的例子：1）喝牛奶；2）染料对有水的炼药锅使用；3）盔甲架装备盔甲）
ClientItemTryUseEvent	客户端	玩家点击右键尝试使用物品时客户端抛出的事件，可以通过设置cancel为True取消使用物品
ClientItemUseOnEvent	客户端	玩家在对方块使用物品时客户端抛出的事件。注：如果需要取消物品的使用需要同时在ClientItemUseOnEvent和ServerItemUseOnEvent中将ret设置为True才能正确取消。
ClientShapedRecipeTriggeredEvent	客户端	玩家获取配方物品时触发
InventoryItemChangedClientEvent	客户端	玩家背包物品变化时客户端抛出的事件。
InventoryItemChangedServerEvent	服务端	玩家背包物品变化时服务端抛出的事件。
ItemReleaseUsingClientEvent	客户端	触发时机：释放正在使用的物品
ItemReleaseUsingServerEvent	服务端	触发时机：释放正在使用的物品时
ItemUseAfterServerEvent	服务端	玩家在使用物品之后服务端抛出的事件。
ItemUseOnAfterServerEvent	服务端	玩家在对方块使用物品之后服务端抛出的事件。
OnCarriedNewItemChangedClientEvent	客户端	手持物品发生变化时，触发该事件；数量改变不会通知
OnCarriedNewItemChangedServerEvent	服务端	触发时机：玩家切换主手物品时触发该事件
OnNewArmorExchangeServerEvent	服务端	触发时机：玩家切换盔甲时触发该事件
OnOffhandItemChangedServerEvent	服务端	触发时机：玩家切换副手物品时触发该事件
PlayerDropItemServerEvent	服务端	触发时机：玩家丢弃物品时触发
ServerItemTryUseEvent	服务端	玩家点击右键尝试使用物品时服务端抛出的事件
ServerItemUseOnEvent	服务端	玩家在对方块使用物品之前服务端抛出的事件。注：如果需要取消物品的使用需要同时在ClientItemUseOnEvent和ServerItemUseOnEvent中将ret设置为True才能正确取消。
ServerPlayerTryTouchEvent	服务端	触发时机：玩家触碰/捡起物品时触发
StartUsingItemClientEvent	客户端	玩家使用物品（目前仅支持Bucket、Trident、RangedWeapon、Medicine、Food、Potion、Crossbow、ChemistryStick）时抛出
StopUsingItemClientEvent	客户端	玩家停止使用物品（目前仅支持Bucket、Trident、RangedWeapon、Medicine、Food、Potion、Crossbow、ChemistryStick）时抛出

模型-索引[td]

事件		描述
AttackAnimBeginClientEvent	客户端	攻击动作开始时触发
AttackAnimBeginServerEvent	服务端	当攻击动作开始时触发
AttackAnimEndClientEvent	客户端	攻击动作结束时触发
AttackAnimEndServerEvent	服务端	当攻击动作结束时触发
JumpAnimBeginServerEvent	服务端	当跳跃动作开始时触发
WalkAnimBeginClientEvent	客户端	走路动作开始时触发
WalkAnimBeginServerEvent	服务端	当走路动作开始时触发
WalkAnimEndClientEvent	客户端	走路动作结束时触发
WalkAnimEndServerEvent	服务端	当走路动作结束时触发

UI-索引[td]

事件		描述
ClientChestCloseEvent	客户端	关闭箱子界面时触发，包括小箱子，合并后大箱子和末影龙箱子
ClientChestOpenEvent	客户端	打开箱子界面时触发，包括小箱子，合并后大箱子和末影龙箱子
ClientPlayerInventoryCloseEvent	客户端	关闭物品背包界面时触发
ClientPlayerInventoryOpenEvent	客户端	打开物品背包界面时触发
GridComponentSizeChangedClientEvent	客户端	触发时机：UI grid组件里格子数目发生变化时触发
OnItemSlotButtonClickedEvent	客户端	点击快捷栏和背包栏的物品槽时触发
PlayerChatButtonClickClientEvent	客户端	玩家点击聊天按钮或回车键触发呼出聊天窗口时客户端抛出的事件
PopScreenEvent	客户端	screen移除触发
PushScreenEvent	客户端	screen创建触发
UiInitFinished	客户端	UI初始化框架完成,此时可以创建UI

音效-索引[td]

事件		描述
OnMusicStopClientEvent	客户端	音乐停止时，当玩家调用StopCustomMusic来停止自定义背景音乐时，会触发该事件
PlayMusicClientEvent	客户端	播放背景音乐时触发
PlaySoundClientEvent	客户端	播放场景音效或UI音效时触发

控制-索引[td]

事件		描述
ClientJumpButtonPressDownEvent	客户端	跳跃按钮按下事件，返回值设置参数只对当次按下事件起作用
ClientJumpButtonReleaseEvent	客户端	跳跃按钮按下释放事件
GetEntityByCoordEvent	客户端	玩家点击屏幕时触发，多个手指点在屏幕上时，只有第一个会触发。
GetEntityByCoordReleaseClientEvent	客户端	玩家点击屏幕后松开时触发，多个手指点在屏幕上时，只有最后一个手指松开时触发。
HoldBeforeClientEvent	客户端	玩家长按屏幕，即将响应到游戏内时触发。仅在移动端或pc的F11模式下触发。pc的非F11模式可以使用RightClickBeforeClientEvent事件监听鼠标右键
LeftClickBeforeClientEvent	客户端	玩家按下鼠标左键时触发。仅在pc的普通控制模式（即非F11模式）下触发。
LeftClickReleaseClientEvent	客户端	玩家松开鼠标左键时触发。仅在pc的普通控制模式（即非F11模式）下触发。
OnClientPlayerStartMove	客户端	移动按钮按下触发事件
OnClientPlayerStopMove	客户端	移动按钮按下释放时触发事件
OnKeyPressInGame	客户端	按键按下时触发
RightClickBeforeClientEvent	客户端	玩家按下鼠标右键时触发。仅在pc下触发（普通控制模式及F11模式都会触发）。
RightClickReleaseClientEvent	客户端	玩家松开鼠标右键时触发。仅在pc的普通控制模式（即非F11模式）下触发。在F11下右键，按下会触发RightClickBeforeClientEvent，松开时会触发TapOrHoldReleaseClientEvent
TapBeforeClientEvent	客户端	玩家点击屏幕并松手，即将响应到游戏内时触发。仅在移动端或pc的F11模式下触发。pc的非F11模式可以使用LeftClickBeforeClientEvent事件监听鼠标左键
TapOrHoldReleaseClientEvent	客户端	玩家点击屏幕后松手时触发。仅在移动端或pc的F11模式下触发。pc的非F11模式可以使用LeftClickReleaseClientEvent与RightClickReleaseClientEvent事件监听鼠标松开

枚举值索引

枚举值模块可以使用GetMinecraftEnum接口来获取

[td]

枚举值	描述
ActorDamageCause	描述实体伤害来源枚举值，及实体被伤害的原因。
ArmorSlotType	描述盔甲槽位枚举值
AttrType	实体属性类型枚举
AttributeBuffType	Buff状态类型枚举值
BiomeType	生物群系枚举
BlockType	方块类型枚举值，仅用于音效播放，其余情况请使用字符串类型的identifier
ButtonEventType	按钮事件枚举值
ButtonState	按钮状态枚举值
Change	刷怪设置参数枚举，用于SpawnCustomModule
ColorCode	样式代码(opens new window)
EffectType	描述特效类型的枚举值
EnchantType	附魔类型枚举值
EntityConst	描述实体类型枚举值，主要用于API文档中的CreateEntity功能
EntityTeleportCause	传送理由枚举
EntityType	生物类型枚举
Facing	朝向枚举值
GameDiffculty	描述游戏难度的枚举值
GameType	描述游戏类型的枚举值
ItemAcquisitionMethod	获得物品的方法枚举值
ItemColor	物品的颜色枚举值
ItemPosType	描述玩家物品位置
ItemUseMethodEnum	使用物品的方法枚举值
KeyBoardType	描述PC端点击键盘输入的按钮枚举值
OptionId	可设置的枚举值
StructureFeatureType	原版结构特征类型的枚举
SysSoundType	系统音效类型枚举
TimeEaseType	时间变化类型
TouchEvent	触摸回调事件枚举值
UiBaseLayer	自定义UI界面的层次宏定义，用于在多个插件之间协调UI界面的遮挡关系
UseAnimation	使用物品时动画枚举值
VirtualWorldObjectType	虚拟世界对象类型

[资源] 开发者技术手册

开发者认证勋章