Skip to content

索引 ​


地图 ​

接口
描述
CanSee服务端判断起始对象是否可看见目标对象,基于对象的Head位置判断
CanSee客户端判断起始对象是否可看见目标对象,基于对象的Head位置判断
CheckBlockToPos服务端判断位置之间是否有方块
CheckChunkState服务端判断指定位置的chunk是否加载完成
CreateDimension服务端创建新的dimension
CreateExplosion服务端用于生成爆炸
DeleteAllArea服务端删除所有常加载区域
DeleteArea服务端删除一个常加载区域
DetectStructure服务端检测自定义门的结构
DoTaskOnChunkAsync服务端异步加载指定范围区块,加载完成后调用输入的回调函数。
GetAllAreaKeys服务端获取所有常加载区域名称列表
GetBiomeInfo服务端获取群系天气相关参数
GetBiomeName服务端获取某一位置所属的生物群系信息
GetBiomeName客户端获取客户端当前维度已加载区域某一位置所属的生物群系信息
GetBlockLightLevel服务端获取方块位置的光照等级
GetChunkEntites服务端获取指定位置的区块中,全部的实体和玩家的ID列表
GetChunkMaxPos服务端获取某区块最大点的坐标
GetChunkMinPos服务端获取某区块最小点的坐标
GetChunkMobNum服务端获取某区块中的生物数量(不包括玩家,但包括盔甲架)
GetChunkPosFromBlockPos服务端通过方块坐标获得该方块所在区块坐标
GetChunkPosFromBlockPos客户端通过方块坐标获得该方块所在区块坐标
GetCurrentDimension客户端获取客户端当前维度
GetEntitiesAround服务端获取区域内的entity列表
GetEntitiesAround客户端获取区域内的entity列表
GetEntitiesAroundByType服务端获取区域内的某类型的entity列表
GetEntitiesAroundByType客户端获取区域内的某类型的entity列表
GetEntitiesAroundForClientEntity客户端获取区域内的客户端实体列表
GetEntitiesInSquareArea服务端获取区域内的entity列表
GetEntitiesInSquareArea客户端获取区域内的entity列表
GetEntitiesInSquareAreaForClientEntity客户端获取区域内的客户端实体列表
GetLevelId服务端获取levelId。某些组件需要levelId创建,可以用此接口获取levelId。其中level即为当前地图的游戏。
GetLevelId客户端获取levelId。某些组件需要levelId创建,可以用此接口获取levelId。其中level即为当前地图的游戏。
GetLoadedChunks服务端获取指定维度当前已经加载完毕的全部区块的坐标列表
GetSpawnDimension服务端获取世界出生维度
GetSpawnPosition服务端获取世界出生点坐标
GetStructureSize服务端获取结构体的长宽高
IsChunkGenerated服务端获取某个区块是否生成过。
IsSlimeChunk服务端获取某个区块是否是史莱姆区块。
LocateNeteaseFeatureRule服务端与/locate指令相似,用于定位网易自定义特征规则
LocateStructureFeature服务端与/locate指令相似,用于定位原版的部分结构,如海底神殿、末地城等。
MayPlace服务端判断方块是否可以放置
MayPlaceOn服务端判断物品是否可以放到指定的位置上
MirrorDimension服务端复制不同dimension的地形
OpenClientChunkGeneration服务端开启/关闭客户端区块生成功能,需要在LoadServerAddonScriptsAfter事件触发时调用。开启客户端区块生成功能时,如果使用了netease:structure_feature或修改了大部分地图,会导致客户端和服务端地图不一致的问题。此时可以通过关闭客户端区块生成功能解决该问题。
PlaceFeature服务端放置特征,与/placefeature指令相似
PlaceNeteaseLargeFeature服务端放置网易版大型结构特征
PlaceStructure服务端放置结构
SetAddArea服务端设置区块的常加载
SetBiomeByPos服务端设置某一位置所属的生物群系信息
SetBiomeByPosList服务端设置所有列表中位置所属的生物群系信息
SetBiomeByVolume服务端设置长方体空间中所属的生物群系信息
SetBiomeInfo服务端设置群系天气相关参数
SetMergeSpawnItemRadius服务端设置新生成的物品是否合堆
SetSpawnDimensionAndPosition服务端设置世界出生点维度与坐标
UpgradeMapDimensionVersion服务端提升指定地图维度的版本号,版本号不符的维度,地图存档信息将被废弃。使用后存档的地图版本均会同步提升至最新版本,假如希望使用此接口清理指定维度的地图存档,需要在保证该维度区块都没有被加载时调用。

实体管理 ​

