StructurePlacerAPI

模组

· 作者 Emafire003

一个专为 Fabric 模组开发者设计的 API,用于生成 NBT 结构

0 本站下载 0 关注 更新于 4 天前

最新 2.1.1+26.3+neo · 26.3 · NeoForge

一键开服(送7天)

Structure Placer API

这个简单的 API 提供了一种一次性在世界中生成结构的方法,而不是将其加入世界生成逻辑。它可能适用于创建传送门的物品,或者其他类型的结构。或者用来制作幸运方块,谁知道呢!

设置

将此库作为依赖项包含在你的 build.gradle 中:

repositories {
    maven {
        name = "Modrinth"
        url = "https://api.modrinth.com/maven"
        content {
            includeGroup "maven.modrinth"
        }
    }
}

dependencies {
    modImplementation "maven.modrinth:structureplacerapi:<version>"
}

如果你希望将 API 包含在你的 jar 文件中,只需添加 include 字符串即可:

repositories {
    maven {
        name = "Modrinth"
        url = "https://api.modrinth.com/maven"
        content {
            includeGroup "maven.modrinth"
        }
    }
}

dependencies {
    modImplementation "maven.modrinth:structureplacerapi:<version>"
    include "maven.modrinth:structureplacerapi:<version>"
}

它的大小不到 25 kb!

使用方法

如何创建结构?

你必须使用 Minecraft 的结构方块创建一个 NBT 结构,如本视频所示:

我得到的文件应该放在哪里?

你需要将 structure.nbt 文件放入你模组的 data 文件夹中,路径如下:data/yourmodid/structures

创建新的放置器对象

为了放置结构,你需要先创建一个放置器对象,这可以通过简单地创建一个新的 StructurePlacerAPI 对象来完成。它有几个参数可供调整:

StructurePlacerAPI(ServerWorld world, Identifier templateName, BlockPos blockPos, BlockMirror mirror, BlockRotation rotation, boolean ignoreEntities, float integrity, BlockPos offset)

参数说明

  • 第一个参数 world 是我们将在其中放置结构的世界。你可以从实体或其他地方获取它。
  • 第二个参数 templateName 是一个由你的模组 ID 和结构名称组成的 Identifier。
  • 第三个参数 blockPos 是你的结构将要生成的区块坐标。例如,你可以从实体坐标获取它。
  • 第四个参数 mirror 是可选参数之一。使用此类,你可以使用 BlockMirror 类来镜像你的结构。无需创建另一个对象,直接输入 BlockMirror.#stuff 即可。
  • 第五个参数 rotation 与前一个类似,你将能够使用 BlockRotation 类旋转你的结构。无需创建另一个对象,直接输入 BlockMirror.#stuff 即可。(注:原文此处笔误仍写为 BlockMirror,实际应指 BlockRotation)
  • ignoreEntities 参数如果设置为 true,则不会生成结构文件内包含的实体。如果设置为 false,则会生成它们。
  • integrity 参数非常有趣,因为它是一个介于 0f 和 1f 之间的浮点值,用于决定结构的破败程度。如果设置为低于 1f 的值,在生成时将移除部分方块。
  • 最后,offset 参数是另一个 BlockPos,可用于重新定位结构,例如放置在实体脚下或类似位置。

放置结构

你已经创建了 StructurePlacerAPI placer = new StructurePlacerAPI(things up there),要生成它,你需要执行以下操作:

placer.loadStructure();

是的,好吧,这并不难。你只需要运行那个方法,而不是直接调用 .place 方法,因为 load 方法在生成之前会检查该结构是否存在。

一段时间后恢复旧地形

从版本 1.1.0 开始,你还可以使用:

placer.loadAndRestoreStructure(int restore_ticks);

来提供经过一定刻数(1 秒 = 20 刻)后恢复旧地形的时间。 注意:这可能会导致性能问题,特别是当结构非常大时!(它需要保存结构内的每个方块!)

你还可以通过使用以下代码为方块重新出现添加动画效果:

