状态效果 1.21.1

学习如何添加自定义状态效果。

WARNING

本页面适用于 1.21.1 版本。 针对旧版本的文档可能不完整。

状态效果，又称效果，是一种可以影响实体的状况， 可以是正面、负面或中性的。 游戏本体通过许多不同的方式应用这些效果，如食物和药水等等。

命令 /effect 可用来给实体应用效果。

自定义状态效果

在这篇教程中我们将加入一个叫 土豆 的新状态效果，每游戏刻给你 1 点经验。

继承 MobEffect

让我们通过继承所有状态效果的基类 MobEffect 来创建一个自定义状态效果类。

public class TaterEffect extends MobEffect {
	protected TaterEffect() {
		// category: StatusEffectCategory - describes if the effect is helpful (BENEFICIAL), harmful (HARMFUL) or useless (NEUTRAL)
		// color: int - Color is the color assigned to the effect (in RGB)
		super(MobEffectCategory.BENEFICIAL, 0xe9b8b3);
	}

	// Called every tick to check if the effect can be applied or not
	@Override
	public boolean shouldApplyEffectTickThisTick(int duration, int amplifier) {
		// In our case, we just make it return true so that it applies the effect every tick
		return true;
	}

	// Called when the effect is applied.
	@Override
	public boolean applyEffectTick(LivingEntity entity, int amplifier) {
		if (entity instanceof Player) {
			((Player) entity).giveExperiencePoints(1 << amplifier); // Higher amplifier gives you experience faster
		}

		return super.applyEffectTick(entity, amplifier);
	}
}

注册你的自定义状态效果

与注册方块和物品类似，我们使用 Registry.register 将我们的自定义状态效果注册到 MOB_EFFECT 注册表。 这可以在我们的初始化器内完成。

public class ExampleModEffects implements ModInitializer {
	public static final Holder<MobEffect> TATER;

	static {
		TATER = Registry.registerForHolder(BuiltInRegistries.MOB_EFFECT, ResourceLocation.fromNamespaceAndPath("example-mod", "tater"), new TaterEffect());
	}

	@Override
	public void onInitialize() {
		// ...
	}
}

纹理

状态效果的图片是一个 18x18 的 PNG，显示在玩家的背包中。 将你的自定义图标放在：

resources/assets/example-mod/textures/mob_effect/tater.png

下载 示例纹理

翻译

像其它翻译一样，你可以在语言文件中添加一个 ID 格式的条目 "effect.example-mod.<effect-identifier>": "Value"。

{
  "effect.example-mod.tater": "Tater"
}

应用效果

不妨看看你会如何将效果应用到实体。

TIP

For a quick test, it might be a better idea to use the previously mentioned /effect command:

effect give @p example-mod:tater

要在代码内部应用状态效果，需要使用 LivingEntity#addEffect 方法，接收一个 MobEffectInstance 实例，返回布尔值，以表示效果是否成功应用了。

var instance = new MobEffectInstance(ExampleModEffects.TATER, 5 * 20, 0, false, true, true);
entity.addEffect(instance);

参数	类型	描述
effect	Holder<MobEffect>	代表效果的注册表项。
duration	int	效果的时长，单位为刻，而非秒
amplifier	int	效果等级的倍率。 不是与效果的等级直接对应，而是有增加的。 比如，amplifier 为 4 => 等级为 5
ambient	boolean	这个有些棘手， 基本上是指定效果是由环境（比如信标）施加的，没有直接原因。 如果是 true，HUD内的效果图标会以青色覆盖层的形式出现。
particles	boolean	是否显示粒子。
icon	boolean	是否在 HUD 中显示效果的图标。 效果会在物品栏中显示，无论其设置的属性。

INFO

要创建使用此效果的药水，请参阅药水指南。