接口
描述
CreateClientEntityByTypeStr客户端创建客户端实体
CreateEngineEntityByNBT服务端根据nbt数据创建实体
CreateEngineEntityByTypeStr服务端创建指定identifier的实体
CreateEngineItemEntity服务端用于创建物品实体(即掉落物),返回物品实体的entityId
CreateEntityAOI服务端注册感应区域,有实体进入时和离开时会触发回调函数func
CreateExperienceOrb服务端创建专属经验球
CreateProjectileEntity服务端创建抛射物(直接发射)
DeleteEntityAOI服务端删除使用CreateEntityAOI注册的感应区
DestroyClientEntity客户端销毁客户端实体
DestroyEntity服务端销毁实体
GetDroppedItem服务端获取掉落物的物品信息
GetEngineActor服务端获取所有维度中已加载的所有实体(不包含玩家)。
GetEngineActor客户端获取客户端当前维度中已加载的所有实体(不包含玩家)。
GetLocalPlayerId客户端获取本地玩家的id
GetLootItems服务端指定战利品表获取一次战利品,返回的物品与json定义的概率有关
GetPlayerList服务端获取所有维度中的全部玩家的id列表
GetPlayerList客户端获取所有维度中的全部玩家的id列表
HasEntity客户端判断 entity 是否存在
IsEntityAlive服务端判断生物实体是否存活或非生物实体是否存在
IsEntityAlive客户端判断生物实体是否存活或非生物实体是否存在
KillEntity服务端杀死某个Entity
SpawnLootTable服务端使用生物类型模拟一次随机掉落,生成的物品与json定义的概率有关
SpawnLootTableWithActor服务端使用生物实例模拟一次随机掉落,生成的物品与json定义的概率有关
SpawnResources服务端产生方块随机掉落(该方法不适用于实体方块)
SpawnResourcesSilkTouched服务端模拟方块精准采集掉落
getEntitiesOrBlockFromRay服务端从指定位置发射一条射线,获取与射线相交的实体和方块
getEntitiesOrBlockFromRay客户端从指定位置发射一条射线,获取与射线相交的实体和方块

方块管理 ​

接口
描述
GetBlock客户端获取某一位置的block
GetBlockClip服务端获取某一位置方块当前clip的aabb
GetBlockClip客户端获取指定位置方块当前clip的aabb
GetBlockCollision服务端获取某一位置方块当前collision的aabb
GetBlockCollision客户端获取指定位置方块当前collision的aabb
GetBlockNew服务端获取某一位置的block
GetDestroyTotalTime服务端获取使用物品破坏方块需要的时间
GetDestroyTotalTime客户端获取使用物品破坏方块需要的时间
GetLiquidBlock服务端获取某个位置的方块所含流体的信息
GetTopBlockHeight服务端获取某一位置最高的非空气方块的高度
GetTopBlockHeight客户端获取当前维度某一位置最高的非空气方块的高度
SetBlockNew服务端设置某一位置的方块
SetJigsawBlock服务端在某一位置放置拼图方块
SetLiquidBlock服务端设置某一位置的方块的extraBlock,可在此设置方块含水等
SetSnowBlock服务端设置某一位置的方块含雪

生物生成 ​

接口
描述
GetEntityLimit服务端获取世界最大可生成实体数量上限。可生成实体的含义见SetEntityLimit
SetEntityLimit服务端设置世界最大可生成实体数量上限。可生成实体指具有spawnrule的实体。当前世界上被加载的可生成实体数量超过这个上限时,生物就不会再通过spawnrule刷出。
SpawnCustomModule服务端设置自定义刷怪

配方 ​

接口
描述
AddBrewingRecipes服务端添加酿造台配方的接口
AddRecipe服务端动态注册配方,支持配方类型详见[配方类型说明]
GetRecipeByRecipeId服务端根据配方id查询配方内容。
GetRecipeByRecipeId客户端根据配方id查询配方内容。
GetRecipeResult服务端根据配方id获取配方结果。仅支持合成配方
GetRecipesByInput服务端通过输入物品查询配方
GetRecipesByInput客户端通过输入物品查询配方
GetRecipesByResult服务端通过输出物品查询配方所需要的输入材料
GetRecipesByResult客户端通过输出物品查询配方所需要的输入材料
RemoveRecipe服务端动态禁用配方

方块组合 ​