placer.loadAndRestoreStructureAnimated(int restore_ticks, int blocks_per_tick, boolean random);
  • blocks_per_ticks 是每个刻替换的方块数量,所以如果你的结构由 200 个方块组成,且 blocks_per_ticks 设置为 1,那么它将花费 1 秒放置 20 个方块,并花费 20 秒完成地形恢复。
  • random 指的是方块替换的顺序。设置为 true 时,每次再生的方块都是随机的,否则它将从结构的一个角移动到另一个角。在我看来,random = true 更酷。

选择哪些方块应该被替换(从 2.0.0 版本开始)

你现在可以指定放置的结构是否可以替换基岩和屏障,或者具有特定标签的方块,或者是否只能替换具有特定标签的方块。 在你创建了 StructurePlacerAPI placer 对象后,你可以使用这些方法:

/** 设置此结构是否应该替换基岩 */
placer.setReplaceBedrock(boolean replaceBedrock)
    
/** 设置此结构是否应该替换屏障方块 */
placer.setReplaceBarrier(boolean replaceBarrier)

/** 设置此结构是否仅替换具有所提供标签的方块,例如仅替换空气方块 */
placer.setOnlyReplaceTaggedBlocks(boolean onlyReplaceTaggedBlocks, TagKey<Block> tag)

/** 允许指定如果具有提供的标签则不会被替换的方块 */
placer.setPreventReplacementOfTaggedBlocks(boolean preventReplacementOfTaggedBlocks, TagKey<Block> tag)

在结构放置或替换特定方块时执行操作 (2.0.0+)

现在,您可以选择在结构内的方块被放置到世界中,或者在放置结构时替换方块时执行函数。

例如,如果您希望在放置包含浆果丛的结构时随机生成一只狐狸,可以使用:

placer.actionOnBlocksPlacedByStructure(ActionOnBlockFind action, TagKey<Block> targets);

//示例:
placer.actionOnBlocksPlacedByStructure((info, world) -> {world.spawnEntity(EntityType.FoxEntity, ...)}, BlockTags.BUSHES);

该动作是一个 lambda 函数,为您提供 StructureBlockInfo 和 ServerWorldAccess(或在 mojmaps 中对应的 ServerLevelAccess 等)。您需要指定一个标签来定义要替换的方块类型。如果仅涉及单一方块类型,请为该方块创建一个标签。

您还可以在已存在于世界中的方块被结构替换时执行某些操作。 例如,当冰方块被替换时生成雪粒子效果:

placer.actionOnBlocksReplacedByStructure(ActionOnBlockFind action, TagKey<Block> targets);

//示例:
placer.actionOnBlocksReplacedByStructure((info, world) -> {world.spawnParticles(ParticleType.SNOW, ...)}, BlockTags.ICE);

示例

您可以在 LightWithin 模组中找到此类示例(顺便一提,建议您查看一下):

StructurePlacer placer = new StructurePlacer((ServerWorld) caster.getWorld(), new Identifier(MOD_ID, "frost_light"), caster.getBlockPos(), BlockMirror.NONE, BlockRotation.CLOCKWISE_90, true, 1.0f, new BlockPos(-4, -3, -3));
placer.loadStructure();

用于创建永久性结构:

StructurePlacer placer = new StructurePlacer((ServerWorld) caster.getWorld(), new Identifier(MOD_ID, "frost_light"), caster.getBlockPos(), BlockMirror.NONE, BlockRotation.CLOCKWISE_90, true, 1.0f, new BlockPos(-4, -3, -3));
placer.loadAndRestoreStructureAnimated(200, 2, true);

通过每秒替换两个方块并以随机顺序进行,使旧地形再生。

警告!

重要提示!请确保您处于服务器线程上!

if(!world.isClient){
//运行相关代码
}

支持我

如果您想请我喝杯咖啡,请点击下方链接。

或者,您可以通过使用下方的优惠码购买服务器来获得我的支持,您和朋友可享受 25% 的折扣。

许可证

本 API 采用 CC0 许可协议发布。欢迎学习并应用于您的项目中。

你是这个资源的作者?登录后可认领此资源。

评论 0

0.0
暂无评分
5 星
0
4 星
0
3 星
0
2 星
0
1 星
0
我的评分

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源