请选择 进入手机版 | 继续访问电脑版
查看: 1628|回复: 0

[资源] 开发者技术手册

[复制链接]

92

主题

145

回帖

157

积分

Lv.4 怪物猎人

UID
8156876
小麦
2
金锭
503
下界之星
0

开发者认证勋章

发表于 2021-3-17 15:07:11 | 显示全部楼层 |阅读模式 IP:广东
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分别为GetEngineNamespaceGetEngineSystemName。与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浏览器。
StartRecordEventApollo开始启动服务端与客户端之间的脚本事件收发统计,启动后调用StopRecordEvent即可获取两个函数调用之间脚本事件收发的统计信息,仅支持租赁服与Apollo网络服环境(不支持单机环境)
StartRecordPacketApollo开始启动服务端与客户端之间的引擎收发包统计,启动后调用StopRecordPacket即可获取两个函数调用之间引擎收发包的统计信息,仅支持租赁服与Apollo网络服环境(不支持单机环境)
StopMultiProfile服务端停止双端脚本性能分析并生成火焰图,与StartMultiProfile配合使用,此接口只支持PC端
StopMultiProfile客户端停止双端脚本性能分析并生成火焰图,与StartMultiProfile配合使用,此接口只支持PC端
StopProfile服务端停止服务端脚本性能分析并生成火焰图,与StartProfile配合使用,此接口只支持PC端
StopProfile客户端停止客户端脚本性能分析并生成火焰图,与StartProfile配合使用,此接口只支持PC端
StopRecordEventApollo停止服务端与客户端之间的脚本事件收发统计并输出结果,与StartRecordEvent配合使用,输出结果为字典,key为网络包名,value字典中记录收发信息,具体见示例,仅支持租赁服与Apollo网络服环境(不支持单机环境)
StopRecordPacketApollo停止服务端与客户端之间的引擎收发包统计并输出结果,与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服务端设置是否禁用藤曼蔓延生长
ForbidLiquidFlowApollo禁止/允许地图中的流体流动
GetBannedItemList服务端获取禁用物品列表
GetGameDiffculty服务端获取游戏难度
GetGameRulesInfoServer服务端获取游戏规则
GetGameType服务端获取游戏类型
GetLevelGravity服务端获取重力因子
IsLockDifficulty服务端获取当前世界的游戏难度是否被锁定
LockDifficulty服务端锁定当前世界游戏难度(仅本次游戏有效),锁定后任何玩家在游戏内都无法通过指令或暂停菜单修改游戏难度
OpenCityProtectApollo开启城市保护,包括禁止破坏方块,禁止对方块使用物品,禁止怪物攻击玩家,禁止玩家之间互相攻击,禁止日夜切换,禁止天气变化,禁止怪物群落刷新
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实体属性类型枚举
AttributeBuffTypeBuff状态类型枚举值
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虚拟世界对象类型
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

返回顶部