我的世界创造者计划 -《我的世界》中国版

《我的世界》中国版技术服务接口列表

2024-08-01

技术服务费与免费细项

【付费使用】

  (注:已包含在技术服务费中)

  使用ModSDK编写代码

  使用MCS编辑、测试和发布作品

  使用Apollo&Java工具建立网络服

【免费提供】

  (注:指网易对这部分服务对应的费用进行了优惠性免除,不代表其不产生成本和费用)

  使用开发者平台发布作品

  向网易提供的技术支持人员征询解决开发问题

【部分免费】

  使用网易提供的服务器运行游戏代码

  以后续官方公告和活动说明为准

中国版技术服务接口列表

Apollo  技术服务接口

接口 描述
MasterConnectStatusEvent master成功连接到当前服务器事件
MasterForceShutDownEvent 不建议开发者使用,强制关闭当前服务器时会触发本事件
MasterGraceShutDownEvent 不建议开发者使用,优雅关闭当前服务器时会触发本事件
ServerWillShutDownEvent 不建议开发者使用,游戏即将强制关闭触发本事件。事件回调函数需要好清理和存档工作,同时终止或强制join所有异步线程
ServiceConnectEvent service与lobby/game的成功建立连接事件
ServiceDisconnectEvent service与lobby/game断开连接事件
ServiceRegisterModuleEvent 不建议开发者使用,service向lobby/game注册module
ReloadCommonConfigEvent 不建议开发者使用,公共配置发生变化时触发本事件,注意只有与本服相关配置发生变化时才会触发本事件,比如日志等级
MasterResponseTransferFailServerEvent 转服失败事件,当玩家试图转服时,没有符合条件的目标服务器时抛出此事件
MasterResponseTransferSucServerEvent 转服成功事件,当玩家试图转服时,成功定位到可转服的目标服务器时抛出此事件
ServerGetPlayerLockEvent 玩家登录到lobby/game过程中,获取玩家在线锁事件。事件触发时,玩家还处于开始登录阶段,
    还没有下载行为包,且没有在地图中出生。在线锁实质是redis中记录的玩家在线信息,redis key格式
    是“user:online: + netease uid”,它是个hash表,包含两个hash key:serverid,proxyid
ServerPlayerBornPosEvent 创建玩家对象过程中,设置玩家出生位置时触发本事件
ServerReleasePlayerLockEvent 玩家下线过程中,释放在redis中的玩家在线锁事件。事件触发时,客户端同服务端断开了连接,玩
    家数据已经保存到地图,玩家已经不存在于mc的世界中。在线锁实质是redis中记录的玩家在线信息,
    redis key格式是“user:online: + netease uid”,它是个hash表,包含两个hash key:serverid,proxyid
ServerReleasePlayerLockOnShutDownEvent 不建议开发者使用,游戏强制关闭过程中,玩家强制下线时触发本事件。事件回调函数需要释放在redis中的玩家的在线锁
StoreBuySuccServerEvent 玩家游戏内购买商品时服务端抛出的事件
ResetGamesBeginEvent 开始重置lobby/game事件。
ResetGamesEndEvent 重置lobby/game结束事件。
RollingCloseServersEndEvent 使用RollingCloseServersEndEvent滚动关服结束事件。
RollingUpdateServersEndEvent 使用RollingUpdateServers滚动更新服务器结束事件。
ServerConnectedEvent lobby/game/proxy成功建立连接时触发
ServerDisconnectEvent lobby/game/proxy断开连接时触发
NetGameCommonConfChangeEvent 公共配置发生变化时触发,具体包括:新增或删服服务器;服务器相关配置变化;日志等级发生变化
PlayerLoginServerEvent 玩家开始登陆事件,此时master开始给玩家分配lobby/game,可以区分玩家是登录还是切服
PlayerLogoutServerEvent 玩家登出时触发,玩家在lobby/game下载行为包的过程中退出也会触发该事件,可以以区分玩家是登出还是切服
PlayerTransferServerEvent 玩家开始切服事件,此时master开始为玩家准备服务器,玩家还没切服完毕,后续可能切服失败
UpdateServerStatusEvent lobby/game/proxy状态发生变化时触发
GetCommonConfig 获取服务器公共配置,包括所有服务器和db的配置
GetGameTypeByServerId 获取指定ID服务器的类型
GetServerIdsByGameType 获取指定类型的服务器id列表
GetServerLoadedModsById 根据服务器id获取服务器加载mod列表
GetServerLoadedModsByType 根据服务器类型获取服务器加载mod列表。若同种类型服务器配置了不同的mod,则返回其中一个对应mod列表。
IsService 服务器是否是service服
BanUser 封禁某个玩家
GetBanUserInfo 获取玩家的封禁信息
GetOnlineUidList 获取所有在线玩家的uid列表
GetProtocolVersionByUID 获取在线玩家客户端协议版本号。多协议版本引擎中(比如同时支持1.14客户端和1.15客户端),需要把客户端分配到相同协议版本的lobby/game中
GetServerIdByUid 获取在线玩家所在的服务器的ID,返回的信息为当前控制服内存缓存中的信息,玩家很可能很快就离线或者转服
GetUserSilentInfo 获取玩家的禁言信息
SetLoginStratege 设置玩家登陆选服策略,要求服务器启动后加载mod时候设置
SilentByUID 禁言某个玩家
UnBanUser 解除某个玩家的封禁
UnSilentByUID 解除某个玩家的禁言
RegisterMasterHttp 注册一个新的HTTP接口
SendHttpRequestToService 给service发送http请求
SendHttpResponse 发送HTTP的Response,支持异步返回,返回时候指定请求传入的clientId
GetAllResetingServers 获取所有重置中服务器的id列表
GetAllServersOnlineNum 获取所有服务器的在线人数
GetConnectedLobbyAndGameIds 获取所有已经连接的lobby/game的服务器id列表
GetOneServerStatus 获取服务器状态。只有状态2表示服务器正常服务,其他状态表示服务器不能服务
GetOnlineNumByServerId 获取服务器(lobby/game/proxy)的在线人数
GetOnlineNumByServerType 获取某类型服务器的在线人数
GetServerProtocolVersion 获取服务器的协议版本号。多协议版本引擎中(比如同时支持1.14客户端和1.15客户端),需要把客户端分配到相同协议版本的lobby/game中
GetTotalOnlineNum 获取总得在线人数
IsConnectedServer master是否与lobby/game/proxy建立连接
IsValidServer 服务器是否有效。一种用途:master将玩家分配到服务器之前,会检查服务器是否有效,避免把玩家分配到一个即将关闭的服务器中
ResetServer 重置某个lobby/game。它会将服务器地图恢复到启动时状态并重启服务器。开始重置会触发ResetGamesBeginEvent事件,重置结束会触发ResetGamesEndEvent事件
StopServerByServerid 关闭某个服务器。若MCStudio配置网络游戏时设置了“崩溃自动拉起”,则关闭服务器后会被自动拉起,实现重启功能
GetServerId 获取服务器id,服务器id对应公共配置中serverid
GetServiceConfig 获取service配置,该配置对应公共配置中servicelist下对应service的配置
StartRecordEvent 开始启动大厅服/游戏服与功能服之间的脚本事件收发包统计
StopRecordEvent 停止大厅服/游戏服与功能服之间的脚本事件收发包统计并输出结果
RegisterOpCommand 注册一个新的HTTP接口
ResponseOpCommandFail 发送HTTP的失败Response,支持异步返回,返回时候指定请求传入的clientId
ResponseOpCommandSuccess 发送HTTP的成功Response,支持异步返回,返回时候指定请求传入的clientId
UnRegisterOpCommand 注销一个已注册的HTTP接口
RegisterServiceHttp 注册一个新的HTTP接口
SendHttpRequestToMaster 给master发送http请求
GetServerIdsByServerType 根据类型获取服务器id列表
GetServerType 获取服务器类型
GetServersStatus 获取所有lobby/game服务器的状态。只有状态1表示服务器正常服务,其他状态表示服务器不能对外服务
GetMongoConfig 获取mongo数据库的连接参数,对应公共配置中mongo配置
GetMysqlConfig 获取mysql数据库的连接参数,对应公共配置中mysql配置
GetRedisConfig 获取redis数据库的连接参数,对应公共配置中redis配置
DelForbidDragonEggTeleportField 删除禁止龙蛋传送的地图区域
DelForbidFlowField 删除地图区域,不同的ID的区域边界会阻挡流体的流动
SetEnableLimitArea 设置地图最大区域,超过区域的地形不再生成
SetForbidDragonEggTeleportField 设置禁止龙蛋传送的地图区域
SetForbidFlowField 设置地图区域,不同的ID的区域边界会阻挡流体的流动
SetLevelGameType 强制设置游戏的玩法模式
SetShowFakeSeed 在客户端【设置】中,显示虚假的游戏地图种子
StopShowFakeSeed 在客户端【设置】中,显示真实的游戏地图种子
GetConnectingProxyIdOfPlayer 获取玩家客户端连接的proxy服务器id
GetPlatformUid 获取玩家登录端的uid,假如玩家从手机端登录,返回手机端的uid,否则返回PC端的uid
GetPlayerIdByUid 根据玩家uid获取玩家ID(也即playerId)。若玩家不在这个lobby/game,则返回为空字符
GetPlayerIpHash 获取玩家客户端ip的特征哈希值
GetPlayerLockResult 不建议开发者使用,把获取玩家在线锁结果告知给引擎层
GetPlayerNickname 获取玩家的昵称。
GetPlayerUid 获取玩家的uid
GetUidIsSilent 根据玩家uid获取是否被禁言
HidePlayerFootprint 隐藏某个玩家的会员脚印外观
HidePlayerMagicCircle 隐藏某个玩家的会员法阵外观
IsPlayerPeUser 获取玩家是否从手机端登录
ReleasePlayerLockResult 不建议开发者使用,把释放玩家在线锁结果告知给引擎层
SetAutoRespawn 设置是否启用自动重生逻辑
ShieldPlayerJoinText 是否屏蔽客户端左上角 “xxx 加入了游戏”的提示
TryToKickoutPlayer 把玩家踢下线,message中的文字会显示在客户端的断线提示中
NotifyClientToOpenShopUi 通知客户端打开商城界面
SetGracefulShutdownOk 不建议开发者使用,设置脚本层的优雅关机逻辑已经执行完毕,引擎可以开始优雅关机了
SetShutdownOk 不建议开发者使用,设置脚本层的强制关机逻辑已经执行完毕,引擎可以开始强制关机了
AddGetPlayerLockTask 添加获取玩家在线锁时的处理任务,会在玩家刚连接到服务端时执行,在所有任务都完成后,才会继续玩家的登录流程
CheckMasterExist 检查服务器是否与master建立连接
GetLastFrameTime 获取服务端脚本上一帧运行时间
GetOnlinePlayerNum 获取当前服务器的在线人数
IsServiceConnected 检查服务器是否与某个service建立连接
IsShowDebugLog 当前服务器是否打印debug等级的日志
TransferToOtherServer 玩家转移到指定类型的服务器,假如同类服务器有多个,就根据负载均衡选择一个
TransferToOtherServerById 玩家迁移到指定服务器id的服务器
SetCityMode 设置游戏为主城模式:包括有无法改变地形,不切换日夜,不改变天气,不刷新生物等限制
EnableNetgamePacketIdStatistics 开启(或关闭)玩家向服务器发包的数量统计。长时间不使用数据时请关掉统计,避免内存泄露。
GetAndClearNetgamePacketIdStatistics 获取玩家向服务器发包的数量统计,然后重置统计数据。即每次返回从上一次获取到现在的数量。需要用EnableNetgamePacketIdStatistics开启后才有数据
StartChunkProfile 开始启动服务端区块读写性能统计
ChangeAllPerformanceSwitch 整体关闭/打开预定义的游戏原生逻辑
ChangePerformanceSwitch 关闭/打开某个游戏原生逻辑
EmitOrder 添加一个异步任务
Finish 等待线程池退出,线程池会执行完所有异步任务后退出,会阻塞主线程。建议Mod退出时执行
ForkNewPool 创建线程池,设置线程池大小
AsyncExecuteWithOrderKey 添加一个异步mysql任务,执行所有mysql操作
AsyncExecutemanyWithOrderKey 添加一个异步mysql任务,针对同一条sql语句,使用paramsList中的每个参数各执行一次,并且返回成功修改/新建的记录数,其中任何一条语句执行失败,最终所有语句都会被执行失败,返回None
AsyncInsertOneWithOrderKey 添加一个异步mysql任务,向主键为AUTO INCREASEl类型的表格中插入一条记录,并且返回新建记录的主键
AsyncQueryWithOrderKey 添加一个异步mysql任务,执行mysql查询
InitDB 初始化myqsl连接池,要求在MCStudio的“服务器配置”中配置mysql
SyncFetchAll 阻塞性执行sql语句,查询数据
SyncInsert 阻塞性执行sql语句,插入数据
AsyncDelete 执行redis操作,删除某个redis key,相当于redis中执行命令:del key
AsyncFuncWithKey 添加一个异步redis任务
AsyncGet 执行redis操作,获取key的value,相当于redis中执行命令:get key
AsyncHgetall 执行redis操作,获取key的value,相当于redis中执行命令:hgetall key
AsyncMget 执行redis操作,获取多个key的值,相当于redis中执行命令:mget key1 key2 ...
AsyncSet 执行redis操作,设置key的值为value,相当于redis中执行命令:set key value
AsyncExecute 添加一个异步mongo任务
NotifyToClient game/lobby接口,game/lobby发送事件到指定客户端
NotifyToServer 客户端接口,给lobby/game服务器发送事件。注意,玩家只能存在于一个game或lobby,不可能同时存在于两个服务器
NotifyToMaster lobby/game接口,lobby/game给master发事件。
NotifyToServerNode master接口,master给某个lobby/game发事件
BroadcastToService master接口,master给所有service广播消息。
NotifyToServiceNode master接口,master给某个service发消息。
RegisterRpcMethod service/master接口,用于监听service/master发过来请求,通常用于官方插件开发
RegisterRpcMethodForMod service接口,监听service/master发过来的请求。
RequestToService service/master接口,给service/master发请求,通常用于官方插件开发
RequestToServiceMod master接口,给service发请求。
ResponseToServer service/master接口,给service/master返回一个消息。
BroadcastToServerByType service接口,service给某种类型服务器广播消息
RemoteNotifyToClient service接口,service发送事件到指定客户端

