消耗性化学品

消耗性化学品

一个库模组提供了在玩家体内追踪化学物质的功能。

基础库

注意

你不需要单独下载这个模组,因为依赖它的模组会将它嵌入到模组本身中。本页面主要用于提供教程链接以及查看最新版本。

Consumable Chemicals 是一个库模组,提供向游戏中添加化学物质的功能,并可在玩家身上进行追踪。

附加功能

  • /chemicals 命令,用于设置、获取和更改玩家的化学物质水平

Forge 版本?

没有,我缺乏时间、注意力和动力去学习一个全新的模组加载器

整合包?

完全可以,只要注明我的贡献并链接回本模组的 Modrinth 或 GitHub 页面即可。

使用方法

Gradle 配置

build.gradle

repositories {
    maven { url = "https://pluto-mod-maven.web.app/maven" }
}

dependencies {
    include(modImplementation("ml.pluto7073:chemicals:${minecraft_version}+${chemicals_version}"))
}

gradle.properties

chemicals_version=SEE_MODRINTH_FOR_VERSIONS

创建 ChemicalHandler

创建 Chemical Handler 时,你可以选择通过继承 ConsumableChemicalHandler 从头创建自己的处理器,或者从下面三个预制的抽象处理器中选择一个:

HalfLifeChemicalHandler

化学物质的量会以构造函数中指定的半衰期(以刻为单位)在玩家身上呈指数递减

LinearChemicalHandler

每刻从玩家身上移除特定量的化学物质,直到该量降至零

StaticChemicalHandler

任何被消耗的化学物质都会留在玩家身上,直到达到最大量(如果指定了)或玩家死亡。 可以为达到最大量时定义一个自定义行为

示例

在本示例中,我们将使用 HalfLifeChemicalHandler

假设我们希望化学物质的半衰期为 5 分钟,即 6000 刻。这样我们就得到了下面的代码

public class ExampleHandler extends HalfLifeChemicalHandler {

    public ExampleHandler() {
        super(6000); // 5 minutes * 60 sec/min * 20 ticks/sec
    }

}

如果你使用的是预制的抽象处理器,那么只有一个方法需要实现:getEffectsForAmount()

(如果你继承的是 ConsumableChemicalHandler,那么你还需要实现 tickPlayer(),它应该每刻处理化学物质,大多数情况下是移除少量直到没有剩余)

该方法接收一个表示量的 float 和当前的 Level。它应该返回一个 Mob 效果实例列表(例如 隐身),即具有该化学物质量的玩家应该拥有的效果。

在本示例中,假设我们希望玩家在化学物质超过 10 时获得急迫 I,在超过 50 时获得缓慢 III。

public class ExampleHandler extends HalfLifeChemicalHandler {

    [...]

    @Override
    public Collection<MobEffectInstance> getEffectsForAmount(float amount, Level level) {
        ArrayList<MobEffectInstance> effects = new ArrayList<>();
        if (amount >= 10) {
            effects.add(new MobEffectInstance(MobEffects.DIG_SPEED, 600));
        }
        if (amount >= 50) {
            effects.add(new MobEffectInstance(MobEffects.MOVEMENT_SLOWDOWN, 600, 2));
        }
        return effects;
    }

}

注册 ChemicalHandler

处理器的类创建完成后,需要对其进行注册。

可以使用 Registry.register(Chemicals.REGISTRY, ID, HANDLER) 来完成,并且应该在模组初始化时进行,就像进行其他任何注册一样。

示例

ExampleHandler.java

public class ExampleHandler extends HalfLifeChemicalHandler {

    public static final ExampleHandler INSTANCE = new ExampleHandler();

    [...]

    public static void init() {
        Registry.register(Chemicals.REGISTRY, new ResourceLocation("modid", "example_chemical"), INSTANCE);
    }

}

ExampleMod.java

public class ExampleMod implements ModInitializer {

    @Override
    public void onInitialize() {
        ExampleHandler.init();
    }

}

向食物中添加化学物质

你刚刚已将化学物质添加到游戏中!你可以使用 /chemicals 命令来编辑玩家的化学物质水平以进行测试,但现在你需要一种在游戏内消耗化学物质的方式。最简单的方法是将其添加到 FoodProperties 实例中。FoodProperties 构建器新增了一个方法,用于向食物中添加化学物质。该方法接收一个表示化学物质的 ResourceLocation(或 ChemicalHandler 本身)以及量。

ExampleItems.java

public class ExampleItems {

    public static final FoodProperties CHEMICAL_FOOD = new FoodProperties.Builder()
            .alwaysEat()
            .fast()
            .addChemical(ExampleChemical.INSTANCE, 5f)
            .build();

    public static final Item CHEMICAL_PILL = new Item(new Item.Properties().food(CHEMICAL_FOOD));

    public static void init() {
        Registry.register(BuiltInRegistries.ITEM, new ResourceLocation("modid", "chemical_pill"), CHEMICAL_PILL);
    }

}

ExampleMod.java

public class ExampleMod implements ModInitializer {

    @Override
    public void onInitialize() {
        [...]
        ExampleItems.init(); // Items should be registered after chemicals
    }

}

在 1.20.5+ 中向食物中添加化学物质

在 1.20.5+ 中,食物数据由物品组件管理。现在,化学物质也通过 ChemicalMap.COMPONENT_TYPE 组件添加到物品中,其 ID 为 chemicals:chemicals。

如果你想通过游戏内的简单命令向现有的食物或可饮用物品(如药水)添加化学物质,可以这样做。

/give @s minecraft:cooked_beef[chemicals:chemicals={"modid:example_chemical":100}]

上述命令会给我们一块牛排,其中含有 100 单位的上述示例化学物质,玩家在食用后该化学物质会被添加到玩家身上。

化学药丸示例

如果你希望模组中的自定义物品默认含有一定量的化学物质(类似上面 1.20.4 及更早版本的示例),可以在注册物品时使用 ChemicalMap.COMPONENT_TYPE 组件和 ChemicalMap.Builder。

    public static final FoodProperties CHEMICAL_FOOD = new FoodProperties.Builder()
            .alwaysEat().fast().build(); // Our food data without the chemicals

    public static final Item CHEMICAL_PILL = new Item(new Item.Properties().food(CHEMICAL_FOOD)
            .component(ChemicalMap.COMPONENT_TYPE, new ChemicalMap.Builder().add(EXAMPLE_CHEMICAL, 10).build()));

    public static void init() {
        Registry.register(BuiltInRegistries.ITEM, new ResourceLocation("modid", "chemical_pill"), CHEMICAL_PILL);
    }

本示例会给我们一个默认含有 10 单位示例化学物质的化学药丸物品。

更深入的化学物质物品

如果你有一个可以含有可变数量化学物质的物品(例如使用 NBT 数据),最好在你的 Item 类中实现 ChemicalContaining。它有一个方法 getChemicalContent(),接收化学物质的 ResourceLocation 和 ItemStack。该方法应计算此物品堆中指定化学物质的量并返回。

在本示例中,此物品中的任何化学物质都存储在物品 NBT 的 Chemicals 对象中

ExampleItem.java

public class ExampleItem extends Item implements ChemicalContaining {

    public ExampleItem(Properties properties) {
        super(properties);
    }

    @Override
    public float getChemicalContent(ResourceLocation id, ItemStack stack) {
        CompoundTag chemicals = stack.getOrCreateTagElement("Chemicals");
        if (chemicals.contains(id.toString())) {
            return chemicals.getFloat(id.toString());
        }
        return 0;
    }

}