接口
描述
CreateMicroBlockResStr服务端生成微缩方块资源Json字符串
GetBlankBlockPalette服务端获取一个空白的方块调色板。
GetBlankBlockPalette客户端获取一个空白的方块调色板。
GetBlockPaletteBetweenPos服务端根据输入的两个方块位置创建并获取一个方块调色板,方块调色板用于描述和记录世界中的多个方块的组合。这个方块调色板包含了这两个位置之间的所有方块及其相对位置。
GetBlockPaletteBetweenPos客户端根据输入的两个位置创建并获取一个方块调色板,该接口会搜索这两个位置之间的所有方块创建方块调色板,方块调色板用于描述和记录世界中的多个方块的组合。这个方块调色板包含了这两个位置之间的所有方块及其相对位置。
GetBlockPaletteFromPosList服务端根据输入的方块位置列表创建并获取一个方块调色板,方块调色板用于描述和记录世界中的多个方块的组合。创建的方块调色板包含了这个位置列表中的所有方块及其相对位置。
GetBlockPaletteFromPosList客户端根据输入的方块位置列表创建并获取一个方块调色板,方块调色板用于描述和记录世界中的多个方块的组合。创建的方块调色板包含了这个位置列表中的所有方块及其相对位置。
RegisterBlockPatterns服务端注册特殊方块组合
SetBlockByBlockPalette服务端根据输入的方块调色板内容,将调色板内记录的所有方块设置为实际的方块。

渲染 ​

接口
描述
AddTerrainDestroyParticleEffect客户端在指定位置播放指定方块被开始破坏时的粒子效果(如果有)。
AddUseItemParticleEffect客户端在指定位置播放指定物品被开始使用时的粒子效果(如果有)。
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客户端获取是否隐藏场景内所有名字
RemoveTerrainDestroyParticleEffect客户端停止指定位置播放的方块被开始破坏时的粒子效果。
RemoveUseItemParticleEffect客户端停止指定位置播放的物品被开始使用时的粒子效果。
ResetAmbientBrightness客户端重置环境光亮度
ResetFogColor客户端重置雾效颜色
ResetFogLength客户端重置雾效范围
ResetMoonRot客户端重置月亮角度
ResetSkyColor客户端重置天空颜色
ResetSkyTextures客户端重置当前维度天空盒贴图。如果有使用addon配置贴图则会使用配置的贴图,否则为游戏内默认无贴图的情况
ResetStarBrightness客户端重置星星亮度
ResetSunRot客户端重置太阳角度
SetAmbientBrightness客户端设置环境光亮度,影响天空亮度,不影响实体与方块光照
SetFogColor客户端设置雾效颜色
SetFogLength客户端设置雾效范围
SetMoonRot客户端设置月亮所在角度
SetSkyColor客户端设置天空颜色
SetSkyTextures客户端设置当前维度天空盒贴图,天空盒需要6张贴图
SetStarBrightness客户端设置星星亮度,白天也可以显示星星
SetSunRot客户端设置太阳所在角度
SkyTextures客户端修改太阳、月亮、云层分布、天空盒的贴图。使用addon配置,非python接口。

时间 ​

接口
描述
GetLocalDoDayNightCycle服务端获取维度是否打开昼夜更替
GetLocalTime服务端获取维度的时间
GetLocalTime客户端获取当前维度的时间
GetTime服务端获取当前世界时间
GetTime客户端获取当前世界时间
GetUseLocalTime服务端获取某个维度是否设置了使用局部时间规则
SetLocalDoDayNightCycle服务端设置使用局部时间规则的维度是否打开昼夜更替
SetLocalTime服务端设置使用局部时间规则维度的时间
SetLocalTimeOfDay服务端设置使用局部时间规则维度在一天内所在的时间
SetTime服务端设置当前世界时间
SetTimeOfDay服务端设置当前世界在一天内所在的时间
SetUseLocalTime服务端让某个维度拥有自己的局部时间规则,开启后该维度可以拥有与其他维度不同的时间与是否昼夜更替的规则

天气 ​

接口
描述
GetDimensionLocalWeatherInfo服务端获取独立维度天气信息(必须先使用SetDimensionUseLocalWeather接口设置此维度拥有自己的独立天气)
GetDimensionUseLocalWeather服务端获取某个维度是否拥有自己的天气规则
IsRaining服务端获取是否下雨
IsThunder服务端获取是否打雷
SetDimensionLocalDoWeatherCycle服务端设置某个维度是否开启天气循环(必须先使用SetDimensionUseLocalWeather接口设置此维度拥有自己的独立天气)
SetDimensionLocalRain服务端设置某个维度下雨(必须先使用SetDimensionUseLocalWeather接口设置此维度拥有自己的独立天气)
SetDimensionLocalThunder服务端设置某个维度打雷(必须先使用SetDimensionUseLocalWeather接口设置此维度拥有自己的独立天气)
SetDimensionUseLocalWeather服务端设置某个维度拥有自己的天气规则,开启后该维度可以拥有与其他维度不同的天气和天气更替的规则
SetRaining服务端设置是否下雨
SetThunder服务端设置是否打雷

游戏规则 ​

