# 索引
# 地图
| 接口 | 描述 | |
|---|---|---|
| CanSee | 服务端 | 判断起始对象是否可看见目标对象,基于对象的Head位置判断 |
| CheckBlockToPos | 服务端 | 判断位置之间是否有方块 |
| CheckChunkState | 服务端 | 判断指定位置的chunk是否加载完成 |
| CreateDimension | 服务端 | 创建新的dimension |
| CreateExplosion | 服务端 | 用于生成爆炸 |
| DeleteAllArea | 服务端 | 删除所有常加载区域 |
| DeleteArea | 服务端 | 删除一个常加载区域 |
| DetectStructure | 服务端 | 检测自定义门的结构 |
| DoTaskOnChunkAsync | 服务端 | 异步加载指定范围区块，加载完成后调用输入的回调函数。 |
| GetAllAreaKeys | 服务端 | 获取所有常加载区域名称列表 |
| GetBiomeInfo | 服务端 | 获取群系天气相关参数 |
| GetBiomeName | 服务端 | 获取某一位置所属的生物群系信息 |
| GetBiomeName | 客户端 | 获取客户端当前维度已加载区域某一位置所属的生物群系信息 |
| GetBlockLightLevel | 服务端 | 获取方块位置的光照等级 |
| GetChunkEntites | 服务端 | 获取指定位置的区块中，全部的实体和玩家的ID列表 |
| GetChunkMaxPos | 服务端 | 获取某区块最大点的坐标 |
| GetChunkMinPos | 服务端 | 获取某区块最小点的坐标 |
| GetChunkMobNum | 服务端 | 获取某区块中的生物数量（不包括玩家，但包括盔甲架） |
| GetChunkPosFromBlockPos | 服务端 | 通过方块坐标获得该方块所在区块坐标 |
| GetChunkPosFromBlockPos | 客户端 | 通过方块坐标获得该方块所在区块坐标 |
| GetCurrentDimension | 客户端 | 获取客户端当前维度 |
| GetEntitiesAround | 服务端 | 获取区域内的entity列表 |
| GetEntitiesAround | 客户端 | 获取区域内的entity列表 |
| GetEntitiesAroundByType | 服务端 | 获取区域内的某类型的entity列表 |
| GetEntitiesAroundByType | 客户端 | 获取区域内的某类型的entity列表 |
| GetEntitiesInSquareArea | 服务端 | 获取区域内的entity列表 |
| GetEntitiesInSquareArea | 客户端 | 获取区域内的entity列表 |
| GetLevelId | 服务端 | 获取levelId。某些组件需要levelId创建，可以用此接口获取levelId。其中level即为当前地图的游戏。 |
| GetLevelId | 客户端 | 获取levelId。某些组件需要levelId创建，可以用此接口获取levelId。其中level即为当前地图的游戏。 |
| GetLoadedChunks | 服务端 | 获取指定维度当前已经加载完毕的全部区块的坐标列表 |
| GetSpawnDimension | 服务端 | 获取世界出生维度 |
| GetSpawnPosition | 服务端 | 获取世界出生点坐标 |
| GetStructureSize | 服务端 | 获取结构体的长宽高 |
| IsChunkGenerated | 服务端 | 获取某个区块是否生成过。 |
| IsSlimeChunk | 服务端 | 获取某个区块是否是史莱姆区块。 |
| LocateNeteaseFeatureRule | 服务端 | 与/locate指令 (opens new window)相似，用于定位网易自定义特征规则 |
| LocateStructureFeature | 服务端 | 与/locate指令 (opens new window)相似，用于定位原版的部分结构，如海底神殿、末地城等。 |
| MayPlace | 服务端 | 判断方块是否可以放置 |
| MayPlaceOn | 服务端 | 判断物品是否可以放到指定的位置上 |
| MirrorDimension | 服务端 | 复制不同dimension的地形 |
| OpenClientChunkGeneration | 服务端 | 开启/关闭客户端区块生成功能，需要在LoadServerAddonScriptsAfter事件触发时调用。开启客户端区块生成功能时，如果使用了netease:structure_feature或修改了大部分地图，会导致客户端和服务端地图不一致的问题。此时可以通过关闭客户端区块生成功能解决该问题。 |
| PlaceFeature | 服务端 | 放置特征，与/placefeature指令 (opens new window)相似 |
| PlaceNeteaseLargeFeature | 服务端 | 放置网易版大型结构特征 |
| PlaceStructure | 服务端 | 放置结构 |
| SetAddArea | 服务端 | 设置区块的常加载 |
| SetBiomeByPos | 服务端 | 设置某一位置所属的生物群系信息 |
| SetBiomeByPosList | 服务端 | 设置所有列表中位置所属的生物群系信息 |
| SetBiomeByVolume | 服务端 | 设置长方体空间中所属的生物群系信息 |
| SetBiomeInfo | 服务端 | 设置群系天气相关参数 |
| SetMergeSpawnItemRadius | 服务端 | 设置新生成的物品是否合堆 |
| SetSpawnDimensionAndPosition | 服务端 | 设置世界出生点维度与坐标 |
| UpgradeMapDimensionVersion | 服务端 | 提升指定地图维度的版本号，版本号不符的维度，地图存档信息将被废弃。使用后存档的地图版本均会同步提升至最新版本，假如希望使用此接口清理指定维度的地图存档，需要在保证该维度区块都没有被加载时调用。 |
# 实体管理
| 接口 | 描述 | |
|---|---|---|
| CreateEngineEntityByNBT | 服务端 | 根据nbt数据创建实体 |
| CreateEngineEntityByTypeStr | 服务端 | 创建指定identifier的实体 |
| CreateEngineItemEntity | 服务端 | 用于创建物品实体（即掉落物），返回物品实体的entityId |
| CreateEntityAOI | 服务端 | 注册感应区域，有实体进入时和离开时会触发回调函数func |
| CreateExperienceOrb | 服务端 | 创建专属经验球 |
| CreateProjectileEntity | 服务端 | 创建抛射物（直接发射） |
| DeleteEntityAOI | 服务端 | 删除使用CreateEntityAOI注册的感应区 |
| DestroyEntity | 服务端 | 销毁实体 |
| GetDroppedItem | 服务端 | 获取掉落物的物品信息 |
| GetEngineActor | 服务端 | 获取所有维度中已加载的所有实体（不包含玩家）。 |
| GetEngineActor | 客户端 | 获取客户端当前维度中已加载的所有实体（不包含玩家）。 |
| GetLocalPlayerId | 客户端 | 获取本地玩家的id |
| GetLootItems | 服务端 | 指定战利品表获取一次战利品，返回的物品与json定义的概率有关 |
| GetPlayerList | 服务端 | 获取所有维度中的全部玩家的id列表 |
| GetPlayerList | 客户端 | 获取所有维度中的全部玩家的id列表 |
| HasEntity | 客户端 | 判断 entity 是否存在 |
| IsEntityAlive | 服务端 | 判断生物实体是否存活或非生物实体是否存在 |
| IsEntityAlive | 客户端 | 判断生物实体是否存活或非生物实体是否存在 |
| KillEntity | 服务端 | 杀死某个Entity |
| SpawnItemToLevel | 服务端 | 生成物品掉落物，如果需要获取物品的entityId，可以调用服务端系统接口CreateEngineItemEntity |
| SpawnLootTable | 服务端 | 使用生物类型模拟一次随机掉落，生成的物品与json定义的概率有关 |
| SpawnLootTableWithActor | 服务端 | 使用生物实例模拟一次随机掉落，生成的物品与json定义的概率有关 |
| SpawnResources | 服务端 | 产生方块随机掉落（该方法不适用于实体方块） |
| SpawnResourcesSilkTouched | 服务端 | 模拟方块精准采集掉落 |
| getEntitiesOrBlockFromRay | 服务端 | 从指定位置发射一条射线，获取与射线相交的实体和方块 |
# 方块管理
| 接口 | 描述 | |
|---|---|---|
| GetBlock | 客户端 | 获取某一位置的block |
| GetBlockClip | 服务端 | 获取某一位置方块当前clip的aabb |
| GetBlockClip | 客户端 | 获取指定位置方块当前clip的aabb |
| GetBlockCollision | 服务端 | 获取某一位置方块当前collision的aabb |
| GetBlockCollision | 客户端 | 获取指定位置方块当前collision的aabb |
| GetBlockNew | 服务端 | 获取某一位置的block |
| GetDestroyTotalTime | 服务端 | 获取使用物品破坏方块需要的时间 |
| GetDestroyTotalTime | 客户端 | 获取使用物品破坏方块需要的时间 |
| GetLiquidBlock | 服务端 | 获取某个位置的方块所含流体的信息 |
| GetTopBlockHeight | 服务端 | 获取某一位置最高的非空气方块的高度 |
| GetTopBlockHeight | 客户端 | 获取当前维度某一位置最高的非空气方块的高度 |
| SetBlockNew | 服务端 | 设置某一位置的方块 |
| SetJigsawBlock | 服务端 | 在某一位置放置拼图方块 |
| SetLiquidBlock | 服务端 | 设置某一位置的方块的extraBlock，可在此设置方块含水等 |
| SetSnowBlock | 服务端 | 设置某一位置的方块含雪 |
# 生物生成
| 接口 | 描述 | |
|---|---|---|
| GetEntityLimit | 服务端 | 获取世界最大可生成实体数量上限。可生成实体的含义见SetEntityLimit |
| SetEntityLimit | 服务端 | 设置世界最大可生成实体数量上限。可生成实体指具有spawnrule的实体。当前世界上被加载的可生成实体数量超过这个上限时，生物就不会再通过spawnrule刷出。 |
| SpawnCustomModule | 服务端 | 设置自定义刷怪 |
# 配方
| 接口 | 描述 | |
|---|---|---|
| AddBrewingRecipes | 服务端 | 添加酿造台配方的接口 |
| AddRecipe | 服务端 | 动态注册配方，支持配方类型详见[配方类型说明] |
| GetRecipeResult | 服务端 | 根据配方id获取配方结果。仅支持合成配方 |
| GetRecipesByInput | 服务端 | 通过输入物品查询配方 |
| GetRecipesByInput | 客户端 | 通过输入物品查询配方 |
| GetRecipesByResult | 服务端 | 通过输出物品查询配方所需要的输入材料 |
| GetRecipesByResult | 客户端 | 通过输出物品查询配方所需要的输入材料 |
| RemoveRecipe | 服务端 | 动态禁用配方 |
# 方块组合
| 接口 | 描述 | |
|---|---|---|
| CreateMicroBlockResStr | 服务端 | 生成微缩方块资源Json字符串 |
| GetBlankBlockPalette | 服务端 | 获取一个空白的方块调色板。 |
| GetBlankBlockPalette | 客户端 | 获取一个空白的方块调色板。 |
| GetBlockPaletteBetweenPos | 服务端 | 根据输入的两个方块位置创建并获取一个方块调色板，方块调色板用于描述和记录世界中的多个方块的组合。这个方块调色板包含了这两个位置之间的所有方块及其相对位置。 |
| GetBlockPaletteBetweenPos | 客户端 | 根据输入的两个位置创建并获取一个方块调色板，该接口会搜索这两个位置之间的所有方块创建方块调色板，方块调色板用于描述和记录世界中的多个方块的组合。这个方块调色板包含了这两个位置之间的所有方块及其相对位置。 |
| GetBlockPaletteFromPosList | 服务端 | 根据输入的方块位置列表创建并获取一个方块调色板，方块调色板用于描述和记录世界中的多个方块的组合。创建的方块调色板包含了这个位置列表中的所有方块及其相对位置。 |
| GetBlockPaletteFromPosList | 客户端 | 根据输入的方块位置列表创建并获取一个方块调色板，方块调色板用于描述和记录世界中的多个方块的组合。创建的方块调色板包含了这个位置列表中的所有方块及其相对位置。 |
| RegisterBlockPatterns | 服务端 | 注册特殊方块组合 |
| SetBlockByBlockPalette | 服务端 | 根据输入的方块调色板内容，将调色板内记录的所有方块设置为实际的方块。 |
# 渲染
| 接口 | 描述 | |
|---|---|---|
| GetAmbientBrightness | 客户端 | 获取环境光亮度，影响天空亮度，不影响实体与方块光照 |
| GetFogColor | 客户端 | 获取当前雾效颜色 |
| GetFogLength | 客户端 | 获取雾效范围 |
| GetMoonRot | 客户端 | 获取月亮角度 |
| GetSkyColor | 客户端 | 获取天空颜色 |
| GetSkyTextures | 客户端 | 获取当前维度天空盒贴图，天空盒共6张贴图 |
| GetStarBrightness | 客户端 | 获取星星亮度 |
| GetSunRot | 客户端 | 获取太阳角度 |
| GetUseAmbientBrightness | 客户端 | 判断是否在mod设置了环境光亮度 |
| GetUseFogColor | 客户端 | 判断当前是否开启设置雾效颜色，该值默认为False，使用mod传入的颜色值后为True |
| GetUseFogLength | 客户端 | 判断当前是否开启设置雾效范围,该值默认为False，使用mod传入的范围值后为True |
| GetUseMoonRot | 客户端 | 判断是否在mod设置了月亮角度 |
| GetUseSkyColor | 客户端 | 判断是否在mod设置了天空颜色 |
| GetUseStarBrightness | 客户端 | 判断是否在mod设置了星星亮度 |
| GetUseSunRot | 客户端 | 判断是否在mod设置了太阳角度 |
| HideNameTag | 客户端 | 隐藏场景内所有名字，包括玩家名字，生物的自定义名称，物品展示框与命令方块的悬浮文本等 |
| IsHideNameTag | 客户端 | 获取是否隐藏场景内所有名字 |
| ResetAmbientBrightness | 客户端 | 重置环境光亮度 |
| ResetFogColor | 客户端 | 重置雾效颜色 |
| ResetFogLength | 客户端 | 重置雾效范围 |
| ResetMoonRot | 客户端 | 重置月亮角度 |
| ResetSkyColor | 客户端 | 重置天空颜色 |
| ResetSkyTextures | 客户端 | 重置当前维度天空盒贴图。如果有使用addon配置贴图则会使用配置的贴图，否则为游戏内默认无贴图的情况 |
| ResetStarBrightness | 客户端 | 重置星星亮度 |
| ResetSunRot | 客户端 | 重置太阳角度 |
| SetAmbientBrightness | 客户端 | 设置环境光亮度，影响天空亮度，不影响实体与方块光照 |
| SetFogColor | 客户端 | 设置雾效颜色 |
| SetFogLength | 客户端 | 设置雾效范围 |
| SetMoonRot | 客户端 | 设置月亮所在角度 |
| SetSkyColor | 客户端 | 设置天空颜色 |
| SetSkyTextures | 客户端 | 设置当前维度天空盒贴图，天空盒需要6张贴图 |
| SetStarBrightness | 客户端 | 设置星星亮度，白天也可以显示星星 |
| SetSunRot | 客户端 | 设置太阳所在角度 |
| SkyTextures | 客户端 | 修改太阳、月亮、云层分布、天空盒的贴图。使用addon配置，非python接口。 |
# 时间
| 接口 | 描述 | |
|---|---|---|
| GetLocalDoDayNightCycle | 服务端 | 获取维度是否打开昼夜更替 |
| GetLocalTime | 服务端 | 获取维度的时间 |
| GetTime | 服务端 | 获取当前世界时间 |
| GetTime | 客户端 | 获取当前世界时间 |
| GetUseLocalTime | 服务端 | 获取某个维度是否设置了使用局部时间规则 |
| SetLocalDoDayNightCycle | 服务端 | 设置使用局部时间规则的维度是否打开昼夜更替 |
| SetLocalTime | 服务端 | 设置使用局部时间规则维度的时间 |
| SetLocalTimeOfDay | 服务端 | 设置使用局部时间规则维度在一天内所在的时间 |
| SetTime | 服务端 | 设置当前世界时间 |
| SetTimeOfDay | 服务端 | 设置当前世界在一天内所在的时间 |
| SetUseLocalTime | 服务端 | 让某个维度拥有自己的局部时间规则，开启后该维度可以拥有与其他维度不同的时间与是否昼夜更替的规则 |
# 天气
| 接口 | 描述 | |
|---|---|---|
| GetDimensionLocalWeatherInfo | 服务端 | 获取独立维度天气信息(必须先使用SetDimensionUseLocalWeather接口设置此维度拥有自己的独立天气) |
| GetDimensionUseLocalWeather | 服务端 | 获取某个维度是否拥有自己的天气规则 |
| IsRaining | 服务端 | 获取是否下雨 |
| IsThunder | 服务端 | 获取是否打雷 |
| SetDimensionLocalDoWeatherCycle | 服务端 | 设置某个维度是否开启天气循环(必须先使用SetDimensionUseLocalWeather接口设置此维度拥有自己的独立天气) |
| SetDimensionLocalRain | 服务端 | 设置某个维度下雨(必须先使用SetDimensionUseLocalWeather接口设置此维度拥有自己的独立天气) |
| SetDimensionLocalThunder | 服务端 | 设置某个维度打雷(必须先使用SetDimensionUseLocalWeather接口设置此维度拥有自己的独立天气) |
| SetDimensionUseLocalWeather | 服务端 | 设置某个维度拥有自己的天气规则，开启后该维度可以拥有与其他维度不同的天气和天气更替的规则 |
| SetRaining | 服务端 | 设置是否下雨 |
| SetThunder | 服务端 | 设置是否打雷 |
# 游戏规则
| 接口 | 描述 | |
|---|---|---|
| AddBannedItem | 服务端 | 增加禁用物品 |
| AddBlockProtectField | Apollo | 设置一个方块无法被玩家/实体破坏的区域 |
| CleanBlockProtectField | Apollo | 取消全部已设置的方块无法被玩家/实体破坏的区域 |
| ClearBannedItems | 服务端 | 清空禁用物品 |
| DisableVineBlockSpread | 服务端 | 设置是否禁用藤曼蔓延生长 |
| ForbidLiquidFlow | 服务端 | 禁止/允许地图中的流体流动 |
| GetBannedItemList | 服务端 | 获取禁用物品列表 |
| GetGameDiffculty | 服务端 | 获取游戏难度 |
| GetGameRulesInfoServer | 服务端 | 获取游戏规则 |
| GetGameType | 服务端 | 获取默认游戏模式 |
| GetLevelGravity | 服务端 | 获取重力因子 |
| GetSeed | 服务端 | 获取存档种子 |
| IsDisableCommandMinecart | 服务端 | 获取当前是否允许运行命令方块矿车内置逻辑指令，当前仅Apollo网络服可用 |
| IsLockDifficulty | 服务端 | 获取当前世界的游戏难度是否被锁定 |
| IsLockGameRulesInfo | 服务端 | 获取当前世界的游戏规则是否被锁定 |
| IsLockGameType | 服务端 | 获取当前世界的游戏类型是否被锁定，包括默认游戏类型和个人游戏类型 |
| LockDifficulty | 服务端 | 锁定当前世界游戏难度（仅本次游戏有效），锁定后任何玩家在游戏内都无法通过指令或暂停菜单修改游戏难度 |
| LockGameRulesInfo | 服务端 | 锁定当前世界游戏规则（仅本次游戏有效），玩家无法通过指令、游戏菜单或api修改游戏规则（包括SetGameRulesInfoServer示例中列举的规则） |
| LockGameType | 服务端 | 锁定当前世界游戏类型（仅本次游戏有效），玩家无法通过指令、游戏菜单或相关api如SetPlayerGameType和SetDefaultGameType修改游戏类型，包括默认游戏类型和个人游戏类型 |
| OpenCityProtect | Apollo | 开启城市保护，包括禁止破坏方块，禁止对方块使用物品，禁止怪物攻击玩家，禁止玩家之间互相攻击，禁止日夜切换，禁止天气变化，禁止怪物群落刷新 |
| RemoveBannedItem | 服务端 | 移除禁用物品 |
| RemoveBlockProtectField | Apollo | 取消一个方块无法被玩家/实体破坏的区域 |
| SetCanActorSetOnFireByLightning | 服务端 | 禁止/允许闪电点燃实体 |
| SetCanBlockSetOnFireByLightning | 服务端 | 禁止/允许闪电点燃方块 |
| SetDefaultGameType | 服务端 | 设置默认游戏模式 |
| SetDisableCommandMinecart | 服务端 | 设置停止/开启运行命令方块矿车内置逻辑指令，当前仅Apollo网络服可用 |
| SetDisableContainers | 服务端 | 禁止所有容器界面的打开，包括玩家背包，各种包含背包界面的容器方块如工作台与箱子，以及包含背包界面的实体交互如马背包与村民交易 |
| SetDisableDropItem | 服务端 | 设置禁止丢弃物品 |
| SetDisableGravityInLiquid | 服务端 | 是否屏蔽所有实体在液体（水、岩浆）中的重力 |
| SetDisableHunger | 服务端 | 设置是否屏蔽饥饿度 |
| SetGameDifficulty | 服务端 | 设置游戏难度 |
| SetGameRulesInfoServer | 服务端 | 设置游戏规则。所有参数均可选。 |
| SetHurtCD | 服务端 | 设置全局受击间隔CD |
| SetLevelGravity | 服务端 | 设置重力因子 |
# 自定义数据
| 接口 | 描述 | |
|---|---|---|
| CleanExtraData | 服务端 | 清除实体的自定义数据或者世界的自定义数据，清除实体数据时使用对应实体id创建组件，清除世界数据时使用levelId创建组件 |
| GetExtraData | 服务端 | 获取实体的自定义数据或者世界的自定义数据，某个键所对应的值。获取实体数据时使用对应实体id创建组件，获取世界数据时使用levelId创建组件 |
| GetWholeExtraData | 服务端 | 获取完整的实体的自定义数据或者世界的自定义数据，获取实体数据时使用对应实体id创建组件，获取世界数据时使用levelId创建组件 |
| SaveExtraData | 服务端 | 用于保存实体的自定义数据或者世界的自定义数据 |
| SetExtraData | 服务端 | 用于设置实体的自定义数据或者世界的自定义数据，数据以键值对的形式保存。设置实体数据时使用对应实体id创建组件，设置世界数据时使用levelId创建组件 |
# 指令
| 接口 | 描述 | |
|---|---|---|
| GetCommandPermissionLevel | 服务端 | 返回设定使用/op命令时OP的权限等级（对应server.properties中的op-permission-level配置） |
| GetDefaultPlayerPermissionLevel | 服务端 | 返回新玩家加入时的权限身份（对应server.properties中的default-player-permission-level配置） |
| SetCommand | 服务端 | 使用游戏内指令 |
| SetCommandPermissionLevel | 服务端 | 设置当玩家使用/op命令时OP的权限等级（对应server.properties中的op-permission-level配置） |
| SetDefaultPlayerPermissionLevel | 服务端 | 设置新玩家加入时的权限身份（对应server.properties中的default-player-permission-level配置） |
# 消息
| 接口 | 描述 | |
|---|---|---|
| NotifyOneMessage | 服务端 | 给指定玩家发送聊天框消息 |
| SendMsg | 服务端 | 模拟玩家给所有人发送聊天栏消息 |
| SendMsgToPlayer | 服务端 | 模拟玩家给另一个玩家发送聊天栏消息 |
| SetLeftCornerNotify | 客户端 | 客户端设置左上角通知信息 |
| SetNotifyMsg | 服务端 | 设置消息通知 |
| SetOnePopupNotice | 服务端 | 在具体某个玩家的物品栏上方弹出popup类型通知，位置位于tip类型消息下方，此功能更建议客户端使用game组件的对应接口SetPopupNotice |
| SetOneTipMessage | 服务端 | 在具体某个玩家的物品栏上方弹出tip类型通知，位置位于popup类型通知上方，此功能更建议在客户端使用game组件的对应接口SetTipMessage |
| SetPopupNotice | 服务端 | 在所有玩家物品栏上方弹出popup类型通知，位置位于tip类型消息下方 |
| SetPopupNotice | 客户端 | 在本地玩家的物品栏上方弹出popup类型通知，位置位于tip类型消息下方 |
| SetPopupState | 客户端 | 设置Popup消息栏状态 |
| SetTipMessage | 服务端 | 在所有玩家物品栏上方弹出tip类型通知，位置位于popup类型通知上方 |
| SetTipMessage | 客户端 | 在本地玩家的物品栏上方弹出tip类型通知，位置位于popup类型通知上方 |
# 记分板
| 接口 | 描述 | |
|---|---|---|
| GetAllPlayerScoreboardObjects | 服务端 | 获取玩家记分项 |
| GetAllPlayerScoreboardObjects | 客户端 | 获取玩家记分项 |
| GetAllScoreboardObjects | 服务端 | 获取所有记分板项 |
| GetAllScoreboardObjects | 客户端 | 获取所有记分板项 |
网易大神
扫码下载网易大神