Mod-SDK  技术服务接口

接口 描述
CreateComponent 给实体创建服务端组件
DestroyComponent 删除实体的服务端组件
GetComponent 获取实体的服务端组件。一般用来判断某个组件是否创建过,其他情况请使用CreateComponent
GetComponentCls 用于获取服务器component基类。实现新的component时,需要继承该接口返回的类
GetEngineCompFactory 获取引擎组件的工厂,通过工厂可以创建服务端的引擎组件
RegisterComponent 用于将组件注册到引擎中
GetClientSystemCls 用于获取客户端system基类。实现新的system时,需要继承该接口返回的类
GetServerSystemCls 用于获取服务器system基类。实现新的system时,需要继承该接口返回的类
GetSystem 获取已注册的系统
RegisterSystem 用于将系统注册到引擎中,引擎会创建一个该系统的实例,并在退出游戏时回收。系统可以执行我们引擎赋予的基本逻辑,例如监听事件、执行Tick函数、与客户端进行通讯等。
BroadcastEvent 本地广播事件,客户端system广播的事件仅客户端system能监听,服务器system广播的事件仅服务端system能监听。
BroadcastToAllClient 服务器广播事件到所有客户端
CreateEventData 创建自定义事件的数据,eventData用于发送事件。创建的eventData可以理解为一个dict,可以嵌套赋值dict,list和基本数据类型,但不支持tuple
GetEngineNamespace 获取引擎事件的命名空间。监听引擎事件时,namespace传该接口返回的namespace
GetEngineSystemName 获取引擎系统名。监听引擎事件时,systemName传该接口返回的systemName
ListenForEvent 注册监听某个系统抛出的事件。若监听引擎事件时,namespace和systemName分别为GetEngineNamespace()和GetEngineSystemName()。具体每个事件的详细事件data可以参考"事件"分类下的内容
NotifyToClient 服务器发送事件到指定客户端
NotifyToMultiClients 服务器发送事件到指定一批客户端,相比于在for循环内使用NotifyToClient性能更好
NotifyToServer 客户端发送事件到服务器
UnListenAllEvents 反注册监听某个系统抛出的所有事件,即不再监听。
UnListenForEvent 反注册监听某个系统抛出的事件,即不再监听。若是引擎事件,则namespace和systemName分别为[GetEngineNamespace](通用/事件.md#getenginenamespace)和[GetEngineSystemName](通用/事件.md#getenginesystemname)。与ListenForEvent对应。
GetIP 获取本地玩家的ip地址
GetPlatform 获取脚本运行的平台
IsInApollo 返回当前游戏Mod是否运行在Apollo网络服
IsInServer 获取当前游戏是否跑在服务器环境下
GetConfigData 获取本地配置文件中存储的数据
SetConfigData 以本地配置文件的方式存储数据
GetDirFromRot 通过旋转角度获取朝向
GetLocalPosFromWorld 获取基于实体的世界坐标对应的局部坐标
GetRotFromDir 通过朝向获取旋转角度
GetWorldPosFromLocal 获取基于实体的局部坐标对应的世界坐标
AddRepeatedTimer 添加服务端触发的定时器,重复执行
AddTimer 添加服务端触发的定时器,非重复
CancelTimer 取消定时器
CheckNameValid 检查昵称是否合法,即不包含敏感词
CheckWordsValid 检查语句是否合法,即不包含敏感词
GetChinese 获取langStr对应的中文,可参考PC开发包中\handheld\localization\handheld\data\resource_packs\vanilla
GetFps 获取fps
GetMinecraftEnum 用于获取[枚举值文档](通用/../../枚举值/索引.md)中的枚举值
GetModConfigJson 以字典形式返回指定路径的json格式配置文件的内容,文件必须放置在资源包的/modconfigs目录下
GetServerTickTime 获取服务端引擎上一帧的帧消耗时间
ImportModule 使用字符串路径导入模块,作用与importlib.import_module类似,但只能导入当前加载的mod中的模块
StartCoroutine 开启服务端协程,实现函数分段式执行,可用于缓解复杂逻辑计算导致游戏卡顿问题
StopCoroutine 停止协程
GetEnableReconnectNetgame 获取是否允许断线重连
GetKeepResourceWhenTransfer 获取快速切服设置
GetMcpModLogCanPostDump 获取是否可以打印错误信息到McpModLog日志。
GetResourceFastload 获取资源快速加载设置
PostMcpModDump 主动打印信息到McpModLog日志,需要先调用 SetMcpModLogCanPostDump 接口进行设置,才能生效。
ReloadAllMaterials 重新加载所有材质文件
ReloadAllShaders 重新加载所有Shader文件
ReloadOneShader 重新加载某个Shader文件
SetEnableReconnectNetgame 设置是否允许断线重连
SetKeepResourceWhenTransfer 设置快速切服
SetMcpModLogCanPostDump 设置是否可以打印错误信息到McpModLog日志。
SetResourceFastload 设置资源快速加载
StartMemProfile 开始启动服务端脚本内存分析,启动后调用[StopMemProfile](通用/调试.md#stopMemProfile)即可在路径fileName生成函数内存火焰图,此接口只支持PC端。生成的火焰图可以用浏览器打开,推荐chrome浏览器。
StartMultiProfile 开始启动服务端与客户端双端脚本性能分析,启动后调用[StopMultiProfile](通用/调试.md#stopmultiprofile)即可在路径fileName生成函数性能火焰图。双端采集时数据误差较大,建议优先使用[StartProfile](通用/调试.md#startprofile)单端版本,此接口只支持PC端
StartProfile 开始启动服务端脚本性能分析,启动后调用[StopProfile](通用/调试.md#stopprofile)即可在路径fileName生成函数性能火焰图,此接口只支持PC端。生成的火焰图可以用浏览器打开,推荐chrome浏览器。
StartRecordEvent 开始启动服务端与客户端之间的脚本事件收发统计,启动后调用[StopRecordEvent](通用/调试.md#stoprecordevent)即可获取两个函数调用之间脚本事件收发的统计信息,仅支持租赁服与Apollo网络服环境(不支持单机环境)
StartRecordPacket 开始启动服务端与客户端之间的引擎收发包统计,启动后调用[StopRecordPacket](通用/调试.md#stoprecordpacket)即可获取两个函数调用之间引擎收发包的统计信息,仅支持租赁服与Apollo网络服环境(不支持单机环境)
StopMemProfile 停止服务端脚本内存分析并生成火焰图,与[StartMemProfile](通用/调试.md#startMemProfile)配合使用,此接口只支持PC端
StopMultiProfile 停止双端脚本性能分析并生成火焰图,与[StartMultiProfile](通用/调试.md#startmultiprofile)配合使用,此接口只支持PC端
StopProfile 停止服务端脚本性能分析并生成火焰图,与[StartProfile](通用/调试.md#startprofile)配合使用,此接口只支持PC端
StopRecordEvent 停止服务端与客户端之间的脚本事件收发统计并输出结果,与[StartRecordEvent](通用/调试.md#startrecordevent)配合使用,输出结果为字典,key为网络包名,value字典中记录收发信息,具体见示例,仅支持租赁服与Apollo网络服环境(不支持单机环境)
StopRecordPacket 停止服务端与客户端之间的引擎收发包统计并输出结果,与[StartRecordPacket](通用/调试.md#startrecordpacket)配合使用,输出结果为字典,key为网络包名,value字典中记录收发信息,具体见示例,仅支持租赁服与Apollo网络服环境(不支持单机环境)
SetGyroSensorReportRate 设置陀螺仪传感器(上报/触发)频率
ToggleGyroSensor 开启或关闭陀螺仪传感器采集
CanSee 判断起始对象是否可看见目标对象,基于对象的Head位置判断
CheckBlockToPos 判断位置之间是否有方块
CheckChunkState 判断指定位置的chunk是否加载完成
CreateDimension 创建新的dimension
CreateExplosion 用于生成爆炸
DeleteAllArea 删除所有常加载区域
DeleteArea 删除一个常加载区域
DetectStructure 检测自定义门的结构
DoTaskOnChunkAsync 异步加载指定范围区块,加载完成后调用输入的回调函数。
GetAllAreaKeys 获取所有常加载区域名称列表
GetBiomeName 获取某一位置所属的生物群系信息
GetBlockLightLevel 获取方块位置的光照等级
GetChunkEntites 获取指定位置的区块中,全部的实体和玩家的ID列表
GetChunkMaxPos 获取某区块最大点的坐标
GetChunkMinPos 获取某区块最小点的坐标
GetChunkMobNum 获取某区块中的生物数量(不包括玩家,但包括盔甲架)
GetChunkPosFromBlockPos 通过方块坐标获得该方块所在区块坐标
GetCurrentDimension 获取客户端当前维度
GetEntitiesAround 获取区域内的entity列表
GetEntitiesAroundByType 获取区域内的某类型的entity列表
GetEntitiesInSquareArea 获取区域内的entity列表
GetLevelId 获取levelId。某些组件需要levelId创建,可以用此接口获取levelId。其中level即为当前地图的游戏。
GetLoadedChunks 获取指定维度当前已经加载完毕的全部区块的坐标列表
GetSpawnDimension 获取世界出生维度
GetSpawnPosition 获取世界出生点坐标
GetStructureSize 获取结构体的长宽高
IsChunkGenerated 获取某个区块是否生成过。
IsSlimeChunk 获取某个区块是否是史莱姆区块。
LocateNeteaseFeatureRule 与[/locate指令](https://minecraft-zh.gamepedia.com/%E5%91%BD%E4%BB%A4/locate)相似,用于定位<a href="../../../mcguide/20-玩法开发/15-自定义游戏内容/4-自定义维度/4-自定义特征.html#特征规则(feature-rules)">网易自定义特征规则</a>
LocateStructureFeature 与[/locate指令](https://minecraft-zh.gamepedia.com/%E5%91%BD%E4%BB%A4/locate)相似,用于定位原版的部分结构,如海底神殿、末地城等。
MayPlace 判断方块是否可以放置
MayPlaceOn 判断物品是否可以放到指定的位置上
MirrorDimension 复制不同dimension的地形
OpenClientChunkGeneration 开启/关闭客户端区块生成功能,需要在LoadServerAddonScriptsAfter事件触发时调用。开启客户端区块生成功能时,如果使用了netease:structure_feature或修改了大部分地图,会导致客户端和服务端地图不一致的问题。此时可以通过关闭客户端区块生成功能解决该问题。
PlaceFeature 放置特征,与[/placefeature指令](https://minecraft.fandom.com/zh/wiki/%E5%91%BD%E4%BB%A4/placefeature)相似
PlaceNeteaseLargeFeature 放置<a href="../../../mcguide/20-玩法开发/15-自定义游戏内容/4-自定义维度/6-自定义大型特征.html#自定义大型特征">网易版大型结构特征</a>
PlaceStructure 放置结构
SetAddArea 设置区块的常加载
SetMergeSpawnItemRadius 设置新生成的物品是否合堆
SetSpawnDimensionAndPosition 设置世界出生点维度与坐标
UpgradeMapDimensionVersion 提升指定地图维度的版本号,版本号不符的维度,地图存档信息将被废弃。使用后存档的地图版本均会同步提升至最新版本,假如希望使用此接口清理指定维度的地图存档,需要在保证该维度区块都没有被加载时调用。
CreateEngineEntityByTypeStr 创建指定identifier的实体
CreateEngineItemEntity 用于创建物品实体(即掉落物),返回物品实体的entityId
CreateEntityAOI 注册感应区域,有实体进入时和离开时会触发回调函数func
CreateExperienceOrb 创建专属经验球
CreateProjectileEntity 创建抛射物(直接发射)
DeleteEntityAOI 删除使用[CreateEntityAOI](世界/实体管理.md#createentityaoi)注册的感应区
DestroyEntity 销毁实体
GetDroppedItem 获取掉落物的物品信息
GetEngineActor 获取所有维度中已加载的所有实体(不包含玩家)。
GetLocalPlayerId 获取本地玩家的id
GetLootItems 指定战利品表获取一次战利品,返回的物品与json定义的概率有关
GetPlayerList 获取所有维度中的全部玩家的id列表
HasEntity 判断 entity 是否存在
IsEntityAlive 判断生物实体是否存活或非生物实体是否存在
KillEntity 杀死某个Entity
SpawnItemToLevel 生成物品掉落物,如果需要获取物品的entityId,可以调用服务端系统接口CreateEngineItemEntity
SpawnLootTable 使用生物类型模拟一次随机掉落,生成的物品与json定义的概率有关
SpawnLootTableWithActor 使用生物实例模拟一次随机掉落,生成的物品与json定义的概率有关
SpawnResources 产生方块随机掉落(该方法不适用于实体方块)
SpawnResourcesSilkTouched 模拟方块精准采集掉落
getEntitiesOrBlockFromRay 从指定位置发射一条射线,获取与射线相交的实体和方块
GetBlock 获取某一位置的block
GetBlockClip 获取某一位置方块当前<a href="../../../mcguide/20-玩法开发/15-自定义游戏内容/2-自定义方块/1-JSON组件.html#netease-aabb">clip的aabb</a>
GetBlockCollision 获取某一位置方块当前collision的aabb
GetBlockNew 获取某一位置的block
GetDestroyTotalTime 获取使用物品破坏方块需要的时间
GetLiquidBlock 获取某个位置的方块所含流体的信息
GetTopBlockHeight 获取某一位置最高的非空气方块的高度
SetBlockNew 设置某一位置的方块
SetJigsawBlock 在某一位置放置拼图方块
SetLiquidBlock 设置某一位置的方块的extraBlock,可在此设置方块含水等
SetSnowBlock 设置某一位置的方块含雪
GetEntityLimit 获取世界最大可生成实体数量上限。可生成实体的含义见[SetEntityLimit](世界/生物生成.md#setentitylimit)
SetEntityLimit 设置世界最大可生成实体数量上限。可生成实体指具有spawnrule的实体。当前世界上被加载的可生成实体数量超过这个上限时,生物就不会再通过spawnrule刷出。
SpawnCustomModule 设置自定义刷怪
AddBrewingRecipes 添加酿造台配方的接口
AddRecipe 动态注册配方,支持配方类型详见<a href="../../../mcguide/20-玩法开发/15-自定义游戏内容/5-自定义配方.html#配方类型说明">[配方类型说明]</a>
GetRecipeResult 根据配方id获取配方结果。仅支持合成配方
GetRecipesByInput 通过输入物品查询配方
GetRecipesByResult 通过输出物品查询配方所需要的输入材料
RemoveRecipe 动态禁用配方
CreateMicroBlockResStr 生成微缩方块资源Json字符串
GetBlankBlockPalette 获取一个空白的方块调色板。
GetBlockPaletteBetweenPos 根据输入的两个方块位置创建并获取一个方块调色板,方块调色板用于描述和记录世界中的多个方块的组合。这个方块调色板包含了这两个位置之间的所有方块及其相对位置。
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 获取当前世界时间
GetUseLocalTime 获取某个维度是否设置了使用局部时间规则
SetLocalDoDayNightCycle 设置使用局部时间规则的维度是否打开昼夜更替
SetLocalTime 设置使用局部时间规则维度的时间
SetLocalTimeOfDay 设置使用局部时间规则维度在一天内所在的时间
SetTime 设置当前世界时间
SetTimeOfDay 设置当前世界在一天内所在的时间
SetUseLocalTime 让某个维度拥有自己的局部时间规则,开启后该维度可以拥有与其他维度不同的时间与是否昼夜更替的规则
GetDimensionLocalWeatherInfo 获取独立维度天气信息(必须先使用SetDimensionUseLocalWeather接口设置此维度拥有自己的独立天气)
GetDimensionUseLocalWeather 获取某个维度是否拥有自己的天气规则
IsRaining 获取是否下雨
IsThunder 获取是否打雷
SetDimensionLocalDoWeatherCycle 设置某个维度是否开启天气循环(必须先使用SetDimensionUseLocalWeather接口设置此维度拥有自己的独立天气)
SetDimensionLocalRain 设置某个维度下雨(必须先使用SetDimensionUseLocalWeather接口设置此维度拥有自己的独立天气)
SetDimensionLocalThunder 设置某个维度打雷(必须先使用SetDimensionUseLocalWeather接口设置此维度拥有自己的独立天气)
SetDimensionUseLocalWeather 设置某个维度拥有自己的天气规则,开启后该维度可以拥有与其他维度不同的天气和天气更替的规则
SetRaining 设置是否下雨
SetThunder 设置是否打雷
AddBannedItem 增加禁用物品
AddBlockProtectField 设置一个方块无法被玩家/实体破坏的区域
CleanBlockProtectField 取消全部已设置的方块无法被玩家/实体破坏的区域
ClearBannedItems 清空禁用物品
DisableVineBlockSpread 设置是否禁用藤曼蔓延生长
ForbidLiquidFlow 禁止/允许地图中的流体流动
GetBannedItemList 获取禁用物品列表
GetGameDiffculty 获取游戏难度
GetGameRulesInfoServer 获取游戏规则
GetGameType 获取默认游戏模式
GetLevelGravity 获取重力因子
GetSeed 获取存档种子
IsDisableCommandMinecart 获取当前是否允许运行命令方块矿车内置逻辑指令,当前仅Apollo网络服可用
IsLockDifficulty 获取当前世界的游戏难度是否被锁定
IsLockGameRulesInfo 获取当前世界的游戏规则是否被锁定
IsLockGameType 获取当前世界的游戏类型是否被锁定,包括默认游戏类型和个人游戏类型
LockDifficulty 锁定当前世界游戏难度(仅本次游戏有效),锁定后任何玩家在游戏内都无法通过指令或暂停菜单修改游戏难度
LockGameRulesInfo 锁定当前世界游戏规则(仅本次游戏有效),玩家无法通过指令、游戏菜单或api修改游戏规则(包括[SetGameRulesInfoServer](世界/游戏规则.md#setgamerulesinfoserver)示例中列举的规则)
LockGameType 锁定当前世界游戏类型(仅本次游戏有效),玩家无法通过指令、游戏菜单或相关api如[SetPlayerGameType](世界/../玩家/游戏模式.md#setplayergametype)和[SetDefaultGameType](世界/游戏规则.md#setdefaultgametype)修改游戏类型,包括默认游戏类型和个人游戏类型
OpenCityProtect 开启城市保护,包括禁止破坏方块,禁止对方块使用物品,禁止怪物攻击玩家,禁止玩家之间互相攻击,禁止日夜切换,禁止天气变化,禁止怪物群落刷新
RemoveBannedItem 移除禁用物品
RemoveBlockProtectField 取消一个方块无法被玩家/实体破坏的区域
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类型消息下方
SetPopupState 设置Popup消息栏状态
SetTipMessage 在所有玩家物品栏上方弹出tip类型通知,位置位于popup类型通知上方
GetAllPlayerScoreboardObjects 获取玩家记分项
GetAllScoreboardObjects 获取所有记分板项
GetEngineType 获取实体类型,主要用于判断实体是否属于某一类型的生物。
GetEngineTypeStr 获取实体的类型名称
GetEntityDefinitions 获取实体的命名空间ID及其当前和之前的定义组件群
GetAuxValue 获取射出的弓箭或投掷出的药水的附加值
ChangeEntityDimension 传送实体
GetAllComponentsName 获取实体所拥有的原版组件list
GetAttrMaxValue 获取实体的引擎属性的最大值
GetAttrValue 获取实体的引擎属性
GetBodyRot 获取实体的身体的角度
GetCurrentAirSupply 生物当前氧气储备值
GetDeathTime 获取生物死亡后持续的时间(刻,1秒20刻),用于控制死亡动画。0表示生物未死亡。
GetEntityDamage 获取生物(包括玩家)的攻击力
GetEntityDimensionId 获取实体所在维度
GetEntityFallDistance 获取实体的坠落高度,越大的值会给予实体更大的坠落伤害,建议在[OnGroundServerEvent](实体/../../事件/实体.md#ongroundserverevent)事件中调用
GetEntityLinksTag 获取实体相连接的实体,如获取entityId为马,会返回骑乘者的信息
GetEntityOwner 获取实体的属主(包括可驯服生物的主人,或者掉落物的丢弃者,弹射物的发射者等)
GetFootPos 获取实体脚所在的位置
GetGravity 获取实体的重力因子,当生物重力因子为0时则应用世界的重力因子
GetLoadActors 获取已加载的实体id
GetMarkVariant 获取实体的标记变种属性值
GetMaxAirSupply 获取生物最大氧气储备值
GetMobColor 获取生物的颜色,截止至网易2.9版本,只对羊和热带鱼有效
GetMobStrength 获取生物的强度,截止至网易2.9版本,只对羊驼有效,强度越大羊驼驮运的箱子时格子数量越多
GetMobStrengthMax 获取生物强度的最大值,截止至网易2.9版本,只对羊驼有效,强度越大羊驼驮运的箱子时格子数量越多,[SetMobStrength](实体/属性.md#setstrength)无法超过SetMobStrengthMax的值
GetName 获取生物的自定义名称(即使用命名牌或者SetName接口设置的名称),或者玩家的名字。
GetPos 获取实体位置
GetRiderId 获取玩家坐骑entityid
GetRot 获取实体头与水平方向的俯仰角度和竖直方向的旋转角度,获得角度后可用GetDirFromRot接口转换为朝向的单位向量 <a href="../../../mcguide/20-玩法开发/10-基本概念/10-Vector3.html">MC坐标系说明</a>
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版本,只对掠夺者和卫道士有效
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](实体/属性.md#setmobstrength)无法超过SetMobStrengthMax的值
SetName 用于设置生物的自定义名称,跟原版命名牌作用相同,玩家和新版流浪商人暂不支持
SetOutOfControl 设置实体是否处于失控状态,截止至网易2.9版本,只对船有效
SetPersistent 设置实体不会因为离玩家太远而被[清除](https://minecraft.fandom.com/zh/wiki/%E7%94%9F%E6%88%90#.E5.9F.BA.E5.B2.A9.E7.89.88_2)
SetPlayerLookAtPos 设置本地玩家看向某个位置
SetPos 设置实体位置
SetRecoverTotalAirSupplyTime 设置恢复最大氧气量的时间,单位秒
SetRot 设置实体头与水平方向的俯仰角度和竖直方向的旋转角度 <a href="../../../mcguide/20-玩法开发/10-基本概念/10-Vector3.html">MC坐标系说明</a>
SetSheared 设置实体是否被剃毛,截止至网易2.9版本,只对羊有效
SetSitting 设置生物是否坐下
SetSize 设置实体的包围盒
SetTradeLevel 设置村民的交易等级
SetVariant 设置实体的变种属性值
isEntityInLava 实体是否在岩浆中
isEntityOnGround 实体是否触地
AddActorComponentGroup 给指定实体添加实体json中配置的ComponentGroup
AddEntityAroundEntityMotion 给实体(不含玩家)添加对实体环绕运动器
AddEntityAroundPointMotion 给实体(不含玩家)添加对点环绕运动器
AddEntitySeat 增加坐骑座位
AddEntityTrackMotion 给实体(不含玩家)添加轨迹运动器
AddEntityVelocityMotion 给实体(不含玩家)添加速度运动器
ChangeRiderSeat 设置骑乘者在当前坐骑上的序号
DeleteEntitySeat 删除坐骑座位
GetAttackTarget 获取仇恨目标
GetBlockControlAi 获取生物原生AI是否被屏蔽
GetCustomGoalCls 用于获取服务器自定义行为节点的基类。实现新的行为节点时,需要继承该接口返回的类
GetEntityMotions 获取实体(不含玩家)身上的所有运动器
GetJumpPower 获取生物跳跃力度,0.42表示正常水平
GetLeashHolder 获取实体被使用拴绳牵引时牵引者的ID
GetMotion 获取生物(含玩家)的瞬时移动方向向量
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 为实体添加牵引者,与原版拴绳的作用相同,详见<a href="https://minecraft.fandom.com/zh/wiki/%E6%8B%B4%E7%BB%B3#%E6%8B%B4%E8%B5%B7%E7%94%9F%E7%89%A9">基岩版栓绳介绍</a>
SetLootDropped 设置生物是否生成掉落物
SetMobKnockback 设置击退的初始速度,需要考虑阻力的影响
SetMotion 设置生物(不含玩家)的瞬时移动方向向量
SetMoveSetting 寻路组件
SetPersistence 设置实体是否持久化。
SetRidePos 设置生物骑乘位置
SetRiderRideEntity 设置实体骑乘生物(或者船与矿车)
SetStepHeight 设置玩家前进非跳跃状态下能上的最大台阶高度, 默认值为0.5625,1的话表示能上一个台阶
StartEntityMotion 启动实体(不含玩家)身上的某个运动器
StopEntityMotion 停止实体(不含玩家)身上的某个运动器
TriggerCustomEvent 触发生物自定义事件
AddEffectToEntity 为实体添加指定状态效果,如果添加的状态已存在则有以下集中情况:1、等级大于已存在则更新状态等级及持续时间;2、状态等级相等且剩余时间duration大于已存在则刷新剩余时间;3、等级小于已存在则不做修改;4、粒子效果以新的为准
GetAllEffects 获取实体当前所有状态效果
HasEffect 获取实体是否存在当前状态效果
RemoveEffectFromEntity 为实体删除指定状态效果
AddActorAnimation 增加生物渲染动画
AddActorAnimationController 增加生物渲染动画控制器
AddActorBlockGeometry 为实体添加方块几何体模型。
AddActorGeometry 增加生物渲染几何体
AddActorParticleEffect 增加生物特效资源
AddActorRenderController 增加生物<a href="../../../mcguide/20-玩法开发/15-自定义游戏内容/3-自定义生物/01-自定义基础生物.html#_7-自定义渲染控制器">渲染控制器</a>
AddActorRenderControllerArray 增加生物渲染控制器列表中字典arrays元素
AddActorRenderMaterial 增加生物渲染需要的<a href="../../../mcguide/20-玩法开发/15-自定义游戏内容/3-自定义生物/01-自定义基础生物.html#_3-自定义材质">材质</a>
AddActorScriptAnimate 在生物的客户端实体定义(minecraft:client_entity)json中的scripts/animate节点添加动画/动画控制器
AddActorSoundEffect 增加生物音效资源
AddActorTexture 增加生物渲染贴图
BindEntityToEntity 绑定骨骼模型跟随其他entity,摄像机也跟随其他entity
ClearActorBlockGeometry 删除实体中所有的方块几何体模型。
CopyActorGeometryFromPlayer 将渲染几何体从某个玩家拷贝到某类生物identifier上
CopyActorRenderMaterialFromPlayer 将渲染<a href="../../../mcguide/20-玩法开发/15-自定义游戏内容/3-自定义生物/01-自定义基础生物.html#_3-自定义材质">材质</a>从某个玩家拷贝到某类生物identifier上
CopyActorTextureFromPlayer 将贴图从某个玩家拷贝到某类生物identifier上
CopyPlayerGeometryToOneActor 将渲染几何体从某个玩家拷贝到某个生物上
CopyPlayerRenderMaterialToOneActor 将渲染<a href="../../../mcguide/20-玩法开发/15-自定义游戏内容/3-自定义生物/01-自定义基础生物.html#_3-自定义材质">材质</a>从某个玩家拷贝到某个生物上
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 删除生物<a href="../../../mcguide/20-玩法开发/15-自定义游戏内容/3-自定义生物/01-自定义基础生物.html#_7-自定义渲染控制器">渲染控制器</a>
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设置的属性值
RegisterUpdateFunc 注册属性值变换时的回调函数,当属性变化时会调用该函数
SaveAttr 保存SetAttr设置的属性值
SetAttr 设置属性值。服务端设置后会自动同步到客户端,可以用客户端的GetAttr获取。默认不会存档,需要存档的话可以设置needRestore=True。
UnRegisterUpdateFunc 反注册属性值变换时的回调函数
Get 获取某一个实体计算节点的值,如果不存在返回注册时的默认值
GetMolangValue 获取实体molang变量的值
GetStringHash64 返回字符串变量的hash64
Register 注册实体计算节点
Set 设置某一个实体计算节点的值
UnRegister 注销实体计算节点
AddEntityTag 增加实体标签
EntityHasTag 判断实体是否存在某个指定的标签
GetEntityTags 获取实体标签列表
RemoveEntityTag 移除实体某个指定的标签
GetSourceEntityId 获取抛射物发射者实体id
GetOrbExperience 获取经验球的经验
SetOrbExperience 设置经验球经验
Disable 关闭官方伙伴功能,单人游戏以及本地联机不支持该接口
Enable 启用官方伙伴功能,单人游戏以及本地联机不支持该接口
AddCommonPhrases 为官方聊天扩展功能添加常用短语。单人模式下单个模组最多添加12条,联机大厅和网络服无条数限制。
RegisterChatPrefix 为游戏内指定玩家注册聊天前缀。仅在主界面消息框和聊天界面游戏频道生效。建议在AddServerPlayerEvent事件中调用,为新玩家添加前缀。
RemoveCommonPhrases 为官方聊天扩展功能移除常用短语。
SetShowOfficialPhrases 设置是否显示官方的常用聊天短语。仅在联机大厅和网络服中生效。
SetShowSocialNearbyInfo 设置是否显示官方聊天社交界面中同一游戏玩家是否在附近信息。
AddPlayerExperience 增加玩家经验值
AddPlayerLevel 修改玩家等级
CollectOnlineClientData 收集在线玩家客户端数据,用于判断玩家是否作弊
GetArmorValue 获取玩家护甲值
GetEnchantmentSeed 获取玩家的附魔种子,该种子会决定附魔台上准备附魔的装备的附魔项
GetPlayerCurLevelExp 获取玩家当前等级需要的经验值
GetPlayerExp 获取玩家当前等级下的经验值
GetPlayerHealthLevel 获取玩家健康临界值,当饥饿值大于等于健康临界值时会自动恢复血量,开启饥饿值且开启自然恢复时有效。原版默认值为18
GetPlayerHealthTick 获取玩家自然恢复速度,当饥饿值大于等于健康临界值时会自动恢复血量,开启饥饿值且开启自然恢复时有效。原版默认值为80刻(即每4秒)恢复1点血量
GetPlayerHunger 获取玩家饥饿度,展示在UI饥饿度进度条上,初始值为20,即每一个鸡腿代表2个饥饿度。 **饱和度(saturation)** :玩家当前饱和度,初始值为5,最大值始终为玩家当前饥饿度(hunger),该值直接影响玩家**饥饿度(hunger)**。<br>1)增加方法:吃食物。<br>2)减少方法:每触发一次**消耗事件**,该值减少1,如果该值不大于0,直接把玩家 **饥饿度(hunger)** 减少1。
GetPlayerLevel 获取玩家等级
GetPlayerMaxExhaustionValue 获取玩家foodExhaustionLevel的归零值,常量值,默认为4。**消耗度(exhaustion)**是指玩家当前消耗度水平,初始值为0,该值会随着玩家一系列动作(如跳跃)的影响而增加,当该值大于最大消耗度(maxExhaustion)后归零,并且把饱和度(saturation)减少1(为了说明饥饿度机制,我们将此定义为**消耗事件**)
GetPlayerStarveLevel 获取玩家饥饿临界值,当饥饿值小于饥饿临界值时会自动扣除血量,开启饥饿值且开启饥饿掉血时有效。原版默认值为1
GetPlayerStarveTick 获取玩家饥饿掉血速度,当饥饿值小于饥饿临界值时会自动扣除血量,开启饥饿值且开启饥饿掉血时有效。原版默认值为80刻(即每4秒)扣除1点血量
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。
GetInteracteCenterOffset 获取玩家[服务端交互中心](玩家/../../更新信息/2.8.md#玩家摄像机)的偏移
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 获取玩家是否处于潜行状态
isSprinting 是否在疾跑
isSwimming 获取玩家是否处于游泳状态。
setMoving 设置是否行走,只能设置本地玩家(只适用于移动端)
setSneaking 设置是否潜行,只能设置本地玩家(只适用于移动端)
setSprinting 设置行走模式为疾跑/冲刺,只能设置本地玩家(只适用于移动端)
setUsingShield 激活盾牌状态
AddPlayerAnimation 增加玩家渲染动画
AddPlayerAnimationController 增加玩家渲染动画控制器
AddPlayerAnimationIntoState 在玩家的动画控制器中的状态添加动画或者动画控制器
AddPlayerGeometry 增加玩家渲染几何体
AddPlayerParticleEffect 增加玩家特效资源
AddPlayerRenderController 增加玩家<a href="../../../mcguide/20-玩法开发/15-自定义游戏内容/3-自定义生物/01-自定义基础生物.html#_7-自定义渲染控制器">渲染控制器</a>
AddPlayerRenderMaterial 增加玩家渲染需要的<a href="../../../mcguide/20-玩法开发/15-自定义游戏内容/3-自定义生物/01-自定义基础生物.html#_3-自定义材质">材质</a>
AddPlayerScriptAnimate 在玩家的客户端实体定义(minecraft:client_entity)json中的scripts/animate节点添加动画/动画控制器
AddPlayerSoundEffect 增加玩家音效资源
AddPlayerTexture 增加玩家渲染贴图
RebuildPlayerRender 重建玩家的数据渲染器
RemovePlayerAnimationController 移除玩家渲染动画控制器
RemovePlayerGeometry 删除玩家渲染几何体
RemovePlayerRenderController 删除玩家<a href="../../../mcguide/20-玩法开发/15-自定义游戏内容/3-自定义生物/01-自定义基础生物.html#_7-自定义渲染控制器">渲染控制器</a>
ResetSkin 还原默认皮肤
SetPlayerItemInHandVisible 设置是否隐藏玩家的手持物品模型显示
SetSkin 更换原版自定义皮肤
AddEnchantToInvItem 给物品栏的物品添加附魔信息
AddModEnchantToInvItem 给物品栏中物品添加自定义附魔信息
ChangePlayerItemTipsAndExtraId 修改玩家物品的自定义tips和自定义标识符
ChangeSelectSlot 设置玩家当前选中快捷栏物品的index
GetCarriedItem 获取右手物品的信息
GetInvItemEnchantData 获取物品栏的物品附魔信息
GetInvItemModEnchantData 获取物品栏的物品自定义附魔信息
GetOffhandItem 获取左手物品的信息
GetPlayerAllItems 获取玩家指定的槽位的批量物品信息
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 获取指定玩家的游戏模式
SetPlayerGameType 设置玩家个人游戏模式
GetPlayerAbilities 获取玩家具体权限
GetPlayerOperation 获取玩家权限类型信息
SetAttackMobsAbility 设置玩家能否攻击生物
SetAttackPlayersAbility 设置玩家能否攻击其他玩家
SetBuildAbility 设置玩家能否放置方块,该接口的设置会存档,且只影响生存模式
SetMineAbility 设置玩家能否摧毁方块,该接口的设置会存档,且只影响生存模式
SetOpenContainersAbility 设置玩家能否打开容器
SetOperateDoorsAndSwitchesAbility 设置玩家能否与门和开关交互
SetOperatorCommandAbility 设置玩家是否具有操作员命令权限
SetPermissionLevel 设置玩家权限等级
SetPlayerMute 设置玩家是否禁言,该接口的设置不存档
SetTeleportAbility 设置玩家能否使用TP指令
GetNavPath 获取本地玩家到目标点的寻路路径,开发者可以通过该接口定制自定义的导航系统。
StartNavTo 我们提供了一个基于GetNavPath的导航系统实现,做法是在路径上生成序列帧以引导玩家通向目标点,并且当玩家偏离路径会重新进行导航。
StopNav 终止当前的导航
GetBlockAuxValueFromStates 根据方块名称和<a href="../../../mcguide/20-玩法开发/10-基本概念/1-我的世界基础概念.html#物品信息字典#方块状态">方块状态</a>获取方块附加值AuxValue
GetBlockStates 获取<a href="../../../mcguide/20-玩法开发/10-基本概念/1-我的世界基础概念.html#物品信息字典#方块状态">方块状态</a>
GetBlockStatesFromAuxValue 根据方块名称和方块附加值AuxValue获取<a href="../../../mcguide/20-玩法开发/10-基本概念/1-我的世界基础概念.html#物品信息字典#方块状态">方块状态</a>
SetBlockStates 设置<a href="../../../mcguide/20-玩法开发/10-基本概念/1-我的世界基础概念.html#物品信息字典#方块状态">方块状态</a>
GetBlockBasicInfo 获取方块基本信息
GetLoadBlocks 获取已经加载的方块id
SetBlockBasicInfo 设置方块基本信息
SetChestLootTable 设置箱子战利品表
CleanBlockTileEntityCustomData 清空指定位置的特殊方块(箱子、头颅、熔炉、花盆等)绑定的TileEntity内存储的自定义数据。
CreateFrameEffectForBlockEntity 在自定义方块实体上创建序列帧特效,创建后该接口返回序列帧特效的Id,利用该Id可以使用特效/序列帧中的接口对该序列帧特效进行播放、设置位置、大小等操作。与实体的序列帧特效创建方式类似。
CreateParticleEffectForBlockEntity 在自定义方块实体上创建粒子特效,创建后该接口返回粒子特效的Id,利用该Id可以使用特效/粒子中的接口对该粒子特效进行播放、设置位置、大小等操作。与实体的粒子特效创建方式类似。若自定义方块实体已存在键值名称相同的特效,则不会创建新的特效,接口返回已有的特效Id。
ExecuteCommandBlock 执行一次命令方块
GetBlockEntityData 用于获取可操作某个自定义方块实体数据的对象,操作方式与dict类似
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)类型的向量。
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接口不同,该接口调整的是相对于方块位置的位置偏移值,而不是世界坐标。
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 获取目前已注册的所有附魔信息
GetCustomName 获取物品的自定义名称,与铁砧修改的名称一致
GetItemBasicInfo 获取物品的基础信息
GetItemDefenceAngle 获取盾牌物品的抵挡角度范围
GetItemDurability 获取指定槽位的物品耐久
GetItemEffectName 获取物品的状态描述,如:§7保护 0§r
GetItemFormattedHoverText 获取物品的格式化hover文本,如:§f灾厄旗帜§r
GetItemHoverName 获取物品的hover名称,如:灾厄旗帜§r
GetItemLayer 获取物品的叠加贴图。物品叠加贴图详见SetItemLayer
GetItemMaxDurability 获取指定槽位的物品耐最大耐久
GetLoadItems 获取已经加载的物品id
GetUserDataInEvent 使物品相关服务端事件的<a href="../../../mcguide/20-玩法开发/10-基本概念/1-我的世界基础概念.html#物品信息字典#物品信息字典">物品信息字典</a>参数带有userData。在mod初始化时调用即可
LookupItemByName 判定指定identifier的物品是否存在
RemoveItemLayer 移除物品的叠加贴图。物品叠加贴图详见SetItemLayer
SetAttackDamage 设置物品的攻击伤害值
SetCustomName 设置物品的自定义名称,与使用铁砧重命名一致
SetItemDefenceAngle 设置盾牌物品的抵挡角度范围
SetItemDurability 设置物品的耐久值
SetItemLayer 设置物品的叠加贴图,可以在物品的上层与下层叠加自定义贴图。具体使用可参考CustomItemsMod示例。
SetItemMaxDurability 设置物品的最大耐久值
SetItemTierLevel 设置工具类物品的挖掘等级
SetItemTierSpeed 设置工具类物品的挖掘速度
SetMaxStackSize 设置物品的最大堆叠数量(存档)
SetShearsDestoryBlockSpeed 设置剪刀对某一方块的破坏速度
CreateTextBoardInWorld 创建文字面板
RemoveTextBoard 删除文字面板
SetBoardBackgroundColor 修改背景颜色
SetBoardBindEntity 文字面板绑定实体对象
SetBoardDepthTest 设置是否开启深度测试, 默认状态下是开启
SetBoardFaceCamera 设置文字面板的朝向
SetBoardPos 修改位置
SetBoardRot 修改旋转角度, 若设置了文本朝向相机,则旋转角度的修改不会生效
SetBoardScale 内容整体缩放
SetBoardTextColor 修改字体颜色
SetText 修改文字面板内容
Bind 绑定entity
CreateEngineSfx 创建序列帧特效
CreateEngineSfxFromEditor 指使用资源包中effects/xxx.json,按照编辑器中编辑好的参数创建序列帧。支持环状序列帧
GetScale 获取序列帧特效的缩放值
Pause 暂停播放,序列帧定格在当前时刻,再次调用Play时继续播放
Play 播放序列帧
SetDeepTest 设置序列帧是否透视,默认为否
SetFaceCamera 设置序列帧是否始终朝向摄像机,默认为是
SetFadeDistance 设置序列帧开始自动调整透明度的距离。序列帧与摄像机之间的距离小于该值时会自动调整序列帧的透明度,距离摄像机越近,序列帧越透明
SetLayer 设置序列帧渲染层级,默认层级为1,当层级不为1时表示该特效开启特效分层渲染功能。特效(粒子和帧动画)分层渲染时,层级越高渲染越靠后,层级大的会遮挡层级低的,且同一层级的特效会根据特效的相对位置产生正确的相互遮挡关系。
SetLoop 设置序列帧是否循环播放,默认为否
SetMixColor 设置序列帧混合颜色
SetRotUseZXY 设置序列帧的旋转,旋转顺序按照绕z,x,y轴旋转
SetScale 设置序列帧的缩放
SetUsePointFiltering 设置序列帧是否使用点滤波
Stop 停止序列帧(不是暂停)
CreateEngineParticle 用于创建粒子特效
GetParticleEmissionRate 获取粒子发射器每帧发射粒子的频率。
GetParticleMaxNum 获取粒子发射器包含的最大粒子数量。
GetParticleMaxSize 获取粒子特效中粒子大小的最大值。
GetParticleMinSize 获取粒子特效中粒子大小的最小值。
GetParticleVolumeSize 获取粒子发射器的体积大小缩放值。
SetParticleEmissionRate 设置粒子发射器每帧发射粒子的频率,频率越大则每帧发射的粒子数量越多,但粒子数量不会超过粒子发射器的粒子容量,同时由于性能考虑,每帧发射的粒子数量也不会超过100个。
SetParticleMaxNum 设置粒子发射器的粒子容量,即粒子发射器所包含的最大粒子数量。该数量并不代表目前粒子发射器所发射的粒子数量,如需要增加发射的粒子数量,需同时改变粒子的发射频率。
SetParticleSize 设置粒子特效中粒子大小的最小值及最大值。
SetParticleVolumeSize 设置粒子发射器的体积大小缩放,不影响单个粒子的尺寸。粒子发射器的体积越大,则粒子的发射范围越大。
SetRelative 当粒子绑定了entity或骨骼模型时,发射出的粒子使用entity坐标系还是世界坐标系。与mcstudio特效编辑器中粒子的“相对挂点运动”选项功能相同。
CreateEngineEffectBind 指用编辑器保存资源包中models/bind/xxx_bind.json生成编辑好的所有挂点的所有特效。生成的特效会自动进行挂接及播放,编辑器中设为不可见的特效也会进行播放。并且使用这种方式创建的特效,开发者不用维护entity进出视野导致的挂接特效被移除,引擎会在entity每次进入视野时自动创建所有特效。
Resume 继续播放模型特效(即使用CreateEngineEffectBind创建的特效)
BindEntity 绑定粒子发射器到指定实体的指定骨骼上
BindModel 绑定粒子发射器到指定骨骼模型的指定骨骼上
Create 创建粒子发射器, 创建后立即播放
CreateBindEntityNew 创建粒子发射器并绑定到指定实体的指定骨骼上, 创建后立即播放
EmitManually 手动发射粒子一次
Exist 判断指定粒子发射器是否存在
GetActiveDuration 获取粒子发射器的激活周期
GetBindingID 返回粒子绑定的实体id,没有则返回"0"
GetBindingModelID 返回绑定的骨骼模型id 没有则返回-1
GetDuration 获取粒子发射器的播放周期(激活+休眠时间)
GetFacingMode 返回粒子发射器的粒子朝向模式
GetLoopAge 获取粒子发射器当前播放周期内已播放的时间
GetSleepDuration 获取粒子发射器的休眠周期
GetTimeScale 获取粒子发射器的播放速度
GetVariable 获取粒子发射器的Molang变量值
Hide 隐藏粒子发射器(不渲染)
IsHiding 返回粒子发射器是否正在被隐藏(不渲染)
IsPausing 返回粒子发射器的逻辑是否正在被暂停
PlayAt 设置粒子发射器播放时间点
Remove 销毁指定粒子发射器
RemoveByName 销毁场景中指定名称(粒子发射器json中的identifier)的所有粒子发射器
Replay 重播粒子发射器
SetTimeScale 设置粒子发射器的播放速度
SetVariable 设置粒子发射器的Molang变量值
Show 显示粒子发射器(开启渲染)
Unbind 解除指定粒子发射器的绑定状态
BindItemToBone 将使用了骨骼模型的玩家的手持物绑定到指定的骨骼上
BindModelToEntity 实体替换骨骼模型后,再往上挂接其他骨骼模型。
BindModelToModel 在骨骼模型上挂接其他骨骼模型
CancelAllBoneMask 取消动画中的所有骨骼屏蔽。
CreateFreeModel 创建自由的模型(无需绑定Entity)
GetAllBindModelToEntity 获取实体上某个骨骼上挂接的所有骨骼模型的id
GetAnimLength 获取某个骨骼动画的长度,单位为秒
GetBoneWorldPos 获取骨骼的坐标
GetEntityBoneWorldPos 获取换了骨骼模型的实体的骨骼坐标
GetEntityScale 获取实体的放缩比例大小
GetExtraUniformValue 获取在骨骼模型shader中使用的自定义变量Uniform的值
GetModelId 获取骨骼模型的Id,主要用于特效绑定骨骼模型
GetModelMaterial 获取骨骼模型的正在使用的材质名称,也可获取骨骼模型中指定骨骼所使用的<a href="../../../mcguide/16-美术/6-模型和动作/04-骨骼模型的使用.html#7.模型使用自定义材质及更多贴图">材质名称</a>。如果获取指定骨骼所使用的材质,需要先在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 设置骨骼模型
SetModelMaterial 设置骨骼模型所使用的的材质,除了可以设置骨骼模型所使用的<a href="../../../mcguide/16-美术/6-模型和动作/04-骨骼模型的使用.html#7.模型使用自定义材质及更多贴图">自定义材质</a>以外,也可对单个骨骼设置所使用的<a href="../../../mcguide/16-美术/6-模型和动作/04-骨骼模型的使用.html#7.模型使用自定义材质及更多贴图">自定义材质</a>。如果需要设置单个骨骼所使用的材质,需要先在netease_model.json下设置"useSplitMeshes"字段为true。
SetModelMultiPassMaterial 设置骨骼模型多pass中使用到的<a href="../../../mcguide/16-美术/6-模型和动作/04-骨骼模型的使用.html#9.骨骼模型自定义多pass">材质列表</a>,也可对单个骨骼设置所使用的自定义多Pass材质。如果需要设置单个骨骼所使用的多Pass材质,需要先在netease_model.json下设置"useSplitMeshes"字段为true。
SetModelOffset 设置骨骼模型相对于局部坐标系的偏移量,初始值为(0, 0, 0)
SetModelPartVisible 对骨骼模型中指定的骨骼进行渲染屏蔽,屏蔽后该骨骼不会被渲染出来。
SetModelPerspectiveEffect 设置模型透视效果。注:只对自定义骨骼模型生效
SetModelTexture 设置骨骼模型贴图,该接口与SetTexture功能相同,但属于服务端接口。
SetShowArmModel 设置使用骨骼模型后切换至第一人称时是否显示手部模型。需要先为骨骼模型定义arm_model,arm_model的定义可参考demo示例-AwesomeMod中的resourcePack/models/netease_models.json中的大天狗模型定义
SetTexture 设置骨骼模型的贴图,该接口与SetModelTexture功能相同,但属于客户端接口。
ShowCommonHurtColor 设置挂接骨骼模型的实体是否显示通用的受伤变红效果
ShowModel 显示纯模型
UnBindModelToEntity 取消实体上挂接的某个骨骼模型。取消挂接后,这个modelId的模型便会销毁,无法再使用,如果是临时隐藏可以使用HideModel
UnBindModelToModel 取消骨骼模型上挂接的某个骨骼模型。取消挂接后,这个modelId的模型便会销毁,无法再使用,如果是临时隐藏可以使用HideModel
ChangeSneakState 切换潜行状态
ChangeWalkState 切换行走/潜行/跑步状态
ClickInteractGUI 模拟点击交互按钮,交互按钮指的在喂食、钓鱼、交易等交互场景出现的按钮
GetOriginAreaOffset 获取指定原生UI的offset,包括左上角和右下角
GetScreenSize 获取游戏分辨率
GetScreenViewInfo 获取游戏视角信息。首先获得当前分辨率下UI放大倍数,计算方式可参考<a href="../../../mcguide/18-界面与交互/1-界面编辑器使用说明.html#《我的世界》界面适配方法">《我的世界》界面适配方法</a>。则当前游戏视角的宽度的计算方式为:若当前分辨率的宽度能被该放大倍数整除,则等于当前分辨率,若不能,则等于当前分辨率加放大倍数再减去当前分辨率对放大倍数求余的结果,当前游戏视角的高度计算方法类似。例:以分辨率为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。该接口在开启新版聊天时不生效
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](自定义UI/通用.md#createui)接口
CreateUI 创建UI,详见<a href="../../../mcguide/18-界面与交互/30-UI说明文档.html#界面创建流程及生命周期">界面创建流程及生命周期</a>
GetCustomUIControlProxyCls 获得原生界面自定义UI代理基类
GetMiniMapScreenNodeCls 获取小地图ScreenNode基类
GetNativeScreenManagerCls 获得NativeScreenManager类
GetScreenNodeCls 获得ScreenNode类
GetTopScreen 获取UI堆栈栈顶的UI节点
GetTopUI 获取UI栈顶的UI名称
GetTopUINode 获取Push进来的最顶层界面,包括原生界面,详见<a href="../../../mcguide/18-界面与交互/30-UI说明文档.html#界面创建流程及生命周期" rel="noopenner"> 界面创建流程及生命周期 </a>
GetUI 获取UI节点,详见<a href="../../../mcguide/18-界面与交互/30-UI说明文档.html#界面创建流程及生命周期">界面创建流程及生命周期</a>
GetUIScreenProxyCls 获得原生界面Screen代理基类
GetViewBinderCls 获得ViewBinder类
GetViewViewRequestCls 获得ViewRequest类
PopScreen 使用堆栈管理的方式关闭UI
PopTopUI 弹出UI栈顶的UI
PushScreen 使用堆栈管理的方式创建UI
RegisterUI 注册UI,创建UI前,需要先注册UI。同一UI只需要注册一次即可。详见<a href="../../../mcguide/18-界面与交互/30-UI说明文档.html#界面创建流程及生命周期">界面创建流程及生命周期</a>
RegisterUIAnimations 注册UI动画
UnregisterUIAnimation 取消UI动画的注册
GetBookManager 获取书本管理对象
AddNodeProgress 增加对应玩家的对应成就节点的成就进度
GetAchievementGatePosition 获取自定义成就系统的入口按钮位置
GetChildrenNode 获得该成就节点的下一级所有孩子节点的list
GetNodeDetailInfo 获取对应玩家的对应节点信息
SetAchievementGatePosition 设置自定义成就系统的入口按钮位置
SetNodeFinish 设置对应玩家的对应成就节点完成
AddEntityMarker 增加实体位置标记
AddEntityTextMarker 在小地图上增加实体文本标记
AddStaticMarker 增加地图上静态位置的标记
AddStaticTextMarker 在小地图上增加静态文本的标记
BindVirtualWorldModel 绑定虚拟世界中的模型
ChangeBindAutoScale 设置已绑定实体的UI是否根据绑定实体与本地玩家间的距离动态缩放,**只对已绑定实体的UI界面生效,如何将UI与实体绑定详见[CreateUI](自定义UI/通用.md#CreateUI)接口**
ChangeBindEntityId 修改绑定的实体id,**只对已绑定实体的UI界面生效,如何将UI与实体绑定详见[CreateUI](自定义UI/通用.md#CreateUI)接口**
ChangeBindOffset 修改与绑定实体之间的偏移量,**只对已绑定实体的UI界面生效,如何将UI与实体绑定详见[CreateUI](自定义UI/通用.md#CreateUI)接口**
Clone 克隆一个已有的控件,修改它的名称,并将它挂接到指定的父节点上,目前文本、图片、按钮控件的克隆控件表现正常,其他复杂控件的克隆控件可能存在运行问题,建议在json编写的过程中,手动复制一份对应控件使用。
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控件的配置方式详见<a href="../../../mcguide/18-界面与交互/30-UI说明文档.html#paperdoll">控件介绍PaperDoll</a>
SetUiModel 设置PaperDoll控件需要显示的模型,PaperDoll控件的配置方式详见<a href="../../../mcguide/18-界面与交互/30-UI说明文档.html#paperdoll">控件介绍PaperDoll</a>
SetUiModelScale 设置PaperDoll控件模型的缩放比例
Update 客户端每帧调用,1秒有30帧
UpdateScreen 刷新界面,重新计算各个控件的相关数据
ZoomIn 放大地图
ZoomOut 缩小地图
ZoomReset 恢复地图放缩大小为默认值
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 获取控件所允许的最小的大小值
GetOffsetDelta 获得点击面板的拖拽偏移量
GetOptionCount 获得选项数量
GetOptionIndexByShowName 根据展示文本查找对应下拉框项的索引位置,若找不到返回-1
GetOptionShowNameByIndex 根据索引位置查找当前栈式文本,若找不到返回None
GetOrientation 获取stackPanel的排列方向
GetPath 返回当前控件的相对路径,路径从画布节点开始算起
GetRotateAngle 获取图片相对自身的旋转锚点旋转的角度
GetRotatePivot 获取图片相对自身的旋转锚点
GetRotateRect 获取图片当前的四个边角点
GetScrollViewContentControl 返回该scroll_view内容的BaseUIControl实例
GetScrollViewContentPath 返回该scroll_view内容的路径
GetScrollViewPercentValue 获取当前scroll_view内容的百分比位置
GetScrollViewPos 获得当前scroll_view最上方内容的位置
GetSelectOptionIndex 获得当前选中项的索引,所无选中项则返回-1
GetSelectOptionShowName 获得当前选中项的展示文本,所无选中项则返回None
GetSliceCount 获取轮盘可以选择的总切片数量
GetSliderValue 获取滑动条的值,失败返回0
GetText 获取Label的文本信息,获取失败会返回None
GetTextAlignment 获取文本控件的文本对齐方式
GetTextColor 获取Label文本颜色
GetTextLinePadding 获取文本控件的行间距
GetToggleState 获取Toggle开关控件的状态
GetUiItem 获取ItemRenderer控件显示的物品,ItemRenderer控件的配置方式详见<a href="../../../mcguide/18-界面与交互/30-UI说明文档.html#itemrenderer">控件介绍ItemRenderer</a>
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控件的大小
SetHoverCallback 设置轮盘选择切片触发回调函数
SetImageAdaptionType 设置图片控件的图片适配方式以及信息
SetIsModal 设置当前面板是否为模态框
SetIsSwallow 设置当前面板输入是否会吞噬事件,isSwallow为Ture时,点击时,点击事件不会穿透到世界。如破坏方块、镜头转向不会被响应
SetMaxSize 设置控件所允许的最大的大小值
SetMinSize 设置控件所允许的最小的大小值
SetOffsetDelta 设置点击面板的拖拽偏移量
SetOrientation 设置stackPanel的排列方向
SetPosition 设置控件相对父节点的坐标
SetRotatePivot 设置图片自身旋转锚点,该点并不是固定的点,而是相对于自身位置的点
SetScrollViewPercentValue 设置当前scroll_view内容的百分比位置
SetScrollViewPos 设置当前scroll_view内容的位置
SetSelectOptionByIndex 根据提供的索引选中对应下拉框项
SetSelectOptionByShowName 根据提供的展示文本选中对应下拉框项
SetSliderValue 设置滑动条的值
SetSprite 给图片控件换指定贴图
SetSpriteClipRatio 设置图片的裁剪区域比例(不改变控件尺寸)。可以配合image控件的clip_ratio属性控制方向。
SetSpriteColor 设置图片颜色
SetSpriteGray 给图片控件置灰,比直接SetSprite一张灰图片效率要高
SetSpritePlatformFrame 设置图片为我的世界移动端启动器当前帐号的头像框
SetSpritePlatformHead 设置图片为我的世界移动端启动器当前帐号的头像
SetSpriteUV 设置图片的起始uv,与json中的"uv"属性作用一致
SetSpriteUVSize 设置图片的uv大小,与json中的"uv_size"属性作用一致
SetTextAlignment 设置文本控件的文本对齐方式
SetTextColor 设置Label文本的颜色
SetTextFontSize 设置Label中文本字体的大小
SetTextLinePadding 设置文本控件的行间距
SetToggleState 设置Toggle开关控件的值
SetTouchEnable 设置控件是否可点击交互
SetTouchUpCallback 设置轮盘选择切片并且鼠标按下抬起后触发回调函数
SetUiItem 设置ItemRenderer控件显示的物品,ItemRenderer控件的配置方式详见<a href="../../../mcguide/18-界面与交互/30-UI说明文档.html#itemrenderer">控件介绍ItemRenderer</a>
SetValue 设置进度条的进度
SetVisible 根据控件路径选择是否显示某控件,可以通过传入空字符串("")的方式来调整整个JSON的显示/隐藏
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 播放场景音效,包括原版音效及自定义音效
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 获取玩家是否响应暂停按钮
IsCanPerspective 获取玩家是否响应切换视角
IsCanScreenShot 获取玩家是否响应截图按钮
IsCanWalkMode 获取玩家是否响应切换行走模式
LockInputVector 锁定本地玩家方向键(移动轮盘)的输入,可使本地玩家持续向指定方向前行,且不会再受玩家输入影响
LockVerticalMove 模拟上升或下降,调用后一直上升或下降
PickFacing 获取准星选中的实体或者方块
SetCanAll 同时设置SetCanMove,SetCanJump,SetCanAttack,SetCanWalkMode,SetCanPerspective,SetCanPause,SetCanChat,SetCanScreenShot,SetCanOpenInv,SetCanDrag,SetCanInair
SetCanAttack 设置是否响应攻击
SetCanChat 设置是否响应聊天按钮
SetCanDrag 设置是否响应屏幕拖动
SetCanInair 设置是否响应上升下降按钮(飞在空中时右下角的三个按钮)
SetCanJump 设置是否响应跳跃(以及在水中浮起)
SetCanMove 设置是否响应移动
SetCanOpenInv 设置是否响应打开背包按钮
SetCanPause 设置是否响应暂停按钮
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 更新微软原版模型表达式变量,可控制动作的改变
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 显示网易商城入口
EnableFontBatchRender 是否开启字体合批
AchievementCompleteEvent 玩家完成自定义成就时触发该事件
AddEntityClientEvent 客户端侧创建新实体时触发
AddEntityServerEvent 服务端侧创建新实体,或实体从存档加载时触发
AddPlayerAOIClientEvent 玩家加入游戏或者其余玩家进入当前玩家视野时触发的事件,替换AddPlayerEvent
AddPlayerCreatedClientEvent 玩家进入当前玩家所在的区块AOI后,玩家皮肤数据异步加载完成后触发的事件
AddServerPlayerEvent 触发时机:玩家加入时触发该事件。
ChunkAcquireDiscardedClientEvent 触发时机:客户端区块即将被卸载时
ChunkAcquireDiscardedServerEvent 服务端区块即将被卸载时触发
ChunkGeneratedServerEvent 触发时机:区块创建完成时触发
ChunkLoadedClientEvent 触发时机:客户端区块加载完成时
ChunkLoadedServerEvent 触发时机:服务端区块加载完成时
ClientLoadAddonsFinishServerEvent 触发时机:客户端mod加载完成时,服务端触发此事件。服务器可以使用此事件,往客户端发送数据给其初始化。
CommandEvent 玩家请求执行指令时触发
DelServerPlayerEvent 触发时机:删除玩家时触发该事件。
EntityRemoveEvent 实体被删除时触发
ExplosionServerEvent 当发生爆炸时触发。
LoadClientAddonScriptsAfter 客户端加载mod完成事件
LoadServerAddonScriptsAfter 服务器加载完mod时触发
NewOnEntityAreaEvent 触发时机:通过RegisterEntityAOIEvent注册过AOI事件后,当有实体进入或离开注册感应区域时触发该事件。
OnCommandOutputClientEvent 当command命令有成功消息输出时触发
OnCommandOutputServerEvent Command命令执行成功事件
OnContainerFillLoottableServerEvent 触发时机:随机奖励箱第一次打开根据loottable生成物品时
OnLightningLevelChangeServerEvent 打雷强度发生改变
OnLocalLightningLevelChangeServerEvent 独立维度天气打雷强度发生改变时触发
OnLocalPlayerStopLoading 触发时机:玩家进入存档,出生点地形加载完成时触发。该事件触发时可以进行切换维度的操作。
OnLocalRainLevelChangeServerEvent 独立维度天气下雨强度发生改变时触发
OnRainLevelChangeServerEvent 下雨强度发生改变
OnScriptTickClient 客户端tick事件,1秒30次
OnScriptTickServer 服务器tick时触发,1秒有30个tick
PlaceNeteaseLargeFeatureServerEvent 触发时机:网易版大型结构即将生成时服务端抛出该事件。
PlaceNeteaseStructureFeatureEvent 触发时机:首次生成地形时,结构特征即将生成时服务端抛出该事件。
PlayerIntendLeaveServerEvent 触发时机:即将删除玩家时触发该事件,此时可以通过各种API获取玩家的当前状态。
PlayerJoinMessageEvent 触发时机:准备显示“xxx加入游戏”的玩家登录提示文字时服务端抛出的事件。
PlayerLeftMessageServerEvent 触发时机:准备显示“xxx离开游戏”的玩家离开提示文字时服务端抛出的事件。
RemoveEntityClientEvent 客户端侧实体被移除时触发
RemovePlayerAOIClientEvent 玩家离开当前玩家视野时触发的事件
ServerChatEvent 玩家发送聊天信息时触发
ServerPostBlockPatternEvent 触发时机:用方块组合生成生物,生成生物之后触发该事件。
ServerPreBlockPatternEvent 触发时机:用方块组合生成生物,在放置最后一个组成方块时触发该事件。
ServerSpawnMobEvent 游戏内自动生成生物,以及使用api生成生物时触发
UnLoadClientAddonScriptsBefore 客户端卸载mod之前触发
ActorHurtServerEvent 触发时机:生物(包括玩家)受伤时触发
ActuallyHurtServerEvent 实体实际受到伤害时触发,相比于DamageEvent,该伤害为经过护甲及buff计算后,实际的扣血量
AddEffectServerEvent 触发时机:实体获得状态效果时
ApproachEntityClientEvent 玩家靠近生物时触发
ChangeSwimStateServerEvent 触发时机:实体开始或者结束游泳时
DamageEvent 实体受到伤害时触发
EntityChangeDimensionServerEvent 实体维度改变时服务端抛出
EntityDefinitionsEventServerEvent 触发时机:生物定义json文件中设置的event触发时同时触发。生物行为变更事件
EntityDieLoottableAfterServerEvent 触发时机:生物死亡掉落物品之后
EntityDieLoottableServerEvent 触发时机:生物死亡掉落物品时
EntityDroppedItemServerEvent 触发时机:生物扔出物品时触发
EntityEffectDamageServerEvent 生物受到状态伤害/回复事件。
EntityLoadScriptEvent 数据库加载实体自定义数据时触发
EntityModelChangedClientEvent 触发时机:实体模型切换时触发
EntityMotionStartServerEvent 实体运动器开始事件。实体(包含玩家)添加运动器后,运动器开始运行时触发
EntityMotionStopServerEvent 实体运动器停止事件。实体(包含玩家)添加运动器并开始运行后,运动器自动停止时触发
EntityPickupItemServerEvent 有minecraft:behavior.pickup_items行为的生物拾取物品时触发该事件,例如村民拾取面包、猪灵拾取金锭
EntityStartRidingEvent 当实体骑乘上另一个实体时触发
EntityStopRidingEvent 触发时机:当实体停止骑乘时
EntityTickServerEvent 实体tick时触发。该事件为20帧每秒。需要使用AddEntityTickEventWhiteList添加触发该事件的实体类型白名单。
HealthChangeBeforeServerEvent 生物生命值发生变化之前触发
HealthChangeClientEvent 生物生命值发生变化时触发
HealthChangeServerEvent 生物生命值发生变化时触发
LeaveEntityClientEvent 玩家远离生物时触发
MobDieEvent 实体死亡时触发
MobGriefingBlockServerEvent 环境生物改变方块时触发,触发的时机与mobgriefing游戏规则影响的行为相同
OnFireHurtEvent 生物受到火焰伤害时触发
OnGroundClientEvent 实体着地事件。玩家,沙子,铁砧,掉落的物品,点燃的TNT掉落地面时触发,其余实体着地不触发。
OnGroundServerEvent 实体着地事件。实体,掉落的物品,点燃的TNT掉落地面时触发
OnKnockBackServerEvent 实体被击退时触发
OnMobHitBlockServerEvent 触发时机:通过OpenMobHitBlockDetection打开方块碰撞检测后,当生物(不包括玩家)碰撞到方块时触发该事件。
OnMobHitMobClientEvent 触发时机:通过OpenPlayerHitMobDetection打开生物碰撞检测后,当生物间(包含玩家)碰撞时触发该事件。注:客户端和服务端分别作碰撞检测,可能两个事件返回的略有差异。
OnMobHitMobServerEvent 触发时机:通过OpenPlayerHitMobDetection打开生物碰撞检测后,当生物间(包含玩家)碰撞时触发该事件。注:客户端和服务端分别作碰撞检测,可能两个事件返回的略有差异。
ProjectileCritHitEvent 触发时机:当抛射物与头部碰撞时触发该事件。注:需调用OpenPlayerCritBox开启玩家爆头后才能触发。
ProjectileDoHitEffectEvent 触发时机:当抛射物碰撞时触发该事件
RefreshEffectServerEvent 触发时机:实体身上状态效果更新时触发,更新条件1、新增状态等级较高,更新状态等级及时间;2、新增状态等级不变,时间较长,更新状态持续时间
RemoveEffectServerEvent 触发时机:实体身上状态效果被移除时
SpawnProjectileServerEvent 触发时机:抛射物生成时触发
StartRidingClientEvent 触发时机:一个实体即将骑乘另外一个实体
StartRidingServerEvent 触发时机:一个实体即将骑乘另外一个实体
WillAddEffectServerEvent 触发时机:实体即将获得状态效果前
WillTeleportToServerEvent 实体即将传送或切换维度
AddExpEvent 触发时机:当玩家增加经验时触发该事件。
AddLevelEvent 触发时机:当玩家升级时触发该事件。
CameraMotionStartClientEvent 相机运动器开始事件。相机添加运动器后,运动器开始运行时触发
CameraMotionStopClientEvent 相机运动器停止事件。相机添加运动器并开始运行后,运动器自动停止时触发
ChangeLevelUpCostServerEvent 触发时机:获取玩家下一个等级升级经验时,用于重载玩家的升级经验,每个等级在重置之前都只会触发一次
DimensionChangeClientEvent 玩家维度改变时客户端抛出
DimensionChangeFinishClientEvent 玩家维度改变完成后客户端抛出
DimensionChangeFinishServerEvent 玩家维度改变完成后服务端抛出
DimensionChangeServerEvent 玩家维度改变时服务端抛出
ExtinguishFireClientEvent 玩家扑灭火焰时触发。下雨,倒水等方式熄灭火焰不会触发。
ExtinguishFireServerEvent 玩家扑灭火焰时触发。下雨,倒水等方式熄灭火焰不会触发。
GameTypeChangedClientEvent 个人游戏模式发生变化时客户端触发。
GameTypeChangedServerEvent 个人游戏模式发生变化时服务端触发。
OnPlayerHitBlockClientEvent 触发时机:通过OpenPlayerHitBlockDetection打开方块碰撞检测后,当玩家碰撞到方块时触发该事件。玩家着地时会触发OnGroundClientEvent,而不是该事件。客户端和服务端分别作碰撞检测,可能两个事件返回的结果略有差异。
OnPlayerHitBlockServerEvent 触发时机:通过OpenPlayerHitBlockDetection打开方块碰撞检测后,当玩家碰撞到方块时触发该事件。监听玩家着地请使用客户端的OnGroundClientEvent。客户端和服务端分别作碰撞检测,可能两个事件返回的略有差异。
PerspChangeClientEvent 视角切换时会触发的事件
PlayerAttackEntityEvent 触发时机:当玩家攻击时触发该事件。
PlayerCheatSpinAttackServerEvent 触发时机:玩家开始/结束快速旋转攻击并且不符合发送快速旋转攻击条件时触发(装备激流附魔的三叉戟、在水中或雨中,且未骑乘)
PlayerDieEvent 触发时机:当玩家死亡时触发该事件。
PlayerDoInteractServerEvent 玩家与有minecraft:interact组件的生物交互时触发该事件,例如玩家手持空桶对牛挤奶、玩家手持打火石点燃苦力怕
PlayerEatFoodServerEvent 触发时机:玩家吃下食物时触发
PlayerFeedEntityServerEvent 玩家喂养生物时触发,例如玩家手持小麦喂养牛、玩家手持胡萝卜喂养幼年猪。
PlayerHungerChangeServerEvent 玩家饥饿度变化时触发该事件
PlayerHurtEvent 触发时机:当玩家受伤害前触发该事件。
PlayerInteractServerEvent 触发时机:玩家可以与实体交互时。如果是鼠标控制模式,则当准心对着实体时触发。如果是触屏模式,则触发时机与屏幕下方的交互按钮显示的时机相同。玩家真正与实体发生交互的事件见[PlayerDoInteractServerEvent](玩家.md#playerdointeractserverevent)
PlayerNamedEntityServerEvent 玩家用命名牌重命名实体时触发,例如玩家手持命名牌对羊修改名字、玩家手持命名牌对盔甲架修改名字。
PlayerRespawnEvent 触发时机:玩家复活时触发该事件。
PlayerRespawnFinishServerEvent 触发时机:玩家复活完毕时触发
PlayerSleepServerEvent 玩家使用床睡觉成功
PlayerSpinAttackServerEvent 触发时机:玩家开始/结束快速旋转攻击时触发
PlayerStopSleepServerEvent 玩家停止睡觉
PlayerTeleportEvent 触发时机:当玩家传送时触发该事件,如:玩家使用末影珍珠或tp指令时。
PlayerTrySleepServerEvent 玩家尝试使用床睡觉
ServerPlayerGetExperienceOrbEvent 触发时机:玩家获取经验球时触发的事件
StoreBuySuccServerEvent 触发时机:玩家游戏内购买商品时服务端抛出的事件
BlockDestroyByLiquidServerEvent 触发时机:方块被水流破坏的事件
BlockLiquidStateChangeAfterServerEvent 触发时机:方块转为含水或者脱离含水(流体)后触发
BlockLiquidStateChangeServerEvent 触发时机:方块转为含水或者脱离含水(流体)前触发
BlockNeighborChangedServerEvent 触发时机:自定义方块周围的方块发生变化时,需要配置netease:neighborchanged_sendto_script,详情请查阅《自定义农作物》文档
BlockRandomTickServerEvent 触发时机:自定义方块配置<a href="../../../mcguide/20-玩法开发/15-自定义游戏内容/2-自定义方块/1-JSON组件.html#netease-random-tick">netease:random_tick</a>随机tick时
BlockRemoveServerEvent 触发时机:监听该事件的方块在销毁时触发,可以通过[ListenOnBlockRemoveEvent](方块.md#listenonblockremoveevent)方法进行监听,或者通过json组件<a href="../../../mcguide/20-玩法开发/15-自定义游戏内容/2-自定义方块/1-JSON组件.html#netease-listen-block-remove">netease:listen_block_remove</a>进行配置
BlockSnowStateChangeAfterServerEvent 触发时机:方块转为含雪或者脱离含雪后触发
BlockSnowStateChangeServerEvent 触发时机:方块转为含雪或者脱离含雪前触发
BlockStrengthChangedServerEvent 触发时机:自定义机械元件方块红石信号量发生变化时触发
ChestBlockTryPairWithServerEvent 触发时机:两个并排的小箱子方块准备组合为一个大箱子方块时
ClientBlockUseEvent 触发时机:玩家右键点击新版自定义方块(或者通过接口AddBlockItemListenForUseEvent增加监听的MC原生游戏方块)时客户端抛出该事件(该事件tick执行,需要注意效率问题)。
CommandBlockContainerOpenEvent 触发时机:玩家点击命令方块,尝试打开命令方块的设置界面
CommandBlockUpdateEvent 触发时机:玩家尝试修改命令方块的内置命令时
DestroyBlockEvent 触发时机:当方块已经被玩家破坏时触发该事件。
DirtBlockToGrassBlockServerEvent 触发时机:泥土方块变成草方块时触发
EntityPlaceBlockAfterServerEvent 触发时机:当生物成功放置方块后触发
FallingBlockBreakServerEvent 触发时机:当下落的方块实体被破坏时,服务端触发该事件
FallingBlockCauseDamageBeforeClientEvent 触发时机:当下落的方块开始计算砸到实体的伤害时,客户端触发该事件
FallingBlockCauseDamageBeforeServerEvent 触发时机:当下落的方块开始计算砸到实体的伤害时,服务端触发该事件
FallingBlockReturnHeavyBlockServerEvent 触发时机:当下落的方块实体变回普通重力方块时,服务端触发该事件
FarmBlockToDirtBlockServerEvent 触发时机:耕地退化为泥土时触发
GrassBlockToDirtBlockServerEvent 触发时机:草方块变成泥土方块时触发
HeavyBlockStartFallingServerEvent 触发时机:当重力方块变为下落的方块实体后,服务端触发该事件
HopperTryPullInServerEvent 触发时机:当漏斗上方连接容器后,容器往漏斗开始输入物品时触发,事件仅触发一次
HopperTryPullOutServerEvent 触发时机:当漏斗以毗邻的方式连接容器时,即从旁边连接容器时,漏斗向容器开始输出物品时触发,事件仅触发一次
ModBlockEntityLoadedClientEvent 客户端自定义方块实体初始化完成时触发
ModBlockEntityRemoveClientEvent 客户端自定义方块实体卸载时触发
ModBlockEntityTickClientEvent 客户端自定义方块实体tick事件
OnAfterFallOnBlockClientEvent 触发时机:当实体降落到方块后客户端触发,主要用于力的计算
OnAfterFallOnBlockServerEvent 触发时机:当实体降落到方块后服务端触发,主要用于力的计算
OnBeforeFallOnBlockServerEvent 触发时机:当实体刚降落到方块上时服务端触发,主要用于伤害计算
OnEntityInsideBlockClientEvent 触发时机:当实体碰撞盒所在区域有方块时,客户端持续触发
OnEntityInsideBlockServerEvent 触发时机:当实体碰撞盒所在区域有方块时,服务端持续触发
OnModBlockNeteaseEffectCreatedClientEvent 自定义方块实体绑定的特效创建成功事件,在自定义方块实体中绑定的特效创建成功时触发以及使用接口CreateFrameEffectForBlockEntity或CreateParticleEffectForBlockEntity为自定义方块实体添加特效成功时触发。
OnStandOnBlockClientEvent 触发时机:当实体站立到方块上时客户端持续触发
OnStandOnBlockServerEvent 触发时机:当实体站立到方块上时服务端持续触发
PistonActionServerEvent 触发时机:活塞或者粘性活塞推送/缩回影响附近方块时
PlayerTryDestroyBlockClientEvent 当玩家即将破坏方块时,客户端线程触发该事件。主要用于床,旗帜,箱子这些根据方块实体数据进行渲染的方块,一般情况下请使用ServerPlayerTryDestroyBlockEvent
ServerBlockEntityTickEvent 触发时机:自定义方块配置了netease:block_entity组件并设tick为true,方块在玩家的模拟距离(新建存档时可以设置,默认为4个区块)内,或者在tickingarea内的时候触发
ServerBlockUseEvent 触发时机:玩家右键点击新版自定义方块(或者通过接口AddBlockItemListenForUseEvent增加监听的MC原生游戏方块)时服务端抛出该事件(该事件tick执行,需要注意效率问题)。
ServerEntityTryPlaceBlockEvent 触发时机:当生物试图放置方块时触发该事件。
ServerPlaceBlockEntityEvent 触发时机:手动放置或通过接口创建含自定义方块实体的方块时触发,此时可向该方块实体中存放数据
ServerPlayerTryDestroyBlockEvent 当玩家即将破坏方块时,服务端线程触发该事件。
ShearsDestoryBlockBeforeClientEvent 触发时机:玩家手持剪刀破坏方块时,有剪刀特殊效果的方块会在客户端线程触发该事件
ShearsDestoryBlockBeforeServerEvent 触发时机:玩家手持剪刀破坏方块时,有剪刀特殊效果的方块会在服务端线程触发该事件
StartDestroyBlockClientEvent 玩家开始挖方块时触发。创造模式下不触发。
StartDestroyBlockServerEvent 玩家开始挖方块时触发。创造模式下不触发。
StepOffBlockClientEvent 触发时机:实体移动离开一个实心方块时触发
StepOffBlockServerEvent 触发时机:实体移动离开一个实心方块时触发
StepOnBlockClientEvent 触发时机:实体刚移动至一个新实心方块时触发。
StepOnBlockServerEvent 触发时机:实体刚移动至一个新实心方块时触发。
ActorAcquiredItemClientEvent 触发时机:玩家获得物品时客户端抛出的事件(有些获取物品方式只会触发客户端事件,有些获取物品方式只会触发服务端事件,在使用时注意一点。)
ActorAcquiredItemServerEvent 触发时机:玩家获得物品时服务端抛出的事件(有些获取物品方式只会触发客户端事件,有些获取物品方式只会触发服务端事件,在使用时注意一点。)
ActorUseItemClientEvent 触发时机:玩家使用物品时客户端抛出的事件(比较特殊不走该事件的例子:1)染料对有水的炼药锅使用;2)盔甲架装备盔甲);3)喝牛奶
ActorUseItemServerEvent 触发时机:玩家使用物品生效之前服务端抛出的事件(比较特殊不走该事件的例子:1)染料对有水的炼药锅使用;2)盔甲架装备盔甲)
AnvilCreateResultItemAfterClientEvent 玩家点击铁砧合成得到的物品时抛出的事件。
ClientItemTryUseEvent 玩家点击右键尝试使用物品时客户端抛出的事件,可以通过设置cancel为True取消使用物品。注:如果需要取消物品的使用需要同时在ClientItemTryUseEvent和ServerItemTryUseEvent中将cancel设置为True才能正确取消。
ClientItemUseOnEvent 玩家在对方块使用物品时客户端抛出的事件。注:如果需要取消物品的使用需要同时在ClientItemUseOnEvent和ServerItemUseOnEvent中将ret设置为True才能正确取消。
ClientShapedRecipeTriggeredEvent 玩家合成物品时触发
ContainerItemChangedServerEvent 容器物品变化事件
CraftItemOutputChangeServerEvent 玩家从容器拿出生成物品时触发
CraftUpdateResultItemClientEvent 玩家工作台界面更新显示可合成物品时抛出的事件。
FurnaceBurnFinishedServerEvent 服务端熔炉烧制触发事件。熔炉, 高炉,烟熏炉烧出物品时触发
GrindStoneRemovedEnchantClientEvent 玩家点击砂轮合成得到的物品时抛出的事件
InventoryItemChangedClientEvent 玩家背包物品变化时客户端抛出的事件。
InventoryItemChangedServerEvent 玩家背包物品变化时服务端抛出的事件。
ItemDurabilityChangedServerEvent 物品耐久度变化事件
ItemReleaseUsingClientEvent 触发时机:释放正在使用的物品
ItemReleaseUsingServerEvent 触发时机:释放正在使用的物品时
ItemUseAfterServerEvent 玩家在使用物品之后服务端抛出的事件。
ItemUseOnAfterServerEvent 玩家在对方块使用物品之后服务端抛出的事件。
OnCarriedNewItemChangedClientEvent 手持物品发生变化时,触发该事件;数量改变不会通知
OnCarriedNewItemChangedServerEvent 触发时机:玩家切换主手物品时触发该事件
OnItemPutInEnchantingModelServerEvent 触发时机:玩家将可附魔物品放到附魔台上时
OnNewArmorExchangeServerEvent 触发时机:玩家切换盔甲时触发该事件
OnOffhandItemChangedServerEvent 触发时机:玩家切换副手物品时触发该事件
OnPlayerActiveShieldServerEvent 触发时机:玩家激活/取消激活盾牌触发的事件。包括玩家持盾进入潜行状态,以及在潜行状态切换盾牌(切换耐久度不同的相同盾牌不会触发)
OnPlayerBlockedByShieldAfterServerEvent 触发时机:玩家使用盾牌抵挡伤害之后触发
OnPlayerBlockedByShieldBeforeServerEvent 触发时机:玩家使用盾牌抵挡伤害之前触发
PlayerDropItemServerEvent 触发时机:玩家丢弃物品时触发
PlayerTryDropItemClientEvent 触发时机:玩家丢弃物品时触发
ServerItemTryUseEvent 玩家点击右键尝试使用物品时服务端抛出的事件。注:如果需要取消物品的使用需要同时在ClientItemTryUseEvent和ServerItemTryUseEvent中将cancel设置为True才能正确取消。
ServerItemUseOnEvent 玩家在对方块使用物品之前服务端抛出的事件。注:如果需要取消物品的使用需要同时在ClientItemUseOnEvent和ServerItemUseOnEvent中将ret设置为True才能正确取消。
ServerPlayerTryTouchEvent 玩家即将捡起物品时触发
ShearsUseToBlockBeforeServerEvent 触发时机:实体手持剪刀对方块使用时,有剪刀特殊效果的方块会在服务端线程触发该事件
StartUsingItemClientEvent 玩家使用物品(目前仅支持Bucket(奶桶)、Trident(三叉戟)、RangedWeapon(弓)、Food(食物)、Potion(药水)、Crossbow(弩))时抛出
StopUsingItemClientEvent 玩家停止使用物品(目前仅支持Bucket(奶桶)、Trident(三叉戟)、RangedWeapon(弓)、Food(食物)、Potion(药水)、Crossbow(弩))时抛出
UIContainerItemChangedServerEvent 合成容器物品发生变化时触发
AttackAnimBeginClientEvent 攻击动作开始时触发
AttackAnimBeginServerEvent 当攻击动作开始时触发
AttackAnimEndClientEvent 攻击动作结束时触发
AttackAnimEndServerEvent 当攻击动作结束时触发
JumpAnimBeginServerEvent 当跳跃动作开始时触发
WalkAnimBeginClientEvent 走路动作开始时触发
WalkAnimBeginServerEvent 当走路动作开始时触发
WalkAnimEndClientEvent 走路动作结束时触发
WalkAnimEndServerEvent 当走路动作结束时触发
AchievementButtonMovedClientEvent 触发时机:使用自定义成就系统的时,拖动成就入口结束时触发
ClientChestCloseEvent 关闭箱子界面时触发,包括小箱子,合并后大箱子和末影箱(实体容器不属于方块,不会触发该事件)
ClientChestOpenEvent 打开箱子界面时触发,包括小箱子,合并后大箱子和末影箱(实体容器不属于方块,不会触发该事件)
ClientPlayerInventoryCloseEvent 关闭物品背包界面时触发
ClientPlayerInventoryOpenEvent 打开物品背包界面时触发
CloseNeteaseShopEvent 关闭商城界面时触发,包括脚本商城和Apollo插件商城
GridComponentSizeChangedClientEvent 触发时机:UI grid组件里格子数目发生变化时触发
OnItemSlotButtonClickedEvent 点击快捷栏、背包栏、盔甲栏、副手栏的物品槽时触发
PlayerChatButtonClickClientEvent 玩家点击聊天按钮或回车键触发呼出聊天窗口时客户端抛出的事件
PlayerInventoryOpenScriptServerEvent 某个客户端打开物品背包界面时触发
PopScreenAfterClientEvent screen移除触发
PopScreenEvent screen移除触发
PushScreenEvent screen创建触发
ScreenSizeChangedClientEvent 改变屏幕大小时会触发的事件
UiInitFinished UI初始化框架完成,此时可以创建UI
UrgeShipEvent 玩家点击商城催促发货按钮时触发该事件
OnMusicStopClientEvent 音乐停止时,当玩家调用StopCustomMusic来停止自定义背景音乐时,会触发该事件
PlayMusicClientEvent 播放背景音乐时触发
PlaySoundClientEvent 播放场景音效或UI音效时触发
ClientJumpButtonPressDownEvent 跳跃按钮按下事件,返回值设置参数只对当次按下事件起作用
ClientJumpButtonReleaseEvent 跳跃按钮按下释放事件
GetEntityByCoordEvent 玩家点击屏幕时触发,多个手指点在屏幕上时,只有第一个会触发。
GetEntityByCoordReleaseClientEvent 玩家点击屏幕后松开时触发,多个手指点在屏幕上时,只有最后一个手指松开时触发。
GyroSensorChangedClientEvent 触发时机:陀螺仪传感器姿态发生变化时
HoldBeforeClientEvent 玩家长按屏幕,即将响应到游戏内时触发。仅在移动端或pc的F11模式下触发。pc的非F11模式可以使用RightClickBeforeClientEvent事件监听鼠标右键
LeftClickBeforeClientEvent 玩家按下鼠标左键时触发。仅在pc的普通控制模式(即非F11模式)下触发。
LeftClickReleaseClientEvent 玩家松开鼠标左键时触发。仅在pc的普通控制模式(即非F11模式)下触发。
MouseWheelClientEvent 鼠标滚轮滚动时触发
OnBackButtonReleaseClientEvent 返回按钮(目前特指安卓系统导航中的返回按钮)松开时触发
OnClientPlayerStartMove 移动按钮按下触发事件,在按住一个方向键的同时,去按另外一个方向键,不会触发第二次
OnClientPlayerStopMove 移动按钮按下释放时触发事件,同时按下多个方向键,需要释放所有的方向键才会触发事件
OnGamepadControllerLayoutChangeClientEvent 游戏手柄按键映射改变事件
OnGamepadKeyPressClientEvent 游戏手柄按键事件
OnGamepadStickClientEvent 游戏手柄摇杆事件
OnGamepadTriggerClientEvent 游戏手柄扳机事件
OnKeyPressInGame 按键按下或按键释放时触发
OnKeyboardControllerLayoutChangeClientEvent 键盘按键映射改变事件
OnMouseMiddleDownClientEvent 鼠标按下中键时触发
RightClickBeforeClientEvent 玩家按下鼠标右键时触发。仅在pc下触发(普通控制模式及F11模式都会触发)。
RightClickReleaseClientEvent 玩家松开鼠标右键时触发。仅在pc的普通控制模式(即非F11模式)下触发。在F11下右键,按下会触发RightClickBeforeClientEvent,松开时会触发TapOrHoldReleaseClientEvent
TapBeforeClientEvent 玩家点击屏幕并松手,即将响应到游戏内时触发。仅在移动端或pc的F11模式下触发。pc的非F11模式可以使用LeftClickBeforeClientEvent事件监听鼠标左键
TapOrHoldReleaseClientEvent 玩家点击屏幕后松手时触发。仅在移动端或pc的F11模式下触发。pc的非F11模式可以使用LeftClickReleaseClientEvent与RightClickReleaseClientEvent事件监听鼠标松开
lobbyGoodBuySucServerEvent 玩家登录联机大厅服务器,或者联机大厅游戏内购买商品时触发。如果是玩家登录,触发时玩家客户端已经触发了UiInitFinished事件

登录

未登录

问题分类标签栏

0/150

我要反馈

img选择分类标签可让反馈更有效