接口
描述
AddBannedItem服务端增加禁用物品
AddBlockProtectFieldApollo设置一个方块无法被玩家/实体破坏的区域
CleanBlockProtectFieldApollo取消全部已设置的方块无法被玩家/实体破坏的区域
ClearBannedItems服务端清空禁用物品
DisableVineBlockSpread服务端设置是否禁用藤曼蔓延生长
ForbidLiquidFlow服务端禁止/允许地图中的流体流动
GetBannedItemList服务端获取禁用物品列表
GetGameDiffculty服务端获取游戏难度
GetGameRulesInfoServer服务端获取游戏规则
GetGameType服务端获取默认游戏模式
GetLevelGravity服务端获取重力因子
GetPistonMaxInteractionCount服务端获取活塞/粘性活塞最多推动的方块数量,默认为12个方块,可能被其他开发者修改。
GetPistonMaxInteractionCount客户端获取活塞/粘性活塞最多推动的方块数量,默认为12个方块,可能被其他开发者修改。
GetSeed服务端获取存档种子
IsDisableCommandMinecart服务端获取当前是否允许运行命令方块矿车内置逻辑指令,当前仅Apollo网络服可用
IsLockDifficulty服务端获取当前世界的游戏难度是否被锁定
IsLockGameRulesInfo服务端获取当前世界的游戏规则是否被锁定
IsLockGameType服务端获取当前世界的游戏类型是否被锁定,包括默认游戏类型和个人游戏类型
LockDifficulty服务端锁定当前世界游戏难度(仅本次游戏有效),锁定后任何玩家在游戏内都无法通过指令或暂停菜单修改游戏难度
LockGameRulesInfo服务端锁定当前世界游戏规则(仅本次游戏有效),玩家无法通过指令、游戏菜单或api修改游戏规则(包括SetGameRulesInfoServer示例中列举的规则)
LockGameType服务端锁定当前世界游戏类型(仅本次游戏有效),玩家无法通过指令、游戏菜单或相关api如SetPlayerGameType和SetDefaultGameType修改游戏类型,包括默认游戏类型和个人游戏类型
OpenCityProtectApollo开启城市保护,包括禁止破坏方块,禁止对方块使用物品,禁止怪物攻击玩家,禁止玩家之间互相攻击,禁止日夜切换,禁止天气变化,禁止怪物群落刷新
RemoveBannedItem服务端移除禁用物品
RemoveBlockProtectFieldApollo取消一个方块无法被玩家/实体破坏的区域
SetCanActorSetOnFireByLightning服务端禁止/允许闪电点燃实体
SetCanBlockSetOnFireByLightning服务端禁止/允许闪电点燃方块
SetDefaultGameType服务端设置默认游戏模式
SetDisableCommandMinecart服务端设置停止/开启运行命令方块矿车内置逻辑指令,当前仅Apollo网络服可用
SetDisableContainers服务端禁止所有容器界面的打开,包括玩家背包,各种包含背包界面的容器方块如工作台与箱子,以及包含背包界面的实体交互如马背包与村民交易
SetDisableDropItem服务端设置禁止丢弃物品
SetDisableGravityInLiquid服务端是否屏蔽所有实体在液体(水、岩浆)中的重力
SetDisableHunger服务端设置是否屏蔽饥饿度
SetGameDifficulty服务端设置游戏难度
SetGameRulesInfoServer服务端设置游戏规则。所有参数均可选。
SetHurtCD服务端设置全局受击间隔CD
SetLevelGravity服务端设置重力因子
SetPistonMaxInteractionCount服务端设置活塞/粘性活塞最多推动的方块数量,默认为12个方块。该设置不存档。

自定义数据 ​

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

指令 ​

接口
描述
GetCommandPermissionLevel服务端返回设定使用/op命令时OP的权限等级(对应server.properties中的op-permission-level配置)
GetDefaultPlayerPermissionLevel服务端返回新玩家加入时的权限身份(对应server.properties中的default-player-permission-level配置)
SetCommand服务端使用游戏内指令
SetCommandPermissionLevel服务端设置当玩家使用/op命令时OP的权限等级(对应server.properties中的op-permission-level配置)
SetDefaultPlayerPermissionLevel服务端设置新玩家加入时的权限身份(对应server.properties中的default-player-permission-level配置)

消息 ​

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

记分板 ​

接口
描述
GetAllPlayerScoreboardObjects服务端获取玩家记分项
GetAllPlayerScoreboardObjects客户端获取玩家记分项
GetAllScoreboardObjects服务端获取所有记分板项
GetAllScoreboardObjects客户端获取所有记分板项

行为 ​

接口
描述
EntityUseItemToPos服务端模拟实体对某个坐标使用指定物品。
UseItemAttackEntity服务端使用指定物品攻击某个实体。
UseItemToEntity服务端模拟对某个实体使用物品。